Merge pull request #340 from PyCQA/github-actions

Replacing travis with GitHub actions

Author: carlio

.github/workflows/testing.yml

@@ -0,0 +1,87 @@
+name: testing
+
+on:
+  push:
+    branches: master
+  pull_request:
+
+jobs:
+  sanity:
+    name: sanity / ${{ matrix.toxenv }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6]
+        toxenv: [django_not_installed, django_is_installed, flake8, pylint, readme]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Execute tests
+        run: |
+            pip install tox
+            pip install -e .[for_tests]
+
+            export TOXENV=${{ matrix.toxenv }}
+            export PYTHON=${{ matrix.python-version }}
+            tox
+
+
+  test:
+    name: test / Django@${{ matrix.django-version }} / Python@${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        django-version: [-main, 3.2, 3.1, "3.0", "2.0", 1.11]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Execute tests
+        run: |
+            pip install tox
+            pip install -e .[for_tests]
+
+            export DJANGO=${{ matrix.django-version }}
+            export PYTHON=${{ matrix.python-version }}
+            export TOXENV=$(echo py${{ matrix.python-version }}-django${{ matrix.django-version }} | tr -d .)
+            tox
+
+      - name: Coveralls
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+            pip install coveralls
+            coveralls --service=github
+
+  build_and_package_sanity:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build
+        run: |
+            pip install tox
+            pip install -e .[for_tests]
+
+            ./scripts/build.sh

.pre-commit-config.yaml

@@ -13,12 +13,12 @@ repos:
     rev: 4.0.1
     hooks:
       - id: flake8
-        args: [ --max-line-length=120 ]
+        args: [ --max-line-length=140 ]
   - repo: https://github.com/python/black
     rev: 21.9b0
     hooks:
       - id: black
-        args: [--safe, --line-length=120]
+        args: [--safe, --line-length=140]
   - repo: https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:

.travis.yml

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+Version 2.5 [WIP]
+---------------------------
+- Moved from Travis CI to GitHub Actions (`#366 <https://github.com/PyCQA/pylint-django/pull/366>`_ and `#340 <https://github.com/PyCQA/pylint-django/pull/340>`_)
+- Added pre-commit configuration and began enforcing black/isort code formatting (TODO: add github action to enforce)
+- Multiple test fixes (including `#338 <https://github.com/PyCQA/pylint-django/issues/338>`_) - newer versions of pylint expect a different format for the expected messages txt files.
+- TODO: Bumped dependency for pylint-django-utils to get `multi-threaded pylint support <https://github.com/PyCQA/pylint-plugin-utils/pull/21>`_
+
 Version 2.4.4 (26 Apr 2021)
 ---------------------------
 

CHANGELOG.rst

@@ -1,11 +1,8 @@
 pylint-django
 =============
 
-.. image:: https://travis-ci.org/PyCQA/pylint-django.svg?branch=master
-    :target: https://travis-ci.org/PyCQA/pylint-django
-
-.. image:: https://landscape.io/github/landscapeio/pylint-django/master/landscape.png
-    :target: https://landscape.io/github/landscapeio/pylint-django
+.. image:: https://github.com/PyCQA/pylint-django/actions/workflows/testing.yml/badge.svg
+    :target: https://github.com/PyCQA/pylint-django/actions/workflows/testing.yml
 
 .. image:: https://coveralls.io/repos/PyCQA/pylint-django/badge.svg
     :target: https://coveralls.io/r/PyCQA/pylint-django

README.rst

@@ -281,7 +281,10 @@
 
 VIEW_ATTRS = {
     (
-        ("{}.{}".format(cls.__module__, cls.__name__), ".{}".format(cls.__name__)),
+        (
+            f"{cls.__module__}.{cls.__name__}",
+            f".{cls.__name__}",
+        ),
         tuple(cls.__dict__.keys()),
     )
     for cls in (

pylint_django/augmentations/__init__.py

@@ -10,17 +10,15 @@ class AuthUserChecker(checkers.BaseChecker):
     name = "auth-user-checker"
 
     msgs = {
-        "E%d41"
-        % BASE_ID: (
+        f"E{BASE_ID}41": (
             "Hard-coded 'auth.User'",
             "hard-coded-auth-user",
-            "Don't hard-code the auth.User model. " "Use settings.AUTH_USER_MODEL instead!",
+            "Don't hard-code the auth.User model. Use settings.AUTH_USER_MODEL instead!",
         ),
-        "E%d42"
-        % BASE_ID: (
+        f"E{BASE_ID}42": (
             "User model imported from django.contrib.auth.models",
             "imported-auth-user",
-            "Don't import django.contrib.auth.models.User model. " "Use django.contrib.auth.get_user_model() instead!",
+            "Don't import django.contrib.auth.models.User model. Use django.contrib.auth.get_user_model() instead!",
         ),
     }
 

pylint_django/checkers/auth_user.py

@@ -10,15 +10,13 @@ class DjangoInstalledChecker(BaseChecker):
     name = "django-installed-checker"
 
     msgs = {
-        "F%s01"
-        % BASE_ID: (
+        f"F{BASE_ID}01": (
             "Django is not available on the PYTHONPATH",
             "django-not-available",
             "Django could not be imported by the pylint-django plugin, so most Django related "
             "improvements to pylint will fail.",
         ),
-        "W%s99"
-        % BASE_ID: (
+        f"W{BASE_ID}99": (
             "Placeholder message to prevent disabling of checker",
             "django-not-available-placeholder",
             "PyLint does not recognise checkers as being enabled unless they have at least"

pylint_django/checkers/django_installed.py

@@ -44,15 +44,13 @@ class ForeignKeyStringsChecker(BaseChecker):
     )
 
     msgs = {
-        "E%s10"
-        % BASE_ID: (
+        f"E{BASE_ID}10": (
             "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: (
+        f"F{BASE_ID}10": (
             "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",
@@ -80,9 +78,12 @@ 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 (  # pylint: disable=import-outside-toplevel
-            ImproperlyConfigured,
-        )
+        try:
+            from django.core.exceptions import (  # pylint: disable=import-outside-toplevel
+                ImproperlyConfigured,
+            )
+        except ModuleNotFoundError:
+            return
 
         try:
             import django  # pylint: disable=import-outside-toplevel

pylint_django/checkers/foreign_key_strings.py

@@ -22,11 +22,10 @@ class FormChecker(BaseChecker):
 
     name = "django-form-checker"
     msgs = {
-        "W%d04"
-        % BASE_ID: (
+        f"W{BASE_ID}04": (
             "Use explicit fields instead of exclude in ModelForm",
             "modelform-uses-exclude",
-            "Prevents accidentally allowing users to set fields, " "especially when adding new fields to a Model",
+            "Prevents accidentally allowing users to set fields, especially when adding new fields to a Model",
         )
     }
 
@@ -47,5 +46,5 @@ def visit_classdef(self, node):
                 continue
 
             if child.targets[0].name == "exclude":
-                self.add_message("W%s04" % BASE_ID, node=child)
+                self.add_message(f"W{BASE_ID}04", node=child)
                 break

pylint_django/checkers/forms.py

@@ -24,20 +24,17 @@ class JsonResponseChecker(checkers.BaseChecker):
     # configuration section name
     name = "json-response-checker"
     msgs = {
-        "R%s01"
-        % BASE_ID: (
+        f"R{BASE_ID}01": (
             "Instead of HttpResponse(json.dumps(data)) use JsonResponse(data)",
             "http-response-with-json-dumps",
             "Used when json.dumps() is used as an argument to HttpResponse().",
         ),
-        "R%s02"
-        % BASE_ID: (
+        f"R{BASE_ID}02": (
             "Instead of HttpResponse(content_type='application/json') use JsonResponse()",
             "http-response-with-content-type-json",
             "Used when HttpResponse() is returning application/json.",
         ),
-        "R%s03"
-        % BASE_ID: (
+        f"R{BASE_ID}03": (
             "Redundant content_type parameter for JsonResponse()",
             "redundant-content-type-for-json-response",
             "Used when JsonResponse() contains content_type parameter. "

pylint_django/checkers/json_response.py

@@ -56,11 +56,10 @@ class NewDbFieldWithDefaultChecker(checkers.BaseChecker):
     # configuration section name
     name = "new-db-field-with-default"
     msgs = {
-        "W%s98"
-        % BASE_ID: (
+        f"W{BASE_ID}98": (
             "%s AddField with default value",
             "new-db-field-with-default",
-            "Used when Pylint detects migrations adding new " "fields with a default value.",
+            "Used when Pylint detects migrations adding new fields with a default value.",
         )
     }
 
@@ -119,11 +118,10 @@ class MissingBackwardsMigrationChecker(checkers.BaseChecker):
     name = "missing-backwards-migration-callable"
 
     msgs = {
-        "W%s97"
-        % BASE_ID: (
+        f"W{BASE_ID}97": (
             "Always include backwards migration callable",
             "missing-backwards-migration-callable",
-            "Always include a backwards/reverse callable counterpart" " so that the migration is not irreversable.",
+            "Always include a backwards/reverse callable counterpart so that the migration is not irreversable.",
         )
     }