[pyflakes] Treat if TYPE_CHECKING blocks like stub files for F821
#11262
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
AlexWaygood
changed the title
pyflakes] Treat if TYPE_CHECKING` blocks like stub files for F821pyflakes] Treat if TYPE_CHECKING blocks like stub files for F821
|
Type definitions created in |
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| UP007 | 27 | 27 | 0 | 0 | 0 |
| UP006 | 20 | 20 | 0 | 0 | 0 |
Linter (preview)
ℹ️ ecosystem check detected linter changes. (+47 -0 violations, +0 -0 fixes in 7 projects; 37 projects unchanged)
apache/airflow (+28 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
+ airflow/executors/base_executor.py:53:19: UP006 Use `list` instead of `List` for type annotation + airflow/executors/base_executor.py:59:30: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/executors/base_executor.py:59:54: UP007 Use `X | Y` for type annotations + airflow/executors/base_executor.py:63:28: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/executors/base_executor.py:63:34: UP007 Use `X | Y` for type annotations + airflow/executors/base_executor.py:66:17: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/executors/base_executor.py:66:53: UP007 Use `X | Y` for type annotations + airflow/executors/base_executor.py:66:68: UP007 Use `X | Y` for type annotations + airflow/executors/local_executor.py:56:24: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/executors/local_executor.py:56:30: UP007 Use `X | Y` for type annotations + airflow/executors/local_executor.py:56:57: UP007 Use `X | Y` for type annotations + airflow/models/mappedoperator.py:90:39: UP007 Use `X | Y` for type annotations + airflow/models/mappedoperator.py:90:76: UP006 Use `list` instead of `List` for type annotation + airflow/providers/celery/executors/celery_executor.py:98:28: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/providers/celery/executors/celery_executor.py:98:64: UP007 Use `X | Y` for type annotations + airflow/providers/celery/executors/celery_executor_utils.py:62:28: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/providers/celery/executors/celery_executor_utils.py:62:64: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:28:25: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:28:66: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:31:29: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:31:52: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:31:61: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:34:27: UP006 Use `tuple` instead of `Tuple` for type annotation + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:34:43: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:34:52: UP007 Use `X | Y` for type annotations + airflow/providers/cncf/kubernetes/executors/kubernetes_executor_types.py:34:84: UP006 Use `dict` instead of `Dict` for type annotation + airflow/providers/microsoft/azure/hooks/cosmos.py:47:24: UP007 Use `X | Y` for type annotations ... 1 additional changes omitted for rule UP007 + airflow/providers/microsoft/azure/hooks/cosmos.py:47:35: UP006 Use `list` instead of `List` for type annotation
bokeh/bokeh (+8 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
+ src/bokeh/core/has_props.py:98:25: UP007 Use `X | Y` for type annotations + src/bokeh/document/events.py:122:26: UP007 Use `X | Y` for type annotations + src/bokeh/models/sources.py:87:37: UP007 Use `X | Y` for type annotations + src/bokeh/models/sources.py:89:24: UP007 Use `X | Y` for type annotations + src/bokeh/models/sources.py:89:48: UP007 Use `X | Y` for type annotations + src/bokeh/plotting/contour.py:42:31: UP007 Use `X | Y` for type annotations + src/bokeh/plotting/contour.py:43:40: UP007 Use `X | Y` for type annotations + src/bokeh/transform.py:71:26: UP007 Use `X | Y` for type annotations
latchbio/latch (+2 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ latch/ldata/_transfer/upload.py:31:39: UP007 Use `X | Y` for type annotations + latch/ldata/_transfer/upload.py:32:42: UP007 Use `X | Y` for type annotations
pypa/cibuildwheel (+1 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ cibuildwheel/typing.py:19:17: UP007 Use `X | Y` for type annotations
python/mypy (+1 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ mypyc/build.py:58:32: UP007 Use `X | Y` for type annotations
python-poetry/poetry (+6 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ src/poetry/repositories/link_sources/base.py:26:17: UP006 Use `collections.defaultdict` instead of `DefaultDict` for type annotation + src/poetry/repositories/link_sources/base.py:26:45: UP006 Use `collections.defaultdict` instead of `DefaultDict` for type annotation + src/poetry/repositories/link_sources/base.py:26:66: UP006 Use `list` instead of `List` for type annotation + tests/inspection/test_lazy_wheel.py:31:25: UP006 Use `tuple` instead of `Tuple` for type annotation + tests/inspection/test_lazy_wheel.py:31:36: UP006 Use `dict` instead of `Dict` for type annotation + tests/inspection/test_lazy_wheel.py:33:33: UP006 Use `dict` instead of `Dict` for type annotation
scikit-build/scikit-build-core (+1 -0 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
+ src/scikit_build_core/_compat/importlib/metadata.py:20:23: UP006 Use `list` instead of `typing.List` for type annotation
Changes by rule (2 rules affected)
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| UP007 | 27 | 27 | 0 | 0 | 0 |
| UP006 | 20 | 20 | 0 | 0 | 0 |
AlexWaygood
force-pushed
the
type-checking-f821
branch
from
ce0917a to
ff0b9c3
Compare
AlexWaygood
force-pushed
the
type-checking-f821
branch
from
ff0b9c3 to
b0f7fa0
Compare
AlexWaygood
force-pushed
the
type-checking-f821
branch
from
1f54c6e to
c9dfe3b
Compare
AlexWaygood
commented
May 5, 2024
Comment on lines
+2065
to
+2068
| if self.semantic.in_annotation() | ||
| && (self.semantic.in_typing_only_context() | ||
| || self.semantic.future_annotations()) | ||
| { |
There was a problem hiding this comment.
I think honestly PYI020 is a better fit for stub files and if TYPE_CHECKING blocks, so the logic here should probably be changed. But for now I'm just maintaining compatibility with previous versions of Ruff, which emitted this lint on annotations in stub files as well as annotations in .py files. Abruptly reducing the scope of the rule like that would maybe be slightly backwards-incompatible; it at least should be considered in a separate PR.
Skylion007
reviewed
May 11, 2024
| @@ -42,3 +42,7 @@ class MyClass: | |||
| baz: MyClass | |||
| eggs = baz # valid in a `.pyi` stub file, not in a `.py` runtime file | |||
| eggs = "baz" # always okay | |||
|
|
|||
| if TYPE_CHECKING: | |||
There was a problem hiding this comment.
Can we a test for if there is code in an else block after the TYPE_CHECKING? That shouldn't be treated a stub, right?
There was a problem hiding this comment.
Sure, I can add a test for that.
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
Fixes #11245.
if TYPE_CHECKINGblocks, like stub files, are never executed at runtime -- so I think it makes sense to give them stub-file semantics when it comes to whether forward references are or aren't permitted. Currently we allow forward references in stub files on the r.h.s. of type alias definitions and in class bases; this PR implements the same logic forif TYPE_CHECKINGblocks.Test Plan
cargo test/cargo insta review. Two fixtures have been extended.