Migrate from flake8 and isort to ruff. (#629)

Author: Antoliny0919

.github/workflows/pythonpackage.yml

@@ -39,14 +39,10 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements/production.txt
-      - name: Lint with flake8
+      - name: Install Linter
         run: |
-          pip install flake8
-          flake8 .
-      - name: iSort
-        run: |
-          pip install isort
-          isort --check-only --diff cab comments_spamfighter djangosnippets ratings
+          pip install ruff
+          ruff check .
       - name: Run migrations
         run: python manage.py migrate
       - name: Collect static files

.pre-commit-config.yaml

@@ -1,25 +1,17 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v3.2.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
 
--   repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.3
     hooks:
-      - id: isort
-
--   repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
-
--   repo: https://github.com/pycqa/flake8
-    rev: '7.2.0'  # pick a git hash / tag to point to
-    hooks:
-    -   id: flake8
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

base/components/__init__.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from django_components import Component, register
 from pydantic import BaseModel
@@ -10,7 +10,6 @@
 
 @register("icon")
 class Icon(Component):
-
     class Kwargs(BaseModel):
         kind: Literal["heart", "bookmark"]
         color: str
@@ -29,8 +28,8 @@ def get_template_data(self, args, kwargs, slots, context):
 
 class PaginationItem(BaseModel):
     kind: Literal["current", "ellipsis", "number"]
-    text: Optional[str | int] = None
-    attrs: Optional[dict] = None
+    text: str | int | None = None
+    attrs: dict | None = None
 
 
 @register("pagination")
@@ -48,21 +47,26 @@ def pagination_number(self, pagination: Pagination, num: int) -> PaginationItem:
         """
         if num == pagination.paginator.ELLIPSIS:
             return PaginationItem(kind="ellipsis", text=str(pagination.paginator.ELLIPSIS))
-        elif num == pagination.page_num:
+        if num == pagination.page_num:
             return PaginationItem(kind="current", text=num)
-        else:
-            link = querystring(None, {**pagination.params, PAGE_VAR: num})
-            return PaginationItem(
-                kind="number",
-                text=num,
-                attrs={"href": link},
-            )
+        link = querystring(None, {**pagination.params, PAGE_VAR: num})
+        return PaginationItem(
+            kind="number",
+            text=num,
+            attrs={"href": link},
+        )
 
     def get_template_data(self, args, kwargs, slots, context):
         pagination = kwargs.pagination_obj
-        page_elements = [self.pagination_number(pagination, page_num) for page_num in pagination.page_range]
-        previous_page_link = f"?{PAGE_VAR}={pagination.page_num - 1}" if pagination.page.has_previous() else ""
-        next_page_link = f"?{PAGE_VAR}={pagination.page_num + 1}" if pagination.page.has_next() else ""
+        page_elements = [
+            self.pagination_number(pagination, page_num) for page_num in pagination.page_range
+        ]
+        previous_page_link = (
+            f"?{PAGE_VAR}={pagination.page_num - 1}" if pagination.page.has_previous() else ""
+        )
+        next_page_link = (
+            f"?{PAGE_VAR}={pagination.page_num + 1}" if pagination.page.has_next() else ""
+        )
         return {
             "pagination": pagination,
             "previous_page_link": previous_page_link,
@@ -74,7 +78,7 @@ def get_template_data(self, args, kwargs, slots, context):
 class TabItem(BaseModel):
     text: str
     is_current: bool
-    attrs: Optional[dict]
+    attrs: dict | None
 
 
 @register("sorting_tabs")
@@ -95,8 +99,7 @@ def create_tab(self, object_list: ObjectList, tab: str) -> TabItem:
         return TabItem(text=verbose_text, is_current=is_current, attrs=attrs)
 
     def create_all_tabs(self, object_list: ObjectList):
-        tabs = [self.create_tab(object_list, tab) for tab in object_list.sorting_tabs]
-        return tabs
+        return [self.create_tab(object_list, tab) for tab in object_list.sorting_tabs]
 
     def get_template_data(self, args, kwargs, slots, context):
         object_list = kwargs.object_list

base/components/components.py

@@ -1,6 +1,4 @@
-class IncorectLookupParameter(Exception):
+class IncorrectLookupParameterError(Exception):
     """
     Raised when a query parameter contains an incorrect value.
     """
-
-    pass

base/exceptions.py

@@ -49,5 +49,4 @@ def paginate(self, request, queryset):
 
     def get_objects(self, request, queryset):
         tab_result = self.tab_sort(queryset)
-        paginate_result = self.paginate(request, tab_result)
-        return paginate_result
+        return self.paginate(request, tab_result)

base/main.py

@@ -1,6 +1,6 @@
 from django.core.paginator import InvalidPage, Paginator
 
-from .exceptions import IncorectLookupParameter
+from .exceptions import IncorrectLookupParameterError
 
 PAGE_VAR = "page"
 
@@ -49,6 +49,6 @@ def get_objects(self):
         else:
             try:
                 result_list = self.paginator.page(self.page_num).object_list
-            except InvalidPage:
-                raise IncorectLookupParameter
+            except InvalidPage as err:
+                raise IncorrectLookupParameterError from err
         return result_list

base/pagination.py

@@ -49,12 +49,16 @@ def querystring(context, *args, **kwargs):
     params = QueryDict(mutable=True)
     for d in [*args, kwargs]:
         if not isinstance(d, Mapping):
+            msg = f"querystring requires mappings for positional arguments (got {d!r} instead)."
             raise TemplateSyntaxError(
-                "querystring requires mappings for positional arguments (got " "%r instead)." % d
+                msg,
             )
         for key, value in d.items():
             if not isinstance(key, str):
-                raise TemplateSyntaxError("querystring requires strings for mapping keys (got %r " "instead)." % key)
+                msg = f"querystring requires strings for mapping keys (got {key!r} instead)."
+                raise TemplateSyntaxError(
+                    msg,
+                )
             if value is None:
                 params.pop(key, None)
             elif isinstance(value, Iterable) and not isinstance(value, str):

base/templatetags/base_templatetags.py

@@ -6,7 +6,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
@@ -17,26 +16,56 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name="Beverage",
             fields=[
-                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
                 ("name", models.CharField(max_length=50)),
             ],
         ),
         migrations.CreateModel(
             name="Food",
             fields=[
-                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
                 ("name", models.CharField(max_length=50)),
             ],
         ),
         migrations.CreateModel(
             name="BeverageRating",
             fields=[
-                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
                 ("score", models.FloatField(db_index=True, default=0)),
-                ("hashed", models.CharField(db_index=True, editable=False, max_length=40)),
+                (
+                    "hashed",
+                    models.CharField(db_index=True, editable=False, max_length=40),
+                ),
                 (
                     "content_object",
-                    models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="tests.Beverage"),
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="tests.Beverage",
+                    ),
                 ),
                 (
                     "user",

base/tests/migrations/0001_initial.py

@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("tests", "0001_initial"),
     ]
@@ -13,7 +12,15 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name="Fish",
             fields=[
-                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
                 ("name", models.CharField(max_length=255)),
                 ("price", models.IntegerField()),
             ],