Skip to content

Make undefined-variable flag type annotation without value assignment #5158

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.

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
merged 3 commits into from
Oct 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ Release date: TBA
* Added support for ``ModuleNotFoundError`` (``import-error`` and ``no-name-in-module``).
``ModuleNotFoundError`` inherits from ``ImportError`` and was added in Python ``3.6``

* ``undefined-variable`` now correctly flags variables which only receive a type annotations
and never get assigned a value

Closes #5140

* Improve and flatten ``unused-wildcard-import`` message

Closes #3859
Expand Down
5 changes: 5 additions & 0 deletions doc/whatsnew/2.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,8 @@ Other Changes
* In length checker, ``len-as-condition`` has been renamed as
``use-implicit-booleaness-not-len`` in order to be consistent with
``use-implicit-booleaness-not-comparison``.

* ``undefined-variable`` now correctly flags variables which only receive a type annotations
and never get assigned a value

Closes #5140
18 changes: 18 additions & 0 deletions pylint/checkers/variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -1186,6 +1186,8 @@ def visit_name(self, node: nodes.Name) -> None:
)
elif current_consumer.scope_type == "lambda":
self.add_message("undefined-variable", node=node, args=name)
elif self._is_only_type_assignment(node, name, defstmt):
self.add_message("undefined-variable", node=node, args=name)

current_consumer.mark_as_consumed(name, found_nodes)
# check it's not a loop variable used outside the loop
Expand Down Expand Up @@ -1548,6 +1550,22 @@ def _is_variable_violation(

return maybee0601, annotation_return, use_outer_definition

@staticmethod
def _is_only_type_assignment(
node: nodes.Name, name: str, defstmt: nodes.Statement
) -> bool:
"""Check if variable only gets assigned a type and never a value"""
if not isinstance(defstmt, nodes.AnnAssign) or defstmt.value:
return False
for ref_node in node.scope().locals[name][1:]:
if ref_node.lineno < node.lineno:
if not (
isinstance(ref_node.parent, nodes.AnnAssign)
and ref_node.parent.value
):
return False
return True

def _ignore_class_scope(self, node):
"""
Return True if the node is in a local class scope, as an assignment.
Expand Down
34 changes: 34 additions & 0 deletions tests/functional/u/undefined/undefined_variable.py
Original file line number Diff line number Diff line change
Expand Up @@ -338,3 +338,37 @@ def decorated4(x):
else:
from types import GenericAlias
object().__class_getitem__ = classmethod(GenericAlias)

# Tests for annotation of variables and potentially undefinition

def value_and_type_assignment():
"""The variable assigned a value and type"""
variable: int = 2
print(variable)


def only_type_assignment():
"""The variable never gets assigned a value"""
variable: int
print(variable) # [undefined-variable]


def both_type_and_value_assignment():
"""The variable first gets a type and subsequently a value"""
variable: int
variable = 1
print(variable)


def value_assignment_after_access():
"""The variable gets a value after it has been accessed"""
variable: int
print(variable) # [undefined-variable]
variable = 1


def value_assignment_from_iterator():
"""The variables gets a value from an iterator"""
variable: int
for variable in (1, 2):
print(variable)
66 changes: 34 additions & 32 deletions tests/functional/u/undefined/undefined_variable.txt
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
undefined-variable:11:19::Undefined variable 'unknown'
undefined-variable:17:10:in_method:Undefined variable 'nomoreknown'
undefined-variable:20:19::Undefined variable '__revision__'
undefined-variable:22:8::Undefined variable '__revision__'
undefined-variable:26:29:bad_default:Undefined variable 'unknown2'
undefined-variable:29:10:bad_default:Undefined variable 'xxxx'
undefined-variable:30:4:bad_default:Undefined variable 'augvar'
undefined-variable:31:8:bad_default:Undefined variable 'vardel'
undefined-variable:33:19:<lambda>:Undefined variable 'doesnotexist'
undefined-variable:34:23:<lambda>:Undefined variable 'z'
used-before-assignment:42:4::Using variable 'POUETT' before assignment
used-before-assignment:55:4::Using variable 'PLOUF' before assignment
used-before-assignment:64:11:if_branch_test:Using variable 'xxx' before assignment
used-before-assignment:90:23:test_arguments:Using variable 'TestClass' before assignment
used-before-assignment:94:16:TestClass:Using variable 'Ancestor' before assignment
used-before-assignment:97:26:TestClass.MissingAncestor:Using variable 'Ancestor1' before assignment
used-before-assignment:104:36:TestClass.test1.UsingBeforeDefinition:Using variable 'Empty' before assignment
undefined-variable:118:10:Self:Undefined variable 'Self'
undefined-variable:134:7::Undefined variable 'BAT'
used-before-assignment:145:31:KeywordArgument.test1:Using variable 'enabled' before assignment
undefined-variable:148:32:KeywordArgument.test2:Undefined variable 'disabled'
undefined-variable:153:22:KeywordArgument.<lambda>:Undefined variable 'arg'
undefined-variable:165:4::Undefined variable 'unicode_2'
undefined-variable:170:4::Undefined variable 'unicode_3'
undefined-variable:225:25:LambdaClass4.<lambda>:Undefined variable 'LambdaClass4'
undefined-variable:233:25:LambdaClass5.<lambda>:Undefined variable 'LambdaClass5'
used-before-assignment:254:26:func_should_fail:Using variable 'datetime' before assignment
undefined-variable:281:18:not_using_loop_variable_accordingly:Undefined variable 'iteree'
undefined-variable:292:27:undefined_annotation:Undefined variable 'x'
used-before-assignment:293:7:undefined_annotation:Using variable 'x' before assignment
undefined-variable:323:11:decorated3:Undefined variable 'x'
undefined-variable:328:19:decorated4:Undefined variable 'y'
undefined-variable:11:19::Undefined variable 'unknown':HIGH
undefined-variable:17:10:in_method:Undefined variable 'nomoreknown':HIGH
undefined-variable:20:19::Undefined variable '__revision__':HIGH
undefined-variable:22:8::Undefined variable '__revision__':HIGH
undefined-variable:26:29:bad_default:Undefined variable 'unknown2':HIGH
undefined-variable:29:10:bad_default:Undefined variable 'xxxx':HIGH
undefined-variable:30:4:bad_default:Undefined variable 'augvar':HIGH
undefined-variable:31:8:bad_default:Undefined variable 'vardel':HIGH
undefined-variable:33:19:<lambda>:Undefined variable 'doesnotexist':HIGH
undefined-variable:34:23:<lambda>:Undefined variable 'z':HIGH
used-before-assignment:42:4::Using variable 'POUETT' before assignment:HIGH
used-before-assignment:55:4::Using variable 'PLOUF' before assignment:HIGH
used-before-assignment:64:11:if_branch_test:Using variable 'xxx' before assignment:HIGH
used-before-assignment:90:23:test_arguments:Using variable 'TestClass' before assignment:HIGH
used-before-assignment:94:16:TestClass:Using variable 'Ancestor' before assignment:HIGH
used-before-assignment:97:26:TestClass.MissingAncestor:Using variable 'Ancestor1' before assignment:HIGH
used-before-assignment:104:36:TestClass.test1.UsingBeforeDefinition:Using variable 'Empty' before assignment:HIGH
undefined-variable:118:10:Self:Undefined variable 'Self':HIGH
undefined-variable:134:7::Undefined variable 'BAT':HIGH
used-before-assignment:145:31:KeywordArgument.test1:Using variable 'enabled' before assignment:HIGH
undefined-variable:148:32:KeywordArgument.test2:Undefined variable 'disabled':HIGH
undefined-variable:153:22:KeywordArgument.<lambda>:Undefined variable 'arg':HIGH
undefined-variable:165:4::Undefined variable 'unicode_2':HIGH
undefined-variable:170:4::Undefined variable 'unicode_3':HIGH
undefined-variable:225:25:LambdaClass4.<lambda>:Undefined variable 'LambdaClass4':HIGH
undefined-variable:233:25:LambdaClass5.<lambda>:Undefined variable 'LambdaClass5':HIGH
used-before-assignment:254:26:func_should_fail:Using variable 'datetime' before assignment:HIGH
undefined-variable:281:18:not_using_loop_variable_accordingly:Undefined variable 'iteree':HIGH
undefined-variable:292:27:undefined_annotation:Undefined variable 'x':HIGH
used-before-assignment:293:7:undefined_annotation:Using variable 'x' before assignment:HIGH
undefined-variable:323:11:decorated3:Undefined variable 'x':HIGH
undefined-variable:328:19:decorated4:Undefined variable 'y':HIGH
undefined-variable:353:10:only_type_assignment:Undefined variable 'variable':HIGH
undefined-variable:366:10:value_assignment_after_access:Undefined variable 'variable':HIGH