[#358] Fix ScopeConsumer use depending on pylint version

Author: carlio

CHANGELOG.rst

@@ -1,6 +1,19 @@
 Changelog
 =========
 
+Version 2.5.3 (25 Mär 2022)
+---------------------------
+
+Bugfixes
+~~~~~~~~
+
+- Fixed compatibility issue between pylint `2.12` and `2.13` to construct `ScopeConsumer` tuples correctly depending on version (`#358 <https://github.com/PyCQA/pylint-django/issues/358>`_)
+
+Other
+~~~~~
+
+- pylint version is now pinned to `<3` to give breathing space to update pylint-django before the major update lands
+
 Version 2.5.2 (18 Feb 2022)
 ---------------------------
 

pylint_django/augmentations/__init__.py

@@ -36,7 +36,7 @@
 from pylint.checkers.variables import ScopeConsumer, VariablesChecker
 from pylint_plugin_utils import augment_visit, suppress_message
 
-from pylint_django.utils import PY3, node_is_subclass
+from pylint_django.utils import node_is_subclass
 
 # Note: it would have been nice to import the Manager object from Django and
 # get its attributes that way - and this used to be the method - but unfortunately
@@ -329,14 +329,22 @@ def ignore_import_warnings_for_related_fields(orig_method, self, node):
 
     new_things = {}
 
-    iterat = consumer.to_consume.items if PY3 else consumer.to_consume.iteritems
-    for name, stmts in iterat():
+    for name, stmts in consumer.to_consume.items:
         if isinstance(stmts[0], ImportFrom):
             if any(n[0] in ("ForeignKey", "OneToOneField") for n in stmts[0].names):
                 continue
         new_things[name] = stmts
 
-    consumer._atomic = ScopeConsumer(new_things, consumer.consumed, consumer.scope_type)  # pylint: disable=W0212
+    # ScopeConsumer changed between pylint 2.12 and 2.13
+    # see https://github.com/PyCQA/pylint/issues/5970#issuecomment-1078778393
+    if hasattr(consumer, "consumed_uncertain"):
+        # this is pylint >= 2.13, and the ScopeConsumer tuple has an additional field
+        sc_args = (new_things, consumer.consumed, consumer.consumed_uncertain, consumer.scope_type)
+    else:
+        # this is <2.13 and does not have the consumer_uncertain field
+        sc_args = (new_things, consumer.consumed, consumer.scope_type)
+
+    consumer._atomic = ScopeConsumer(*sc_args)  # pylint: disable=W0212
     self._to_consume = [consumer]  # pylint: disable=W0212
 
     return orig_method(self, node)

setup.py

@@ -14,12 +14,12 @@
     author_email="[email protected]",
     description="A Pylint plugin to help Pylint understand the Django web framework",
     long_description=LONG_DESCRIPTION,
-    version="2.5.2",
+    version="2.5.3",
     packages=find_packages(),
     include_package_data=True,
     install_requires=[
         "pylint-plugin-utils>=0.7",
-        "pylint>=2.0",
+        "pylint>=2.0,<3",
     ],
     extras_require={
         "with_django": ["Django"],