Skip to content

[pyflakes] Avoid false positives in @no_type_check contexts (F821, F722) #14615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaReiser merged 13 commits into from
Nov 26, 2024
Merged

[pyflakes] Avoid false positives in @no_type_check contexts (F821, F722) #14615

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9aa4913
add test case from #13824
ntBre Nov 26, 2024
3c5ceab
skip visit_type_definition in a @no_type_check context
ntBre Nov 26, 2024
1b3ae36
add docs to new flag
ntBre Nov 26, 2024
530ddd2
use contains instead of manual check
ntBre Nov 26, 2024
10b2cac
switch to snapshot test
ntBre Nov 26, 2024
3fac5c5
Revert "add test case from #13824"
ntBre Nov 26, 2024
01f29a7
add failing tests for classes where no_type_check is also valid
ntBre Nov 26, 2024
06c1655
move no_type_check check into visit_decorator
ntBre Nov 26, 2024
b367082
add and use SemanticModel::in_no_type_check
ntBre Nov 26, 2024
615b4b8
ensure no_type_check propagates into function bodies
ntBre Nov 26, 2024
a60b747
make sure typing.no_type_check works too
ntBre Nov 26, 2024
350f6e3
use `match_typing_expr`
ntBre Nov 26, 2024
1d5ee64
ignore `@no_type_check` for classes
ntBre Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move no_type_check check into visit_decorator
  • Loading branch information
@ntBre
ntBre committed Nov 26, 2024
commit 06c1655c8f7ff9eab3895f65d92b6f39389918de
18 changes: 11 additions & 7 deletions crates/ruff_linter/src/checkers/ast/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,13 +723,6 @@ impl<'a> Visitor<'a> for Checker<'a> {
// Visit the decorators and arguments, but avoid the body, which will be
// deferred.
for decorator in decorator_list {
if decorator
.expression
.as_name_expr()
.is_some_and(|name| name.id.as_str() == "no_type_check")
{
self.semantic.flags |= SemanticModelFlags::NO_TYPE_CHECK;
}
self.visit_decorator(decorator);
}

Expand Down Expand Up @@ -1067,6 +1060,17 @@ impl<'a> Visitor<'a> for Checker<'a> {
self.semantic.flags = flags_snapshot;
}

fn visit_decorator(&mut self, decorator: &'a ruff_python_ast::Decorator) {
if decorator
.expression
.as_name_expr()
.is_some_and(|name| name.id.as_str() == "no_type_check")
Copy link
Copy Markdown
Member

@charliermarsh charliermarsh Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should use match_typing_expr so that it works for @typing.no_type_check too.

Copy link
Copy Markdown
Member

@charliermarsh charliermarsh Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, will this apply to type annotations in the body of the function? And should it, per the spec? (I don't know off-hand.)

Copy link
Copy Markdown
Contributor Author

@ntBre ntBre Nov 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah thanks, I missed match_typing_expr.

Yes, this should apply to annotations in the body too, based on my reading of the no_type_check docs:

This works as a class or function decorator. With a class, it applies recursively to all methods and classes defined in that class (but not to methods defined in its superclasses or subclasses). Type checkers will ignore all annotations in a function or class with this decorator.

Similarly in the typing docs linked in what Micha linked:

If a type checker supports the no_type_check decorator for functions, it should suppress all type errors for the def statement and its body including any nested functions or classes. It should also ignore all parameter and return type annotations and treat the function as if it were unannotated.

I added annotated variables to the test fixtures in my last commit to check this.

{
self.semantic.flags |= SemanticModelFlags::NO_TYPE_CHECK;
}
visitor::walk_decorator(self, decorator);
}

fn visit_expr(&mut self, expr: &'a Expr) {
// Step 0: Pre-processing
if self.source_type.is_stub()
Expand Down