Repository navigation
Expand file tree
/
Copy pathpyproject.toml
More file actions
235 lines (213 loc) · 6.14 KB
/
Copy pathpyproject.toml
File metadata and controls
235 lines (213 loc) · 6.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
[build-system]
requires = ["pdm-backend"]
build-backend = "pdm.backend"
[project]
name = "typer"
license = "MIT"
license-files = ["LICENSE"]
dynamic = ["version"]
description = "Typer, build great CLIs. Easy to code. Based on Python type hints."
authors = [
{name = "Sebastián Ramírez", email = "tiangolo@gmail.com"},
]
requires-python = ">=3.10"
classifiers = [
"Intended Audience :: Information Technology",
"Intended Audience :: System Administrators",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python",
"Topic :: Software Development :: Libraries :: Application Frameworks",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Software Development :: Libraries",
"Topic :: Software Development",
"Typing :: Typed",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Programming Language :: Python :: 3.15",
]
dependencies = [
"pydantic >=2.5.3",
"shellingham >=1.3.0",
"rich >=13.8.0",
"annotated-doc >=0.0.2",
"colorama; platform_system == 'Windows'",
]
readme = "README.md"
[project.urls]
Homepage = "https://github.com/fastapi/typer"
Documentation = "https://typer.tiangolo.com"
Repository = "https://github.com/fastapi/typer"
Issues = "https://github.com/fastapi/typer/issues"
Changelog = "https://typer.tiangolo.com/release-notes/"
[project.scripts]
typer = "typer.cli:main"
[dependency-groups]
dev = [
{ include-group = "tests" },
{ include-group = "docs" },
"prek >=0.3.2",
"zizmor >=1.23.1",
]
docs = [
"cairosvg >=2.8.2",
"griffe-typingdoc >=0.3.0",
"griffe-warnings-deprecated >=1.1.0",
"markdown-include-variants >=0.0.10",
"mdx-include >=1.4.1",
"mkdocstrings[python] >=1.0.3",
"pillow >=11.3.0",
"pyyaml >=5.3.1",
"zensical>=0.0.42",
]
github-actions = [
"httpx >=0.27.0",
"pydantic >=2.5.3",
"pydantic-settings >=2.1.0",
"pygithub >=2.3.0",
"smokeshow >=0.5.0",
]
tests = [
"coverage[toml] >=7.13",
"mypy >=1.19.1",
"ty >=0.0.25",
"pytest >=9.0.0",
"pytest-cov >=7.0.0",
"pytest-sugar >=1.0.0",
"pytest-xdist >=3.6.1",
"rich >=12.3.0",
"ruff >=0.16.0",
"shellingham >=1.3.0",
]
[tool.pdm]
version = { source = "file", path = "typer/__init__.py" }
distribution = true
[tool.pdm.build]
source-includes = [
"tests/",
"docs_src/",
"scripts/",
]
[tool.pytest]
minversion = "9.0"
addopts = [
"--strict-config",
"--strict-markers",
]
strict_xfail = true
filterwarnings = [
"error",
# For pytest-xdist
'ignore::DeprecationWarning:xdist',
]
[tool.coverage.run]
parallel = true
data_file = "coverage/.coverage"
source = [
"docs_src",
"tests",
"typer"
]
omit = [
"typer/_typing.py",
]
context = '${CONTEXT}'
relative_files = true
[tool.coverage.report]
exclude_lines = [
"pragma: no cover",
"@overload",
'if __name__ == "__main__":',
"if TYPE_CHECKING:",
]
[tool.mypy]
strict = true
[[tool.mypy.overrides]]
module = "docs_src.*"
disallow_incomplete_defs = false
disallow_untyped_defs = false
disallow_untyped_calls = false
[[tool.mypy.overrides]]
module = "shellingham"
ignore_missing_imports = true
[tool.ruff.lint]
select = [
"E", # pycodestyle errors
"W", # pycodestyle warnings
"F", # pyflakes
"I", # isort
"B", # flake8-bugbear
"C4", # flake8-comprehensions
"UP", # pyupgrade
"TID", # flake8-tidy-imports
]
ignore = [
"E501", # line too long, handled by black
"B008", # do not perform function calls in argument defaults
"C901", # too complex
"TID252", # relative imports okay
]
[tool.ruff.lint.per-file-ignores]
# "__init__.py" = ["F401"]
# rich_utils is allowed to use rich imports
"typer/rich_utils.py" = ["TID251"]
# adapters is allowed to import pydantic at module level
"typer/_adapters.py" = ["TID253"]
# This file is more readable without yield from
"docs_src/progressbar/tutorial004.py" = ["UP028", "B007"]
# Default mutable data structure
"docs_src/options_autocompletion/tutorial006.py" = ["B006"]
"docs_src/multiple_values/multiple_options/tutorial002.py" = ["B006"]
"docs_src/options_autocompletion/tutorial007.py" = ["B006"]
"docs_src/options_autocompletion/tutorial008.py" = ["B006"]
"docs_src/options_autocompletion/tutorial009.py" = ["B006"]
"docs_src/parameter_types/enum/tutorial003.py" = ["B006"]
# Loop control variable `value` not used within loop body
"docs_src/progressbar/tutorial001.py" = ["B007"]
"docs_src/progressbar/tutorial003.py" = ["B007"]
"docs_src/progressbar/tutorial005.py" = ["B007"]
"docs_src/progressbar/tutorial006.py" = ["B007"]
# Local variable `delete` is assigned to but never used
"docs_src/prompt/tutorial003.py" = ["F841"]
# No need to worry about lazy imports in docs or scripts
"docs_src/*" = ["TID"]
"scripts/*" = ["TID253"]
[tool.ruff.lint.isort]
known-third-party = ["typer"]
# For docs_src/subcommands/tutorial003/
known-first-party = ["reigns", "towns", "lands", "items", "users"]
[tool.ruff.lint.pyupgrade]
# Preserve types, even if a file imports `from __future__ import annotations`.
keep-runtime-typing = true
[tool.ruff.lint.flake8-tidy-imports]
# Import these from within functions (lazy), not at the module level (TID253)
banned-module-level-imports = ["typer.rich_utils", "typer._adapters", "pydantic"]
[tool.ruff.lint.flake8-tidy-imports.banned-api]
"rich".msg = "Use 'typer.rich_utils' instead of importing from 'rich' directly."
"shellingham.detect_shell".msg = """\
Use 'typer._completion_shared._get_shell_name' instead of using \
'shellingham.detect_shell' directly.
"""
[tool.ty.terminal]
error-on-warning = true
[tool.typos.files]
extend-exclude = [
"coverage/",
"dist/",
"docs/img/",
"docs/release-notes.md",
"htmlcov/",
"site/",
"site_build/",
"uv.lock",
]
[tool.typos.default.extend-identifiers]
alls = "alls"
[tool.typos.default.extend-words]
Ines = "Ines"