Running black against the new Foreign Key checker and fixing CHANGELOG header

Author: carlio

CHANGELOG.rst

@@ -1,6 +1,17 @@
 Changelog
 =========
 
+Version 2.3.1 (TBD)
+-------------------
+
+- Allowed configuration of the Django settings module to be used via a
+  commandline argument `#286 <https://github.com/PyCAQ/pylint-django/issues/286>`_
+- If Django settings are not specified via a commandline argument or environment
+  variable, an error is issued but defaults are loaded from Django, removing the
+  fatal error behaviour. `#277 <https://github.com/PyCAQ/pylint-django/issues/277>`__
+  and `#243 <https://github.com/PyCAQ/pylint-django/issues/243>`__
+- Fixed tests to work with pylint>2.6
+
 Version 2.3.0 (05 Aug 2020)
 ---------------------------
 

pylint_django/checkers/foreign_key_strings.py

@@ -1,10 +1,12 @@
 from __future__ import absolute_import
+
+import astroid
 from pylint.checkers import BaseChecker
-from pylint.interfaces import IAstroidChecker
 from pylint.checkers.utils import check_messages
+from pylint.interfaces import IAstroidChecker
+
 from pylint_django.__pkginfo__ import BASE_ID
 from pylint_django.transforms import foreignkey
-import astroid
 
 
 class ForeignKeyStringsChecker(BaseChecker):
@@ -41,15 +43,27 @@ class ForeignKeyStringsChecker(BaseChecker):
         ),
     )
 
-    msgs = {"E%s10" % BASE_ID: ("Django was not configured. For more information run pylint --load-plugins=pylint_django --help-msg=django-not-configured", "django-not-configured", _LONG_MESSAGE),
-    "F%s10" % BASE_ID: (
-        'Provided Django settings %s could not be loaded',
-        'django-settings-module-not-found',
-        'The provided Django settings module %s was not found on the path'
-    )}
+    msgs = {
+        "E%s10"
+        % BASE_ID: (
+            "Django was not configured. For more information run"
+            "pylint --load-plugins=pylint_django --help-msg=django-not-configured",
+            "django-not-configured",
+            _LONG_MESSAGE,
+        ),
+        "F%s10"
+        % BASE_ID: (
+            "Provided Django settings %s could not be loaded",
+            "django-settings-module-not-found",
+            "The provided Django settings module %s was not found on the path",
+        ),
+    }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._raise_warning = False
 
     def open(self):
-        self._raise_warning = False
         # This is a bit of a hacky workaround. pylint-django does not *require* that
         # Django is configured explicitly, and will use some basic defaults in that
         # case. However, as this is a WARNING not a FATAL, the error must be raised
@@ -66,15 +80,15 @@ def open(self):
         # must wait until some module is inspected to be able to raise... so that
         # state is stashed in this property.
 
-        from django.core.exceptions import (
+        from django.core.exceptions import (  # pylint: disable=import-outside-toplevel
             ImproperlyConfigured,
-        )  # pylint: disable=import-outside-toplevel
+        )
 
         try:
             import django  # pylint: disable=import-outside-toplevel
 
             django.setup()
-            from django.apps import apps  # pylint: disable=import-outside-toplevel
+            from django.apps import apps  # noqa pylint: disable=import-outside-toplevel,unused-import
         except ImproperlyConfigured:
             # this means that Django wasn't able to configure itself using some defaults
             # provided (likely in a DJANGO_SETTINGS_MODULE environment variable)
@@ -83,21 +97,33 @@ def open(self):
                 # we will warn the user that they haven't actually configured Django themselves
                 self._raise_warning = True
                 # but use django defaults then...
-                from django.conf import settings  # pylint: disable=import-outside-toplevel
+                from django.conf import (  # pylint: disable=import-outside-toplevel
+                    settings,
+                )
                 settings.configure()
                 django.setup()
             else:
                 # see if we can load the provided settings module
                 try:
-                    from django.conf import settings, Settings  # pylint: disable=import-outside-toplevel
+                    from django.conf import (  # pylint: disable=import-outside-toplevel
+                        settings,
+                        Settings,
+                    )
+
                     settings.configure(Settings(self.config.django_settings_module))
                     django.setup()
                 except ImportError:
                     # we could not find the provided settings module...
                     # at least here it is a fatal error so we can just raise this immediately
-                    self.add_message('django-settings-module-not-found', args=self.config.django_settings_module)
+                    self.add_message(
+                        "django-settings-module-not-found",
+                        args=self.config.django_settings_module,
+                    )
                     # however we'll trundle on with basic settings
-                    from django.conf import settings  # pylint: disable=import-outside-toplevel
+                    from django.conf import (  # pylint: disable=import-outside-toplevel
+                        settings,
+                    )
+
                     settings.configure()
                     django.setup()
 
@@ -108,7 +134,6 @@ def open(self):
         # duplicating the django_installed checker, it'll do for now. In the future, merging
         # those two checkers together might make sense.
 
-
     @check_messages("django-not-configured")
     def visit_module(self, node):
         if self._raise_warning:

pylint_django/transforms/__init__.py

@@ -18,7 +18,6 @@
 fields.add_transforms(astroid.MANAGER)
 
 
-
 def _add_transform(package_name):
     def fake_module_builder():
         """

pylint_django/transforms/foreignkey.py

@@ -108,10 +108,10 @@ def infer_key_classes(node, context=None):
                     # 'auth.models', 'User' which works nicely with the `endswith()`
                     # comparison below
                     module_name += '.models'
-                except ImproperlyConfigured:
+                except ImproperlyConfigured as exep:
                     raise RuntimeError("DJANGO_SETTINGS_MODULE required for resolving ForeignKey "
                                        "string references, see Usage section in README at "
-                                       "https://pypi.org/project/pylint-django/!")
+                                       "https://pypi.org/project/pylint-django/!") from exep
 
                 # ensure that module is loaded in astroid_cache, for cases when models is a package
                 if module_name not in MANAGER.astroid_cache: