Skip to content

Handle code guarded by 'if TYPE_CHECKING' correctly #530

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

Closed
wants to merge 17 commits into from
Closed

Handle code guarded by 'if TYPE_CHECKING' correctly #530

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
44aab70
Omit code guarded by 'if TYPE_CHECKING'
PetterS Apr 15, 2020
d66aeb8
Make the Binding parameter a constructor and use it for all bindings.
PetterS Apr 15, 2020
3b60143
Remove constructor arg.
PetterS Apr 16, 2020
a6f0dd2
Another solution.
PetterS Apr 16, 2020
b938b2b
Revert "Another solution."
PetterS Apr 16, 2020
3474adf
Add during_type_checking to __init__ and set it during construction.
PetterS Apr 19, 2020
b8e687a
Fix Python 2.7
PetterS Apr 19, 2020
a30cfcb
Snake case.
PetterS Apr 19, 2020
7306c2b
Rename to for_annotations
PetterS Apr 19, 2020
12fd45a
Flake8
PetterS Apr 19, 2020
aeaf0b6
Add a test for type comments as well.
PetterS Apr 19, 2020
f5657ba
Merge branch 'master' into omit_type_checking
PetterS Apr 27, 2020
a993d91
Fix: elif and else branches should not be affected.
PetterS Apr 27, 2020
7eb8484
Merge branch 'master' into omit_type_checking
PetterS May 13, 2020
a9d4a7f
Merge branch 'master' into omit_type_checking
PetterS Mar 25, 2021
558914b
Review
PetterS Mar 26, 2021
cbe214a
Move the check for _in_annotation
PetterS Mar 26, 2021
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
18 changes: 14 additions & 4 deletions pyflakes/checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,6 @@ def __init__(self, name, source):
self.name = name
self.source = source
self.used = False
self.during_type_checking = False

def __str__(self):
return self.name
Expand Down Expand Up @@ -588,6 +587,17 @@ def _add_to_names(container):

class Scope(dict):
importStarred = False # set to True when import * is found
# Special key for checking whether a binding is defined only for type checking.
TYPE_CHECKING_ONLY = object()

def __init__(self):
super(Scope, self).__init__(self)
self[self.TYPE_CHECKING_ONLY] = collections.defaultdict(bool)

def items(self):
for key, val in super(Scope, self).items():
if key != self.TYPE_CHECKING_ONLY:
yield key, val

def __repr__(self):
scope_cls = self.__class__.__name__
Expand Down Expand Up @@ -1074,8 +1084,6 @@ def addBinding(self, node, value):
break
existing = scope.get(value.name)

value.during_type_checking = self._in_type_checking

if (existing and not isinstance(existing, Builtin) and
not self.differentForks(node, existing.source)):

Expand Down Expand Up @@ -1103,6 +1111,7 @@ def addBinding(self, node, value):
# then assume the rebound name is used as a global or within a loop
value.used = self.scope[value.name].used

self.scope[Scope.TYPE_CHECKING_ONLY][value.name] = self._in_type_checking
self.scope[value.name] = value

def _unknown_handler(self, node):
Expand Down Expand Up @@ -1169,7 +1178,8 @@ def handleNodeLoad(self, node):
scope[n.fullName].used = (self.scope, node)
except KeyError:
pass
if n.during_type_checking and not self._in_annotation:
if (self.scope[Scope.TYPE_CHECKING_ONLY][name]
and not self._in_annotation):
# Only defined during type-checking; this does not count. Real code
# (not an annotation) using this binding will not work.
continue
Expand Down