Merge pull request #90 from DemocracyClub/upgrades202408

test on current python/django versions, linter config

Author: chris48s

.circleci/config.yml

@@ -1,15 +1,12 @@
 version: 2.1
 
 executors:
-  py38:
-    docker:
-      - image: cimg/python:3.8
-  py39:
-    docker:
-      - image: cimg/python:3.9
   py310:
     docker:
       - image: cimg/python:3.10
+  py312:
+    docker:
+      - image: cimg/python:3.12
 
 jobs:
   run_tests:
@@ -39,21 +36,17 @@ jobs:
           command: |
             python manage.py check
       - run:
-          name: Black
+          name: Djhtml
           command: |
-            black . --check
-      - run:
-          name: Curly Lint
-          command: | 
-            curlylint .
+            git ls-files '*.html' | xargs djhtml --check
       - run:
           name: Ruff lint
           command: |  
             ruff check .
       - run:
           name: Ruff Format
           command: | 
-            ruff format .
+            ruff format . --check
       - run: mkdir -p test-results
       - run:
           name: Pytest
@@ -69,6 +62,6 @@ workflows:
 
           matrix:
             parameters:
-              python_version: [ py38, py39, py310 ]
-              django_version: [ ">=3.2,<4.0", ">=4.0,<4.1", ">=4.1,<4.2" ]
+              python_version: [ py310, py312 ]
+              django_version: [ ">=4.2,<4.3", ">=5.1,<5.2" ]
 

.pre-commit-config.yaml

@@ -1,8 +1,11 @@
 repos:
--   repo: https://github.com/ambv/black
-    rev: 21.7b0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # keep in step with verison in pyproject.toml
+    rev: v0.6.1
     hooks:
-    - id: black
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
 -   repo: https://github.com/rtts/djhtml
     rev: v1.4.9
     hooks:

README.md

@@ -83,7 +83,7 @@ Install the dev dependencies:
 
     pip install -e .[dev]
 
-This project uses [pre-commit](https://pre-commit.com/#quick-start) to run `black` and `djhtml` before each commit. To enable this, after installing the dev dependencies run:
+This project uses [pre-commit](https://pre-commit.com/#quick-start) to run `ruff` and `djhtml` before each commit. To enable this, after installing the dev dependencies run:
 
 `pre-commit install`
 

dc_utils/filter_widgets.py

@@ -5,9 +5,9 @@
 except ImportError:
     raise ImportError("Filter widgets requires Django-Filter to be installed")
 
-from django.utils.safestring import mark_safe
 from django.db.models import BLANK_CHOICE_DASH
 from django.utils.encoding import force_str
+from django.utils.safestring import mark_safe
 
 __all__ = ("DSLinkWidget",)
 

dc_utils/forms.py

@@ -2,12 +2,11 @@
 
 from django import forms
 from django.core.exceptions import ValidationError
-
-from . import widgets
-
 from django.utils.translation import gettext_lazy as _
 from localflavor.gb.forms import GBPostcodeField
 
+from . import widgets
+
 
 class RadioSelectCluster(forms.RadioSelect):
     pass

dc_utils/storages.py

@@ -1,4 +1,4 @@
-from urllib.parse import urlsplit, urlunsplit, unquote
+from urllib.parse import unquote, urlsplit, urlunsplit
 
 from django.contrib.staticfiles.storage import ManifestStaticFilesStorage
 from pipeline.storage import PipelineMixin
@@ -20,10 +20,13 @@ def stored_name(self, name):
         clean_name = parsed_name.path.strip()
         hash_key = self.hash_key(clean_name)
         cache_name = self.hashed_files.get(hash_key)
-        if cache_name is None:
-            # This bit below is changed from the parent class
-            if not self.manifest_strict:
-                return name
+
+        # ---
+        # This bit is changed from the parent class
+        if cache_name is None and not self.manifest_strict:
+            return name
+        # ---
+
         unparsed_name = list(parsed_name)
         unparsed_name[2] = cache_name
         # Special casing for a @font-face hack, like url(myfont.eot?#iefix")

dc_utils/templatetags/dc_forms.py

@@ -26,7 +26,7 @@ def add_input_classes(field):
 def dc_form(element):
     if not isinstance(element, forms.BaseForm):
         # if called without a form object, return without rendering
-        return
+        return None
     markup_classes = {"label": "", "value": "", "single_value": ""}
     return render(element, markup_classes)
 

dc_utils/tests/test_dc_forms.py

@@ -17,7 +17,7 @@ def test_render_called_when_element_is_a_form(self, mocker):
         mocker.patch("dc_utils.templatetags.dc_forms.render", mock_render)
         form = forms.Form()
         assert dc_form(element=form) == "rendered_form"
-        mock_render.called_once_with(
+        mock_render.assert_called_once_with(
             form, {"label": "", "value": "", "single_value": ""}
         )
 
@@ -35,6 +35,6 @@ class Meta:
         mocker.patch("dc_utils.templatetags.dc_forms.render", mock_render)
 
         assert dc_form(element=form) == "rendered_form"
-        mock_render.called_once_with(
+        mock_render.assert_called_once_with(
             form, {"label": "", "value": "", "single_value": ""}
         )

dc_utils/tests/test_helpers.py

@@ -1,4 +1,4 @@
-from dc_utils.tests.helpers import validate_html_str, validate_html
+from dc_utils.tests.helpers import validate_html, validate_html_str
 
 
 def test_validate_html_str():

dc_utils/urls.py

@@ -1,7 +1,7 @@
 from django import http
 from django.conf import settings
-from django.urls import re_path
 from django.template import TemplateDoesNotExist, loader
+from django.urls import re_path
 from django.views.decorators.csrf import requires_csrf_token
 from django.views.defaults import ERROR_500_TEMPLATE_NAME, page_not_found
 from django.views.generic import TemplateView