Skip to content

Fix class-const naming style #4279

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 1 commit into from
Apr 1, 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
8 changes: 7 additions & 1 deletion ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Release date: Undefined

* Fix issue with PEP 585 syntax and the use of ``collections.abc.Set``

* Fix issue that caused class variables annotated with ``typing.ClassVar`` to be
identified as class constants. Now, class variables annotated with
``typing.Final`` are identified as such.

Closes #4277


What's New in Pylint 2.7.4?
===========================
Expand All @@ -31,7 +37,7 @@ Release date: 2021-03-30

* Fix issue with annotated class constants

* Closes #4264
Closes #4264


What's New in Pylint 2.7.3?
Expand Down
2 changes: 1 addition & 1 deletion pylint/checkers/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1994,7 +1994,7 @@ def visit_assignname(self, node):
if (
ancestor.name == "Enum"
and ancestor.root().name == "enum"
or utils.is_class_var(node)
or utils.is_assign_name_annotated_with(node, "Final")
):
self._check_name("class_const", node.name, node)
break
Expand Down
12 changes: 8 additions & 4 deletions pylint/checkers/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -1459,18 +1459,22 @@ def is_attribute_typed_annotation(
return False


def is_class_var(node: astroid.AssignName) -> bool:
"""Test if node has `ClassVar` annotation."""
def is_assign_name_annotated_with(node: astroid.AssignName, typing_name: str) -> bool:
"""Test if AssignName node has `typing_name` annotation.

Especially useful to check for `typing._SpecialForm` instances
like: `Union`, `Optional`, `Literal`, `ClassVar`, `Final`.
"""
if not isinstance(node.parent, astroid.AnnAssign):
return False
annotation = node.parent.annotation
if isinstance(annotation, astroid.Subscript):
annotation = annotation.value
if (
isinstance(annotation, astroid.Name)
and annotation.name == "ClassVar"
and annotation.name == typing_name
or isinstance(annotation, astroid.Attribute)
and annotation.attrname == "ClassVar"
and annotation.attrname == typing_name
):
return True
return False
13 changes: 13 additions & 0 deletions tests/functional/n/name/name_final.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# pylint: disable=missing-docstring,too-few-public-methods
"""Test typing.Final"""
import typing
from typing import Final

class Foo:
"""Class with class constants annotated with Final."""
CLASS_CONST: Final[int] = 42
CLASS_CONST2: Final = "const"
variable: Final[str] = "invalid name" # [invalid-name]
CLASS_CONST3: typing.Final
variable2: typing.Final[int] # [invalid-name]
CLASS_CONST4: Final[typing.ClassVar[str]] = "valid"
2 changes: 2 additions & 0 deletions tests/functional/n/name/name_final.rc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[testoptions]
min_pyver=3.8
2 changes: 2 additions & 0 deletions tests/functional/n/name/name_final.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
invalid-name:10:4:Foo:"Class constant name ""variable"" doesn't conform to UPPER_CASE naming style"
invalid-name:12:4:Foo:"Class constant name ""variable2"" doesn't conform to UPPER_CASE naming style"
13 changes: 13 additions & 0 deletions tests/functional/n/name/name_final_snake_case.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# pylint: disable=missing-docstring,too-few-public-methods
"""Test typing.Final with name style snake_case."""
import typing
from typing import Final

class Foo:
"""Class with class constants annotated with Final."""
CLASS_CONST: Final[int] = 42 # [invalid-name]
CLASS_CONST2: Final = "const" # [invalid-name]
variable: Final[str] = "invalid name"
CLASS_CONST3: typing.Final # [invalid-name]
variable2: typing.Final[int]
CLASS_CONST4: Final[typing.ClassVar[str]] = "invalid name" # [invalid-name]
5 changes: 5 additions & 0 deletions tests/functional/n/name/name_final_snake_case.rc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[testoptions]
min_pyver=3.8

[BASIC]
class-const-naming-style=snake_case
4 changes: 4 additions & 0 deletions tests/functional/n/name/name_final_snake_case.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
invalid-name:8:4:Foo:"Class constant name ""CLASS_CONST"" doesn't conform to snake_case naming style"
invalid-name:9:4:Foo:"Class constant name ""CLASS_CONST2"" doesn't conform to snake_case naming style"
invalid-name:11:4:Foo:"Class constant name ""CLASS_CONST3"" doesn't conform to snake_case naming style"
invalid-name:13:4:Foo:"Class constant name ""CLASS_CONST4"" doesn't conform to snake_case naming style"
4 changes: 2 additions & 2 deletions tests/functional/n/name/name_styles.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,6 @@ class Bar:
"""Class with class constants annotated with ClassVar."""
CLASS_CONST: ClassVar[int] = 42
CLASS_CONST2: ClassVar = "const"
variable: ClassVar[str] = "invalid name" # [invalid-name]
variable: ClassVar[str] = "invalid name"
CLASS_CONST3: typing.ClassVar
variable2: typing.ClassVar[int] # [invalid-name]
variable2: typing.ClassVar[int]
2 changes: 0 additions & 2 deletions tests/functional/n/name/name_styles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,3 @@ invalid-name:110:4:FooClass.PROPERTY_NAME:"Attribute name ""PROPERTY_NAME"" does
invalid-name:115:4:FooClass.ABSTRACT_PROPERTY_NAME:"Attribute name ""ABSTRACT_PROPERTY_NAME"" doesn't conform to snake_case naming style":INFERENCE
invalid-name:120:4:FooClass.PROPERTY_NAME_SETTER:"Attribute name ""PROPERTY_NAME_SETTER"" doesn't conform to snake_case naming style":INFERENCE
invalid-name:151:4:FooEnum:"Class constant name ""bad_enum_name"" doesn't conform to UPPER_CASE naming style"
invalid-name:157:4:Bar:"Class constant name ""variable"" doesn't conform to UPPER_CASE naming style"
invalid-name:159:4:Bar:"Class constant name ""variable2"" doesn't conform to UPPER_CASE naming style"