REFINE VARIABLE NAMING AND CHECK LOGIC IN FLAKE8 PLUGIN

- Rename loop variables for clarity across multiple files
- Improve Protocol inheritance detection in final class check
- Update violation description for COP011 to be more precise
- Remove unused import and inline constant in function verb check
- Adjust temp var check to handle AnnAssign nodes
- Add 'cache' to verb prefixes whitelist
- Delete redundant test file for COP011 logic

Author: vrslev

src/community_of_python_flake8_plugin/checks/final_class.py

@@ -2,7 +2,6 @@
 import ast
 import typing
 
-from community_of_python_flake8_plugin.constants import FINAL_CLASS_EXCLUDED_BASES
 from community_of_python_flake8_plugin.utils import check_inherits_from_bases
 from community_of_python_flake8_plugin.violation_codes import ViolationCodes
 from community_of_python_flake8_plugin.violations import Violation
@@ -27,13 +26,18 @@ def is_protocol_class(class_node: ast.ClassDef) -> bool:
         # Check for attributed Protocol reference: class MyClass(typing.Protocol):
         if isinstance(one_base, ast.Attribute) and one_base.attr == "Protocol":
             return True
+        # Check for subscripted Protocol reference: class MyClass(Protocol[SomeType]):
+        if isinstance(one_base, ast.Subscript):
+            if isinstance(one_base.value, ast.Name) and one_base.value.id == "Protocol":
+                return True
+            if isinstance(one_base.value, ast.Attribute) and one_base.value.attr == "Protocol":
+                return True
     return False
 
 
 def is_model_factory_class(class_node: ast.ClassDef) -> bool:
     """Check if the class inherits from ModelFactory or SQLAlchemyFactory."""
-    model_factory_bases: typing.Final = {"ModelFactory", "SQLAlchemyFactory"}
-    return check_inherits_from_bases(class_node, model_factory_bases)
+    return check_inherits_from_bases(class_node, {"ModelFactory", "SQLAlchemyFactory"})
 
 
 @typing.final
@@ -47,11 +51,7 @@ def visit_ClassDef(self, ast_node: ast.ClassDef) -> None:
 
     def _check_final_decorator(self, ast_node: ast.ClassDef) -> None:
         # Skip Protocol classes, test classes, and ModelFactory classes
-        if (
-            is_protocol_class(ast_node) 
-            or ast_node.name.startswith("Test")
-            or is_model_factory_class(ast_node)
-        ):
+        if is_protocol_class(ast_node) or ast_node.name.startswith("Test") or is_model_factory_class(ast_node):
             return
 
         if not contains_final_decorator(ast_node):

src/community_of_python_flake8_plugin/checks/function_verb.py

@@ -17,13 +17,15 @@ def check_is_ignored_name(identifier: str) -> bool:
 
 
 def check_is_verb_name(identifier: str) -> bool:
-    return any(identifier == verb_name or identifier.startswith(f"{verb_name}_") for verb_name in VERB_PREFIXES)
+    return any(
+        identifier == one_verb_name or identifier.startswith(f"{one_verb_name}_") for one_verb_name in VERB_PREFIXES
+    )
 
 
 def check_is_property(function_node: ast.AST) -> bool:
     if not isinstance(function_node, (ast.FunctionDef, ast.AsyncFunctionDef)):
         return False
-    return any(check_is_property_decorator(decorator) for decorator in function_node.decorator_list)  # noqa: COP011
+    return any(check_is_property_decorator(one_decorator) for one_decorator in function_node.decorator_list)  # noqa: COP011
 
 
 def check_is_property_decorator(decorator: ast.expr) -> bool:  # noqa: PLR0911
@@ -56,7 +58,7 @@ def check_is_property_decorator(decorator: ast.expr) -> bool:  # noqa: PLR0911
 def check_is_pytest_fixture(function_node: ast.AST) -> bool:
     if not isinstance(function_node, (ast.FunctionDef, ast.AsyncFunctionDef)):
         return False
-    return any(check_is_fixture_decorator(decorator) for decorator in function_node.decorator_list)  # noqa: COP011
+    return any(check_is_fixture_decorator(one_decorator) for one_decorator in function_node.decorator_list)  # noqa: COP011
 
 
 def check_is_fixture_decorator(decorator: ast.expr) -> bool:

src/community_of_python_flake8_plugin/checks/mapping_proxy.py

@@ -71,9 +71,9 @@ def __init__(self, syntax_tree: ast.AST) -> None:  # noqa: ARG002
         self.violations: list[Violation] = []
 
     def visit_Module(self, ast_node: ast.Module) -> None:
-        for statement in ast_node.body:
-            if isinstance(statement, (ast.Assign, ast.AnnAssign)):
-                self._check_mapping_assignment(statement)
+        for one_statement in ast_node.body:
+            if isinstance(one_statement, (ast.Assign, ast.AnnAssign)):
+                self._check_mapping_assignment(one_statement)
         self.generic_visit(ast_node)
 
     def _check_mapping_assignment(self, ast_node: ast.Assign | ast.AnnAssign) -> None:
@@ -99,8 +99,8 @@ def _check_mapping_assignment(self, ast_node: ast.Assign | ast.AnnAssign) -> Non
         # Only check module-level assignments (no parent function/class)
         if assigned_value is not None and isinstance(assigned_value, ast.Dict) and assignment_targets:
             # Check if this is a module-level assignment
-            for target in assignment_targets:  # noqa: COP011
-                if isinstance(target, ast.Name):
+            for one_target in assignment_targets:  # noqa: COP011
+                if isinstance(one_target, ast.Name):
                     self.violations.append(
                         Violation(
                             line_number=ast_node.lineno,

src/community_of_python_flake8_plugin/checks/name_length.py

@@ -3,7 +3,11 @@
 import typing
 
 from community_of_python_flake8_plugin.constants import FINAL_CLASS_EXCLUDED_BASES, MIN_NAME_LENGTH
-from community_of_python_flake8_plugin.utils import check_inherits_from_bases, find_parent_class_definition, find_parent_function_definition
+from community_of_python_flake8_plugin.utils import (
+    check_inherits_from_bases,
+    find_parent_class_definition,
+    find_parent_function_definition,
+)
 from community_of_python_flake8_plugin.violation_codes import ViolationCodes
 from community_of_python_flake8_plugin.violations import Violation
 
@@ -33,7 +37,7 @@ def check_is_whitelisted_annotation(annotation: ast.expr | None) -> bool:
 def check_is_pytest_fixture(ast_node: ast.AST) -> bool:
     if not isinstance(ast_node, (ast.FunctionDef, ast.AsyncFunctionDef)):
         return False
-    return any(check_is_fixture_decorator(decorator) for decorator in ast_node.decorator_list)  # noqa: COP011
+    return any(check_is_fixture_decorator(one_decorator) for one_decorator in ast_node.decorator_list)  # noqa: COP011
 
 
 def check_is_fixture_decorator(decorator: ast.expr) -> bool:
@@ -58,9 +62,11 @@ def visit_AnnAssign(self, ast_node: ast.AnnAssign) -> None:
         self.generic_visit(ast_node)
 
     def visit_Assign(self, ast_node: ast.Assign) -> None:
-        for target in ast_node.targets:
-            if isinstance(target, ast.Name):
-                self.validate_name_length(target.id, ast_node, find_parent_class_definition(self.syntax_tree, ast_node))
+        for one_target in ast_node.targets:
+            if isinstance(one_target, ast.Name):
+                self.validate_name_length(
+                    one_target.id, ast_node, find_parent_class_definition(self.syntax_tree, ast_node)
+                )
         self.generic_visit(ast_node)
 
     def visit_FunctionDef(self, ast_node: ast.FunctionDef) -> None:
@@ -79,28 +85,28 @@ def visit_ClassDef(self, ast_node: ast.ClassDef) -> None:
         self.generic_visit(ast_node)
 
     def visit_ListComp(self, ast_node: ast.ListComp) -> None:
-        for comprehension in ast_node.generators:
-            self._validate_comprehension_target(comprehension.target)
+        for one_comprehension in ast_node.generators:
+            self._validate_comprehension_target(one_comprehension.target)
         self.generic_visit(ast_node)
 
     def visit_SetComp(self, ast_node: ast.SetComp) -> None:
-        for comprehension in ast_node.generators:
-            self._validate_comprehension_target(comprehension.target)
+        for one_comprehension in ast_node.generators:
+            self._validate_comprehension_target(one_comprehension.target)
         self.generic_visit(ast_node)
 
     def visit_DictComp(self, ast_node: ast.DictComp) -> None:
-        for comprehension in ast_node.generators:
-            self._validate_comprehension_target(comprehension.target)
+        for one_comprehension in ast_node.generators:
+            self._validate_comprehension_target(one_comprehension.target)
         self.generic_visit(ast_node)
 
     def visit_Lambda(self, ast_node: ast.Lambda) -> None:
         self._validate_function_args(ast_node.args)
         self.generic_visit(ast_node)
 
     def visit_With(self, ast_node: ast.With) -> None:
-        for item in ast_node.items:
-            if item.optional_vars is not None:
-                self._validate_with_target(item.optional_vars)
+        for one_item in ast_node.items:
+            if one_item.optional_vars is not None:
+                self._validate_with_target(one_item.optional_vars)
         self.generic_visit(ast_node)
 
     def visit_ExceptHandler(self, ast_node: ast.ExceptHandler) -> None:
@@ -109,18 +115,18 @@ def visit_ExceptHandler(self, ast_node: ast.ExceptHandler) -> None:
         self.generic_visit(ast_node)
 
     def visit_GeneratorExp(self, ast_node: ast.GeneratorExp) -> None:
-        for comprehension in ast_node.generators:
-            self._validate_comprehension_target(comprehension.target)
+        for one_comprehension in ast_node.generators:
+            self._validate_comprehension_target(one_comprehension.target)
         self.generic_visit(ast_node)
 
     def _validate_function_args(self, arguments_node: ast.arguments) -> None:
         # Process all argument types
-        for argument in arguments_node.posonlyargs:
-            self._validate_argument_name_length(argument)
-        for argument in arguments_node.args:
-            self._validate_argument_name_length(argument)
-        for argument in arguments_node.kwonlyargs:
-            self._validate_argument_name_length(argument)
+        for one_argument in arguments_node.posonlyargs:
+            self._validate_argument_name_length(one_argument)
+        for one_argument in arguments_node.args:
+            self._validate_argument_name_length(one_argument)
+        for one_argument in arguments_node.kwonlyargs:
+            self._validate_argument_name_length(one_argument)
 
         if arguments_node.vararg is not None:
             self._validate_argument_name_length(arguments_node.vararg)
@@ -157,8 +163,8 @@ def _validate_comprehension_target(self, comprehension_target: ast.expr) -> None
                 )
         elif isinstance(comprehension_target, ast.Tuple):
             # Handle tuple unpacking in comprehensions like [(a, b) for a, b in pairs]
-            for elt in comprehension_target.elts:
-                self._validate_comprehension_target(elt)
+            for one_elt in comprehension_target.elts:
+                self._validate_comprehension_target(one_elt)
 
     def _validate_with_target(self, target_node: ast.expr) -> None:
         if isinstance(target_node, ast.Name):
@@ -173,8 +179,8 @@ def _validate_with_target(self, target_node: ast.expr) -> None:
                 )
         elif isinstance(target_node, ast.Tuple):
             # Handle tuple unpacking in with statements like with open(f1) as f1, open(f2) as f2:
-            for elt in target_node.elts:
-                self._validate_with_target(elt)
+            for one_elt in target_node.elts:
+                self._validate_with_target(one_elt)
 
     def _validate_except_target(self, ast_node: ast.ExceptHandler) -> None:
         # For except targets, we'll treat them as variables
@@ -205,19 +211,17 @@ def validate_name_length(self, identifier: str, ast_node: ast.stmt, parent_class
 
         if len(identifier) < MIN_NAME_LENGTH:
             # Determine if this is an attribute (inside a class but not in a method) or variable
-            parent_function = find_parent_function_definition(self.syntax_tree, ast_node)
-            
+            parent_function: typing.Final = find_parent_function_definition(self.syntax_tree, ast_node)
+
             # It's an attribute only if it's in a class but NOT in a function/method
-            is_attribute = parent_class is not None and parent_function is None
-            
+            is_attribute: typing.Final = parent_class is not None and parent_function is None
+
             self.violations.append(
                 Violation(
                     line_number=ast_node.lineno,
                     column_number=ast_node.col_offset,
                     violation_code=(
-                        ViolationCodes.ATTRIBUTE_NAME_LENGTH
-                        if is_attribute
-                        else ViolationCodes.VARIABLE_NAME_LENGTH
+                        ViolationCodes.ATTRIBUTE_NAME_LENGTH if is_attribute else ViolationCodes.VARIABLE_NAME_LENGTH
                     ),
                 )
             )
@@ -245,12 +249,12 @@ def validate_function_name(
 
     def validate_function_args(self, ast_node: ast.FunctionDef | ast.AsyncFunctionDef) -> None:
         # Process all argument types
-        for argument in ast_node.args.posonlyargs:
-            self.validate_argument_name_length(argument)
-        for argument in ast_node.args.args:
-            self.validate_argument_name_length(argument)
-        for argument in ast_node.args.kwonlyargs:
-            self.validate_argument_name_length(argument)
+        for one_argument in ast_node.args.posonlyargs:
+            self.validate_argument_name_length(one_argument)
+        for one_argument in ast_node.args.args:
+            self.validate_argument_name_length(one_argument)
+        for one_argument in ast_node.args.kwonlyargs:
+            self.validate_argument_name_length(one_argument)
 
         if ast_node.args.vararg is not None:
             self.validate_argument_name_length(ast_node.args.vararg)