derivepassphrase.git

1) [build-system]
2) requires = ["hatchling"]
3) build-backend = "hatchling.build"
4) 
5) [project]
6) name = "derivepassphrase"
7) description = "An almost faithful Python reimplementation of James Coglan's vault."
8) readme = "README.md"

9) requires-python = ">= 3.9"

10) license = { text = "zlib/libpng" }

11) keywords = []
12) authors = [

13)   { name = "Marco Ricci", email = "software@the13thletter.info" },

14) ]
15) classifiers = [
16)   "Development Status :: 4 - Beta",
17)   "Environment :: Console",

18)   "License :: OSI Approved :: zlib/libpng License",

19)   "Programming Language :: Python :: 3",

20)   "Programming Language :: Python :: 3.9",

21)   "Programming Language :: Python :: 3.10",

22)   "Programming Language :: Python :: 3.11",
23)   "Programming Language :: Python :: 3.12",

24)   "Programming Language :: Python :: 3.13",

25)   "Programming Language :: Python :: Implementation :: CPython",
26)   "Programming Language :: Python :: Implementation :: PyPy",
27) ]
28) dependencies = [

29)   # We use click for the command-line interface.  We require version 8.1.0
30)   # or higher due to click issue #1985.
31)   "click >= 8.1",
32)   # We include type annotations, and use facilities that are not readily
33)   # available in older Pythons (such as typing.Self).  These are loaded from
34)   # typing_extensions, instead of using explicit version guards.

35)   "typing_extensions",

36)   # We read configuration files in JSON and TOML format.  The latter is
37)   # unavailable in the Python standard library until Python 3.11.
38)   'tomli; python_version < "3.11"'

39) ]

40) dynamic = ['version']

41) 
42) [project.optional-dependencies]

43) dev = [
44)   # Development uses the hatch build system, to isolate all tools in their
45)   # own virtual environment.
46)   "hatch ~= 1.10",
47) ]

48) export = [
49)   # The vault configuration exporter relies on cryptography.  Version 38 was
50)   # the first to include the `algorithms.AES256` interface, instead of only
51)   # the `algorithms.AES` interface.
52)   "cryptography >= 38.0.0",
53) ]

54) 

55) [project.scripts]
56) derivepassphrase = "derivepassphrase.cli:derivepassphrase"
57) 

58) [project.urls]

59) Documentation = "https://the13thletter.info/derivepassphrase/"

60) Issues = "https://github.com/the-13th-letter/derivepassphrase/issues"
61) Source = "https://github.com/the-13th-letter/derivepassphrase"
62) 

63) [tool.coverage.html]
64) directory = "html/coverage"

65) 

66) [tool.coverage.paths]
67) src = ["src"]
68) tests = ["tests"]

69) 

70) [tool.coverage.report]
71) skip_covered = false
72) skip_empty = true
73) precision = 3
74) partial_branches = [
75)     'pragma: no branch',
76) ]
77) exclude_also = [
78)   "if __name__ == .__main__.:",
79)   'if (?:typing\.)?TYPE_CHECKING:',
80)   "raise AssertionError",
81)   "raise NotImplementedError",
82)   'assert False',

83)   '(?:typing\.)?assert_never\(',

84)   '@overload',

85) ]

86) 

87) [tool.coverage.run]
88) source_pkgs = ["derivepassphrase", "tests"]
89) branch = true
90) parallel = true
91) omit = [
92)   "__main__.py",
93) ]

94) dynamic_context = 'test_function'

95) 

96) [tool.hatch.build.targets.sdist]
97) exclude = [

98)     'docs/changelog.d/*.md',

99) ]
100) 
101) [tool.hatch.build.targets.wheel]

102) packages = ['src/derivepassphrase']

103) 

104) [tool.hatch.env]
105) requires = [
106)   "hatch-mkdocs",
107) ]
108) 
109) [tool.hatch.env.collectors.mkdocs.docs]
110) path = "mkdocs.yml"
111) 

112) [tool.hatch.envs.docs]
113) extra-dependencies = [

114)   # Our documentation uses formatted function signatures (i.e. with
115)   # formatted type annotations), which requires `black`.

116)   "black",

117)   # Our changelog is assembled from singular entries, orchestrated by
118)   # `scriv`.
119)   "scriv >= 1.4"

120) ]
121) detached = false
122) 

123) [tool.hatch.envs.hatch-static-analysis]

124) config-path = "/dev/null"

125) dependencies = [

126)   "ruff ~= 0.6.0",

127) ]

128) 
129) [tool.hatch.envs.hatch-test]
130) default-args = ['src', 'tests']

131) extra-dependencies = [
132)     "hypothesis >= 6.0",
133) ]
134) matrix-name-format = '{variable}_{value}'

135) 
136) [[tool.hatch.envs.hatch-test.matrix]]

137) python = ["3.13", "3.12", "3.11", "3.10", "3.9", "pypy3.10", "pypy3.9"]

138) cryptography = ["no", "yes"]
139) hypothesis-profile = ["user-default"]

140) parser-version = ["PEG"]
141) 
142) [[tool.hatch.envs.hatch-test.matrix]]
143) python = ["3.9", "pypy3.9"]
144) cryptography = ["no", "yes"]
145) hypothesis-profile = ["user-default"]
146) parser-version = ["LL1"]

147) 

148) [[tool.hatch.envs.hatch-test.matrix]]

149) cryptography = ["yes"]
150) hypothesis-profile = ["ci"]

151) 
152) [tool.hatch.envs.hatch-test.overrides]

153) matrix.cryptography.features = [
154)     { value = "export", if = ["yes"] },

155) ]

156) matrix.hypothesis-profile.env-vars = [
157)     { key = "HYPOTHESIS_PROFILE", if = ["ci", "default", "dev", "debug"] },
158) ]

159) matrix.parser-version.env-vars = [
160)     { key = "PYTHONOLDPARSER", value = "1", if = ["LL1"] },
161) ]

162) 
163) [tool.hatch.envs.hatch-test.scripts]
164) run = "pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
165) run-cov = "coverage run -m pytest --hypothesis-profile={env:HYPOTHESIS_PROFILE:default}{env:HATCH_TEST_ARGS:} {args}"
166) cov-combine = "coverage combine"
167) cov-report = "coverage report"

168) 

169) [tool.hatch.envs.types]
170) extra-dependencies = [

171)   "hypothesis >= 6.0",

172)   "mypy ~= 1.0",

173)   "pytest ~= 8.1",

174) ]

175) features = [
176)     "export",
177) ]
178) 

179) [tool.hatch.envs.types.scripts]
180) check = "mypy --install-types --non-interactive {args:src/derivepassphrase tests}"
181) 

182) [tool.hatch.version]
183) path = "src/derivepassphrase/__init__.py"

184) 

185) [tool.mypy]
186) files = ['src/**/*.py', 'tests/**/*.py']
187) mypy_path = '$MYPY_CONFIG_FILE_DIR/src'
188) explicit_package_bases = true
189) implicit_reexport = false
190) sqlite_cache = true

191) enable_error_code = ['ignore-without-code']

192) 

193) [tool.pytest.ini_options]
194) addopts = '--doctest-modules'
195) pythonpath = ['src']
196) testpaths = ['src', 'tests']
197) xfail_strict = true

198) 
199) [tool.ruff]
200) line-length = 79
201) src = ["src"]
202) 
203) [tool.ruff.format]

204) docstring-code-format = true

205) docstring-code-line-length = "dynamic"

206) preview = true

207) quote-style = 'single'

208) 
209) [tool.ruff.lint]

210) ignore = [
211)     # Suggested ignore by ruff when also using ruff to format.  We *do*

212)     # check for E501, because this usually only happens when there is
213)     # a text string that should be manually broken.
214)     'W191', 'E111', 'E114', 'E117', 'D206', 'D300', 'Q000', 'Q001',
215)     'Q002', 'Q003', 'COM812', 'COM819', 'ISC001', 'ISC002',

216)     # We use `assert` regularly to appease the type checker, and because
217)     # it is the right language tool for this job.

218)     'S101',

219)     # The formatter takes care of trailing commas and docstring code
220)     # automatically.
221)     'COM812', 'W505',

222)     # We document transitive exceptions as well (if we feel they would
223)     # be surprising to the user otherwise).

224)     'DOC502',

225)     # We currently don't have issues for every TODO.  Forcing an issue
226)     # also goes against the philosophy of TODOs as low-overhead markers
227)     # for future work; see

228)     # https://gist.github.com/dmnd/ed5d8ef8de2e4cfea174bd5dafcda382 .
229)     'TD003',

230)     # We somewhat regularly use loops where each iteration needs
231)     # a separate try-except block.

232)     'PERF203',

233)     # We do not currently use pathlib.  The PTH rules are unselected,
234)     # but FURB includes several pathlib-related rules.
235)     'FURB101', 'FURB103',

236)     # We catch type-ignore comments without specific code via the mypy
237)     # configuration, not via ruff.
238)     'PGH003',

239) ]

240) preview = true
241) # We select here in the order of presentation on the ruff documentation
242) # website.  ruff default selection (v0.6.2) is merely E4, E7, E9 and F.
243) select = [
244)     'F', 'E', 'W', 'C90', 'I', 'N', 'D', 'UP', 'YTT',
245)     'ANN', 'ASYNC', 'S', 'BLE', 'FBT', 'B', 'A', 'COM',
246)     'CPY', 'C4', 'DTZ', 'T10', 'DJ', 'EM', 'EXE', 'FA',
247)     'ISC', 'ICN', 'LOG', 'G', 'INP', 'PIE', 'T20', 'PYI',
248)     'PT', 'Q', 'RET', 'SLF', 'SLOT', 'SIM', 'TID', 'TCH',
249)     'INT', 'ARG',
250)     # We currently do not use pathlib. Disable 'PTH'.
251)     'TD',

252)     # We use TODOs and FIXMEs as notes for later, and don't want the
253)     # linter to nag about every occurrence.  Disable 'FIX'.

254)     #

255)     # The "eradicate" rule is prone to a lot of false positives, and it
256)     # is unclear to me, and probably confusing to read, where to apply
257)     # a noqa marker.  Instead, disable 'ERA', and if necessary, specify
258)     # it on the command-line.

259)     'PD', 'PGH', 'PL', 'TRY', 'FLY', 'NPY', 'FAST',
260)     'AIR', 'PERF', 'FURB', 'DOC', 'RUF',

261) ]

262) 

263) [tool.ruff.lint.per-file-ignores]
264) "**/scripts/*" = [
265)   # Suggested by hatch.
266)   'INP',
267)   # Suggested by hatch.
268)   'T20',
269) ]

270) "**/tests/**/*" = [

271)   # Suggested by hatch, assumingly because it may be important to verify
272)   # that the value is exactly the empty string, and not just any falsy
273)   # value.
274)   'PLC1901',
275)   # Suggested by hatch, assumingly because tests may use "magic values".
276)   'PLR2004',

277)   # Suggested by hatch, because tests are typically organized as classes
278)   # and instance methods but may not really be using the `self`
279)   # argument.

280)   'PLR6301',
281)   # Suggested by hatch, because these warnings may be precisely what the
282)   # tests are supposed to test.
283)   'S',
284)   # Suggested by hatch, because pytest-style tests conventionally import
285)   # code from each other via relative imports.
286)   'TID252',
287)   # Our tests regularly use arguments named `input` to store an input
288)   # (text-/byte-)string.

289)   'A002',

290)   # We regularly annotate pytest fixtures like monkeypatch as `Any`.
291)   'ANN401',
292)   # Our tests generally don't contain docstrings.
293)   'D', 'DOC',

294)   # Our tests are regularly parametrized with booleans, for benign
295)   # purposes.

296)   'FBT',

297)   # One of our standard modules is called `derivepassphrase._types`.
298)   # Importing this from the tests directory would then automatically
299)   # trigger `PLC2701`.

300)   'PLC2701',

301)   # Too many public methods/arguments/returns/branches/locals doesn't
302)   # really apply here.

303)   'PLR0904', 'PLR0911', 'PLR0912', 'PLR0913', 'PLR0914', 'PLR0915',
304)   'PLR0916', 'PLR0917',

305)   # To fully test the `derivepassphrase.cli` module (and a couple other
306)   # things), we need to call and to mock several internal functions,
307)   # which would automatically trigger `SLF001`.

308)   'SLF001',

309)   # pytest does not support sensible introspection of `assert all(...)`
310)   # expressions in tests the same way it supports introspection in
311)   # `asssert all([...])`.  So the extra list comprehension actually
312)   # improves debuggability in this case.
313)   'C419',
314)   # The tests sometimes include long strings (in non-Python formats)
315)   # that should be included verbatim, without artificial line breaking,
316)   # so they can be grepped for.
317)   'E501',

318) ]
319) 

320) [tool.ruff.lint.flake8-copyright]
321) # Include hatch-enforced SPDX-FileCopyrightText in check.
322) notice-rgx = '(?i)(?:Copyright\s+((?:\(C\)|©)\s+)?|SPDX-FileCopyrightText:\s+)\d{4}((-|,\s)\d{4})*'

323) 

324) [tool.ruff.lint.flake8-pytest-style]

325) fixture-parentheses = false
326) mark-parentheses = false

327) parametrize-names-type = 'list'

328) 

329) [tool.ruff.lint.flake8-tidy-imports]
330) ban-relative-imports = "all"
331) 
332) [tool.ruff.lint.isort]
333) known-first-party = ["derivepassphrase"]
334) 
335) [tool.ruff.lint.pycodestyle]
336) ignore-overlong-task-comments = true  # for E501
337) max-doc-length = 72  # for W505
338) 

339) [tool.ruff.lint.pydocstyle]
340) convention = 'google'

341)