forked from dagster-io/dagster
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyproject.toml
273 lines (205 loc) · 8.18 KB
/
pyproject.toml
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# ########################
# ##### PYRIGHT
# ########################
# [Docs root]
# https://github.com/microsoft/pyright/tree/main/docs
# [Config option reference]
# https://github.com/microsoft/pyright/blob/main/docs/configuration.md
# Pyright does not have a docs site, but the documentation (a collection of
# markdown files in the GH repo, linked above) is pretty thorough.
[tool.pyright]
include = [
".buildkite/dagster-buildkite",
"docs/dagster-ui-screenshot",
"docs/sphinx/_ext/dagster-sphinx",
"python_modules",
"examples",
"integration_tests",
"scripts",
]
# Unfortunately pyright does not offer a way to extend the default exclusions, so we have to
# reiterate them here if we want to add anything else.
exclude = [
"**/node_modules",
"**/__pycache__",
"**/__generated__",
"**/vendor",
"**/.tox",
".git",
"**/.venv*",
"**/build",
]
# These two settings point pyright to a python environment to resolve imports against. This virtual
# environment is defined in the `pyright` tox environment in the tox section below-- that
# environment must be built before pyright can run correctly.
venv = ".venv"
venvPath = "pyright/master"
# Set to false to help us during the transition from mypy to pyright. Mypy does
# not analyze unannotated functions by default, and so as of 2023-02 the codebase contains a large
# number of type errors in unannotated functions. Eventually we can turn off this setting.
analyzeUnannotatedFunctions = false
# Minimum version of Python on which code must run. This determines the standard library stubs used by
# pyright.
pythonVersion = "3.8"
# Use "basic" ruleset. This differs from strict in several ways, but most
# importantly it does not flag untyped code as an error.
typeCheckingMode = "basic"
# Disable reading type annotations from libraries that are not explicitly marked as typed (i.e. that
# include a py.typed file). All imports from these libraries are given the `Unknown` type (i.e.
# `Any`). This setting does not affect `py.typed` libraries.
useLibraryCodeForTypes = false
# We use ruff for this.
reportInvalidStringEscapeSequence = false
# As of 2023-02-02, there are still many `py.typed` libs that are not compliant with the standards
# for defining a public API.
reportPrivateImportUsage = false
# Since we only use pyright, there is no need to suppress type errors that pyright does not
# recognize.
reportUnnecessaryTypeIgnoreComment = "warning"
# ########################
# ##### PYTEST
# ########################
[tool.pytest.ini_options]
filterwarnings = [
"ignore::dagster.ExperimentalWarning",
"ignore::DeprecationWarning",
"ignore::UserWarning",
"ignore::pytest.PytestCollectionWarning",
]
# ########################
# ##### RUFF
# ########################
# [Docs root]
# https://beta.ruff.rs/docs/
# [Config option reference]
# https://beta.ruff.rs/docs/configuration/
#
# As of 2022-12-05, the entire documentation of Ruff is in its very long
# README.
[tool.ruff]
target-version = "py38"
extend-exclude = [
"*/__generated__/*",
"*/dagster_airflow/vendor/*",
"*/snapshots/*",
]
# Codebase-wide default line length. Override in package-specific pyproject.toml where a different
# length is desired.
line-length = 100
# Fail if Ruff is not running this version.
required-version = "0.3.4"
[tool.ruff.lint]
ignore = [
# (missing public docstrings) These work off of the Python sense of "public", rather than our
# bespoke definition based off of `@public`. When ruff supports custom plugins then we can write
# appropriate rules to require docstrings for `@public`.
"D100",
"D101",
"D102",
"D103",
"D104",
"D105",
"D106",
"D107",
# (docstring imperative mood) Overly restrictive.
"D401",
# (module level import not at top) There are several places where we use e.g.
# warnings.filterwarings calls before imports.
"E402",
# (line too long): This fires for comments, which the ruff formatter won't auto-wrap. Disabling
# until there is an autoformat solution available for comments.
"E501",
# (no type comparison): There are a few places where we use `== type(None)` which are more clear
# than the equivalent `isinstance` check.
'E721',
# (bare exception): There are many places where we want to catch a maximally generic exception.
'E722',
# (no assign lambda): existing code assigns lambdas in a few places. With ruff formatting
# requiring extra empty lines between defs, disallowing lambda assignment can make code less
# readable.
"E731",
# (try-except-in-loop) we use this pattern in many places and the performance impact is negligible
"PERF203",
# (no concatenation) Existing codebase has many concatentations, no reason to disallow them.
"RUF005",
# (use ClassVar for attr declarations with defaults) This is a good rule for vanilla Python, but
# triggers false positives for many libs that have DSLs that make use of attr defaults.
"RUF012",
##### TEMPORARY DISABLES
# (assorted docstring rules) There are too many violations of these to enable
# right now, but we should enable after fixing the violations.
"D200", # (one-line docstring should fit)
"D205", # (blank line after summary)
"D417", # (missing arg in docstring)
# (assorted perf rules) We have a lot of violations, enable when autofix is available
"PERF401", # (manual-list-comprehension)
"PERF402", # (manual-list-copy)
]
# By default, ruff only uses all "E" (pycodestyle) and "F" (pyflakes) rules.
# Here we append to the defaults.
select = [
# (flake8-builtins) detect shadowing of python builtin symbols by variables and arguments.
# Attributes are OK (which is why A003) is not included here.
"A001",
"A002",
# (useless expression): Expressions that aren't assigned to anything are typically bugs.
"B018",
# (static key dict comprehension): Flag reuse of a key in dict comprehensions.
"B035",
# (pydocstyle) Docstring-related rules. A large subset of these are ignored by the
# "convention=google" setting, we set under tool.ruff.pydocstyle.
"D",
# (pycodestyle) pycodestyle rules
"E",
# (pyflakes) pyflakes rules
"F",
# (isort) detect improperly sorted imports
"I001",
# (performance) perflint rules
"PERF",
# (pylint) use all pylint rules from categories "Convention", "Error", and "Warning" (ruff
# currently implements only a subset of pylint's rules)
"PLE",
"PLW",
# (no commented out code) keep commented out code blocks out of the codebase
# "ERA001",
# (ruff-specific) Enable all ruff-specific checks (i.e. not ports of
# functionality from an existing linter).
"RUF",
# (private member access) Flag access to `_`-prefixed symbols. By default the various special
# methods on `NamedTuple` are ignored (e.g. `_replace`).
"SLF001",
# (flake8-type-checking) Auto-sort imports into TYPE_CHECKING blocks depending on whether
# they are runtime or type-only imports.
"TCH",
# (banned-api) Flag use of banned APIs. See tool.ruff.flake8-tidy-imports.banned-api for details.
"TID251",
# (disallow print statements) keep debugging statements out of the codebase
"T20",
# (f-strings) use f-strings instead of .format()
"UP032",
# (invalid escape sequence) flag errant backslashes
"W605",
]
[tool.ruff.lint.flake8-builtins]
# We use `id` in many places and almost never want to use the python builtin.
builtins-ignorelist = ["id"]
[tool.ruff.lint.flake8-tidy-imports.banned-api]
"__future__.annotations".msg = "Directly quote annotations instead."
[tool.ruff.lint.isort]
# Combine multiple `from foo import bar as baz` statements with the same source
# (`foo`) into a single statement.
combine-as-imports = true
# Imports of the form `from foo import bar as baz` show one `import bar as baz`
# per line. Useful for __init__.py files that just re-export symbols.
force-wrap-aliases = true
[tool.ruff.lint.per-file-ignores]
# Don't format docstrings in alembic migrations.
"**/alembic/versions/*.py" = ["D"]
[tool.ruff.lint.pydocstyle]
# Enforce google-style docstrings. This is equivalent to ignoring a large number of pydocstyle (D)
# rules incompatible with google-style docstrings. See:
# https://google.github.io/styleguide/pyguide.html#383-functions-and-methods
convention = "google"
[tool.dagster]
module_name = "dagster_test.toys.repo"