Merge pull request #396 from thenewboston-developers/367-migrate-to-ruff-for-formatting-and-linting

Ruff introduction

Author: dmugtasimov

.editorconfig

@@ -4,4 +4,4 @@ root = true
 charset = utf-8
 indent_size = 4
 indent_style = space
-max_line_length = 119
+max_line_length = 120

.flake8

@@ -1,29 +1,21 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
     hooks:
-      - id: isort
-        name: isort (python)
-  - repo: https://github.com/google/yapf
-    rev: v0.40.2
+      - id: check-toml
+        alias: common
+      - id: end-of-file-fixer
+        alias: common
+      - id: trailing-whitespace
+        alias: common
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.8
     hooks:
-      - id: yapf
-        additional_dependencies: [ toml ]
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.16.1'
-    hooks:
-      - id: mypy
-        additional_dependencies: [ types-requests, types-PyYAML, types-toml ]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-builtins
-          - flake8-coding
-          - flake8-isort
-          - flake8-polyfill
-          - flake8-quotes
+      - id: ruff
+        name: 'ruff fix imports'
+        args: ["--select", "I", "--fix"]
+      - id: ruff
+        name: 'ruff (standard)'
+      - id: ruff-format

.pre-commit-config.yaml

@@ -96,7 +96,7 @@ ssh ubuntu@thenewboston.network
 
 sudo vim /etc/thenewboston/.env
 ```
-   
+
 10. Install docker as described at https://docs.docker.com/engine/install/ on thenewboston.network
 11. Setup and check docker installation:
 
@@ -107,7 +107,7 @@ exit
 
 ssh ubuntu@thenewboston.network
 
-# Known working versions described in the comments below 
+# Known working versions described in the comments below
 docker --version # Docker version 26.0.1, build d260a54
 
 # (!!!) At least Docker Compose version v2.24.0 is required

DEPLOY.md

@@ -2,7 +2,7 @@
 
 **SECTIONS**
 1. [Initial Project Setup](#initial-project-setup)
-2. [Essential Developer Guidelines](#essential-developer-guidelines) 
+2. [Essential Developer Guidelines](#essential-developer-guidelines)
 
 
 # Initial Project Setup
@@ -37,7 +37,7 @@ cp thenewboston/project/settings/templates/settings.unittests.py ./local/setting
 
 5. Install / upgrade docker as described at https://docs.docker.com/engine/install/
 ```bash
-# Known working versions described in the comments below 
+# Known working versions described in the comments below
 
 docker --version # Docker version 26.0.1, build d260a54
 

README.md

@@ -46,10 +46,6 @@ pytest-parametrize-cases = "^0.1.2"
 pytest-asyncio = "^0.26.0"
 diff-cover = "^9.6.0"
 
-[tool.isort]
-line_length = 119
-multi_line_output = 5
-
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "thenewboston.project.settings"
 django_find_project = false
@@ -64,13 +60,41 @@ env = [
     "THENEWBOSTON_SETTING_SECRET_KEY = dummy",
 ]
 
-[tool.yapf]
-align_closing_bracket_with_visual_indent = true
-based_on_style = "google"
-coalesce_brackets = true
-column_limit = 119
-dedent_closing_brackets = true
+[tool.ruff]
+line-length = 120
+indent-width = 4
+target-version = "py313"
+include = ["*.py"]
+exclude = [
+    ".git",
+    ".mypy_cache",
+    "__pycache__",
+    "venv"
+]
+
+[tool.ruff.lint]
+# TODO(dmu) MEDIUM: Consider enabling all rules (`select = ["ALL"]`), but this will require
+#                   adding plenty of ignores manually
+ignore = ["A005", "D403", "F403", "F405"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 12
+
+[tool.ruff.lint.per-file-ignores]
+"thenewboston/project/settings/templates/settings.dev.py" = ["F821"]
+"thenewboston/project/settings/templates/settings.unittests.py" = ["F821"]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+relative-imports-order = "closest-to-furthest"
+known-first-party = ["app", "tests"]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
 
 [build-system]
 requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -8,7 +8,6 @@
 
 
 class LoginView(APIView):
-
     @staticmethod
     def post(request):
         serializer = LoginSerializer(data=request.data)

thenewboston/authentication/views/login.py

@@ -14,7 +14,8 @@ class Meta:
 
     def filter_no_wallet(self, queryset, name, value):
         if value and self.request.user.is_authenticated:
-            user_wallet_currencies = Wallet.objects.filter(owner=self.request.user
-                                                           ).values_list('currency_id', flat=True)
+            user_wallet_currencies = Wallet.objects.filter(owner=self.request.user).values_list(
+                'currency_id', flat=True
+            )
             return queryset.exclude(id__in=user_wallet_currencies)
         return queryset

thenewboston/currencies/filters/currency.py

@@ -6,7 +6,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies: List[Tuple[str, str]] = []

thenewboston/currencies/migrations/0001_initial.py

@@ -6,7 +6,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [