Setup dev tools and format with Ruff

Author: stephane

pyproject.toml

@@ -52,3 +52,28 @@ allow-direct-references = true
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/webstack_django_sorting"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py38"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.mypy]
+python_version = "3.8"
+plugins = ["mypy_django_plugin.main"]
+strict = false
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "django.*"
+ignore_missing_imports = true
+
+[tool.django-stubs]
+django_settings_module = "testproj.settings"
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "testproj.settings"
+pythonpath = ["src/testproj"]

src/testproj/manage.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 

src/testproj/testproj/settings.py

@@ -83,9 +83,7 @@
 # https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
-    },
+    {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"},
     {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
     {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
     {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},

src/testproj/testproj/testapp/tests.py

@@ -9,12 +9,8 @@ class IndexTest(TestCase):
     def setUp(self):
         self.url = reverse("secret_list")
 
-        self.foo_file = models.SecretFile.objects.create(
-            filename="foo.txt", order=1, size=1024
-        )
-        self.bar_file = models.SecretFile.objects.create(
-            filename="bar.txt", order=2, size=512
-        )
+        self.foo_file = models.SecretFile.objects.create(filename="foo.txt", order=1, size=1024)
+        self.bar_file = models.SecretFile.objects.create(filename="bar.txt", order=2, size=512)
 
     def test_list(self):
         response = self.client.get(self.url)
@@ -46,15 +42,9 @@ def setUp(self):
         self.nulls_first_url = reverse("nulls_first")
         self.nulls_last_url = reverse("nulls_last")
 
-        self.foo_file = models.SecretFile.objects.create(
-            filename="foo.txt", order=1, size=1024
-        )
-        self.bar_file = models.SecretFile.objects.create(
-            filename="bar.txt", order=2, size=512
-        )
-        self.none_file = models.SecretFile.objects.create(
-            filename=None, order=3, size=512
-        )
+        self.foo_file = models.SecretFile.objects.create(filename="foo.txt", order=1, size=1024)
+        self.bar_file = models.SecretFile.objects.create(filename="bar.txt", order=2, size=512)
+        self.none_file = models.SecretFile.objects.create(filename=None, order=3, size=512)
 
     def test_sorting_nulls_first(self):
         """Verify None sorted field_name is in first places when sorting in asc and desc order"""

src/testproj/testproj/testapp/views.py

@@ -8,15 +8,15 @@ def home(request):
 
 
 def secret_list(request):
-    return render(
-        request, "secret_list.html", {"secret_files": models.SecretFile.objects.all()}
-    )
+    return render(request, "secret_list.html", {"secret_files": models.SecretFile.objects.all()})
+
 
 def secret_list_some_desc(request):
     return render(
         request, "secret_list_some_desc.html", {"secret_files": models.SecretFile.objects.all()}
     )
 
+
 def secret_list_nulls_first(request):
     return render(
         request,
@@ -34,15 +34,15 @@ def secret_list_nulls_last(request):
 
 
 def jinja_secret_list(request):
-    return render(
-        request, "secret_list.jinja2", {"secret_files": models.SecretFile.objects.all()}
-    )
+    return render(request, "secret_list.jinja2", {"secret_files": models.SecretFile.objects.all()})
+
 
 def jinja_secret_list_some_desc(request):
     return render(
         request, "secret_list_some_desc.jinja2", {"secret_files": models.SecretFile.objects.all()}
     )
 
+
 def jinja_secret_list_nulls_first(request):
     return render(
         request,

src/testproj/testproj/urls.py

@@ -6,11 +6,15 @@
 urlpatterns = [
     path("", views.home, name="home"),
     path("list", views.secret_list, name="secret_list"),
-    path("list_some_desc", views.secret_list_some_desc, name="secret_list_some_desc"),    
+    path("list_some_desc", views.secret_list_some_desc, name="secret_list_some_desc"),
     path("nulls/first", views.secret_list_nulls_first, name="nulls_first"),
     path("nulls/last", views.secret_list_nulls_last, name="nulls_last"),
     path("jinja/list", views.jinja_secret_list, name="jinja_secret_list"),
-    path("jinja/list_some_desc", views.jinja_secret_list_some_desc, name="jinja_secret_list_some_desc"),
+    path(
+        "jinja/list_some_desc",
+        views.jinja_secret_list_some_desc,
+        name="jinja_secret_list_some_desc",
+    ),
     path(
         "jinja/nulls/first",
         views.jinja_secret_list_nulls_first,

src/webstack_django_sorting/settings.py

@@ -2,4 +2,4 @@
 
 DEFAULT_SORT_UP = getattr(settings, "DEFAULT_SORT_UP", " ↑")
 DEFAULT_SORT_DOWN = getattr(settings, "DEFAULT_SORT_DOWN", " ↓")
-INVALID_FIELD_RAISES_404 = getattr(settings, "SORTING_INVALID_FIELD_RAISES_404", False)
+INVALID_FIELD_RAISES_404 = getattr(settings, "SORTING_INVALID_FIELD_RAISES_404", False)

src/webstack_django_sorting/templatetags/sorting_tags.py

@@ -35,9 +35,7 @@ def anchor(parser, token):
     except IndexError:
         title = bits[1].capitalize()
 
-    default_sort_order = (
-        "desc" if len(bits) >= 4 and bits[3].strip("'\"") == "desc" else "asc"
-    )
+    default_sort_order = "desc" if len(bits) >= 4 and bits[3].strip("'\"") == "desc" else "asc"
 
     return SortAnchorNode(
         bits[1].strip(),
@@ -61,9 +59,7 @@ class SortAnchorNode(template.Node):
 
     """
 
-    def __init__(
-        self, field, title, title_is_var, title_is_translatable, default_sort_order
-    ):
+    def __init__(self, field, title, title_is_var, title_is_translatable, default_sort_order):
         self.field = field
         self.title = title
         self.title_is_var = title_is_var
@@ -85,9 +81,7 @@ def render(self, context):
 
 def autosort(parser, token):
     bits = [b.strip("\"'") for b in token.split_contents()]
-    help_msg = (
-        "autosort tag synopsis: {%% autosort queryset [as " "context_variable] %%}"
-    )
+    help_msg = "autosort tag synopsis: {%% autosort queryset [as context_variable] %%}"
     context_var = None
 
     # Check if their is some optional parameter (as new_context_var, nulls)