Flag mutable defaults based on mutable annotations #11122
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
charliermarsh
force-pushed
the
charlie/b006
branch
from
3c4b88a to
0068bc6
Compare
charliermarsh
force-pushed
the
charlie/b006
branch
from
0068bc6 to
ed030d0
Compare
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| B006 | 34 | 34 | 0 | 0 | 0 |
Linter (preview)
ℹ️ ecosystem check detected linter changes. (+34 -0 violations, +0 -0 fixes in 4 projects; 40 projects unchanged)
commaai/openpilot (+2 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ tools/lib/live_logreader.py:10:46: B006 Do not use mutable data structures for argument defaults + tools/lib/live_logreader.py:27:42: B006 Do not use mutable data structures for argument defaults
pandas-dev/pandas (+1 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ pandas/io/formats/css.py:351:76: B006 Do not use mutable data structures for argument defaults
reflex-dev/reflex (+3 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ reflex/app.py:418:38: B006 Do not use mutable data structures for argument defaults + reflex/app.py:571:38: B006 Do not use mutable data structures for argument defaults + reflex/utils/prerequisites.py:361:33: B006 Do not use mutable data structures for argument defaults
tiangolo/fastapi (+28 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ docs_src/dependencies/tutorial001.py:15:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependencies/tutorial001.py:20:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependencies/tutorial001_py310.py:11:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependencies/tutorial001_py310.py:16:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependency_testing/tutorial001.py:16:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependency_testing/tutorial001.py:21:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependency_testing/tutorial001_py310.py:12:38: B006 Do not use mutable data structures for argument defaults + docs_src/dependency_testing/tutorial001_py310.py:17:38: B006 Do not use mutable data structures for argument defaults + docs_src/query_params_str_validations/tutorial012_py39.py:7:37: B006 Do not use mutable data structures for argument defaults + docs_src/query_params_str_validations/tutorial013.py:7:32: B006 Do not use mutable data structures for argument defaults + docs_src/request_files/tutorial002_py39.py:8:45: B006 Do not use mutable data structures for argument defaults + docs_src/request_files/tutorial003_py39.py:16:31: B006 Do not use mutable data structures for argument defaults + docs_src/request_files/tutorial003_py39.py:9:26: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:125:39: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:130:45: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:137:66: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:183:38: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:188:44: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:196:43: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:74:35: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_contextmanager.py:82:35: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_normal_exceptions.py:30:50: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_normal_exceptions.py:37:59: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_overrides.py:18:40: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_overrides.py:28:42: B006 Do not use mutable data structures for argument defaults + tests/test_dependency_overrides.py:50:53: B006 Do not use mutable data structures for argument defaults + tests/test_forms_from_non_typing_sequences.py:13:38: B006 Do not use mutable data structures for argument defaults + tests/test_forms_from_non_typing_sequences.py:8:40: B006 Do not use mutable data structures for argument defaults
Changes by rule (1 rules affected)
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| B006 | 34 | 34 | 0 | 0 | 0 |
|
Just gonna mark as draft since I haven’t had a chance to review the ecosystem results and I’m going to bed. |
|
I haven't looked at the code nor the ecosystem checks, but I think my suggestion was to use the ruff/crates/ruff_python_semantic/src/analyze/typing.rs Lines 421 to 427 in f5c7a62 But, I think this could be fine as well. |
charliermarsh
commented
Apr 24, 2024
| checker.semantic(), | ||
| extend_immutable_calls.as_slice(), | ||
| ) | ||
| })) |
There was a problem hiding this comment.
(At the very least I think these should return enums rather than bools, with a single call to check immutability.)
|
The ecosystem checks look good to me, except the FastAPI ones which are... hard to comment on. I'm not sure if they can use this rule? I'd gate this with preview. |
|
(I think we generally recommend adding |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
We'll now flag
def foo(a: list = LIST): ...as a mutable default based on the annotation. (If it is immutable, the annotation should beSequence.)I want to see what the ecosystem checks look like here. It might be too noisy.
Closes #11030.