keep the fixture checker class attributes private

Author: Anis Da Silva Campos

pylint_pytest/checkers/fixture.py

@@ -73,28 +73,28 @@ class FixtureChecker(BasePytestChecker):
     }
 
     # Store all fixtures discovered by pytest session
-    pytest_fixtures: FixtureDict = {}
+    _pytest_fixtures: FixtureDict = {}
     # Stores all used function arguments
-    invoked_with_func_args: set[str] = set()
+    _invoked_with_func_args: set[str] = set()
     # Stores all invoked fixtures through @pytest.mark.usefixture(...)
-    invoked_with_usefixtures: set[str] = set()
+    _invoked_with_usefixtures: set[str] = set()
 
     def close(self):
         """restore & reset class attr for testing"""
         # reset fixture info storage
-        FixtureChecker.pytest_fixtures = {}
-        FixtureChecker.invoked_with_func_args = set()
-        FixtureChecker.invoked_with_usefixtures = set()
+        FixtureChecker._pytest_fixtures = {}
+        FixtureChecker._invoked_with_func_args = set()
+        FixtureChecker._invoked_with_usefixtures = set()
 
     def visit_module(self, node):
         """
         - only run once per module
         - invoke pytest session to collect available fixtures
         - create containers for the module to store args and fixtures
         """
-        FixtureChecker.pytest_fixtures = {}
-        FixtureChecker.invoked_with_func_args = set()
-        FixtureChecker.invoked_with_usefixtures = set()
+        FixtureChecker._pytest_fixtures = {}
+        FixtureChecker._invoked_with_func_args = set()
+        FixtureChecker._invoked_with_usefixtures = set()
 
         is_test_module = False
         for pattern in FILE_NAME_PATTERNS:
@@ -128,7 +128,7 @@ def visit_module(self, node):
                 # restore sys.path
                 sys.path = sys_path
 
-                FixtureChecker.pytest_fixtures = fixture_collector.fixtures
+                FixtureChecker._pytest_fixtures = fixture_collector.fixtures
 
                 legitimate_failure_paths = set(
                     collection_report.nodeid
@@ -212,11 +212,11 @@ def visit_functiondef(self, node):
                     if _is_pytest_mark_usefixtures(decorator):
                         # save all visited fixtures
                         for arg in decorator.args:
-                            self.invoked_with_usefixtures.add(arg.value)
+                            self._invoked_with_usefixtures.add(arg.value)
                     if int(pytest.__version__.split(".")[0]) >= 3 and _is_pytest_fixture(
                         decorator, fixture=False
                     ):
                         # raise deprecated warning for @pytest.yield_fixture
                         self.add_message("deprecated-pytest-yield-fixture", node=node)
             for arg in node.args.args:
-                self.invoked_with_func_args.add(arg.name)
+                self._invoked_with_func_args.add(arg.name)

pylint_pytest/checkers/variables.py

@@ -13,6 +13,9 @@
 class CustomVariablesChecker(VariablesChecker):
     """Overrides the default VariablesChecker of pylint to discard unwanted warning messages"""
 
+    # pylint: disable=protected-access
+    # this class needs to access the fixture checker registries
+
     def add_message(
         self,
         msgid: str,
@@ -44,29 +47,29 @@ def add_message(
                 node
                 and isinstance(node.parent, Module)
                 and node.parent.name.split(".")[-1] == "conftest"
-                and fixture_name in FixtureChecker.pytest_fixtures
+                and fixture_name in FixtureChecker._pytest_fixtures
             ):
                 return
 
             # imported fixture is referenced in test/fixture func
             elif (
-                fixture_name in FixtureChecker.invoked_with_func_args
-                and fixture_name in FixtureChecker.pytest_fixtures
+                fixture_name in FixtureChecker._invoked_with_func_args
+                and fixture_name in FixtureChecker._pytest_fixtures
             ):
                 if _is_same_module(
-                    fixtures=FixtureChecker.pytest_fixtures,
+                    fixtures=FixtureChecker._pytest_fixtures,
                     import_node=node,
                     fixture_name=fixture_name,
                 ):
                     return
 
             # fixture is referenced in @pytest.mark.usefixtures
             elif (
-                fixture_name in FixtureChecker.invoked_with_usefixtures
-                and fixture_name in FixtureChecker.pytest_fixtures
+                fixture_name in FixtureChecker._invoked_with_usefixtures
+                and fixture_name in FixtureChecker._pytest_fixtures
             ):
                 if _is_same_module(
-                    fixtures=FixtureChecker.pytest_fixtures,
+                    fixtures=FixtureChecker._pytest_fixtures,
                     import_node=node,
                     fixture_name=fixture_name,
                 ):
@@ -79,15 +82,15 @@ def add_message(
             and _can_use_fixture(node.parent.parent)
             and isinstance(node.parent, Arguments)
         ):
-            if node.name in FixtureChecker.pytest_fixtures:
+            if node.name in FixtureChecker._pytest_fixtures:
                 # argument is used as a fixture
                 return
 
             fixnames = (
-                arg.name for arg in node.parent.args if arg.name in FixtureChecker.pytest_fixtures
+                arg.name for arg in node.parent.args if arg.name in FixtureChecker._pytest_fixtures
             )
             for fixname in fixnames:
-                if node.name in FixtureChecker.pytest_fixtures[fixname][0].argnames:
+                if node.name in FixtureChecker._pytest_fixtures[fixname][0].argnames:
                     # argument is used by a fixture
                     return
 
@@ -97,7 +100,7 @@ def add_message(
             and node
             and _can_use_fixture(node.parent.parent)
             and isinstance(node.parent, Arguments)
-            and node.name in FixtureChecker.pytest_fixtures
+            and node.name in FixtureChecker._pytest_fixtures
         ):
             return