Migrate to the Ruff formatter (#1846)

* Migrate to the Ruff formatter

* Update config.js

* Update notify-dev-entrypoint.sh

Unintended commit, brain was not working at 9PM 😅

* Add ruff dependency

- Moved Ruff configs to the bottom of pyproject.toml
- Remove deprecated vscode linter settings

* Format with Ruff

- Migrate extension better toml to even better toml due to deprecation

* Update poetry lock file

* Update run_tests.sh to use Ruff

* update lockfile

* formatting

* update lockfile

.devcontainer/devcontainer.json

@@ -11,9 +11,6 @@
 		"SHELL": "/bin/zsh"
 	},
 	"settings": {
-		"python.linting.enabled": true,
-		"python.linting.pylintEnabled": true,
-		"python.linting.pylintPath": "/usr/local/bin/pylint",
 		"python.pythonPath": "/usr/local/bin/python",
 	},
 	"extensions": [
@@ -27,7 +24,8 @@
 		"visualstudioexptteam.vscodeintellicode",
 		"yzhang.markdown-all-in-one",
 		"ms-ossdata.vscode-postgresql",
-		"bungcip.better-toml",
+		"tamasfe.even-better-toml",
+		"charliermarsh.ruff",
 	],
 	"features": {
 		"ghcr.io/devcontainers/features/node:1": {
@@ -39,4 +37,4 @@
 	],
 	"postCreateCommand": "notify-dev-entrypoint.sh",
 	"remoteUser": "vscode"
-}
+}

.devcontainer/scripts/installations.sh

@@ -17,7 +17,7 @@ echo -e "fpath+=/.zfunc" >> ~/.zshrc
 echo -e "autoload -Uz compinit && compinit"
 
 # Install Poetry
-pip install poetry==${POETRY_VERSION}
+pip install poetry==${POETRY_VERSION} poetry-plugin-sort
 echo "PATH=$PATH"
 #echo "/home/vscode/.local/bin/.."
 export PATH=$PATH:/home/vscode/.local/bin/

.github/workflows/test.yaml

@@ -24,7 +24,7 @@ jobs:
     - name: Install poetry
       env:
         POETRY_VERSION: "1.7.1"
-      run: pip install poetry==${POETRY_VERSION} && poetry --version
+      run: pip install poetry==${POETRY_VERSION} poetry-plugin-sort && poetry --version
     - name: Install requirements
       run: poetry install --with test
     - uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3.3.3

.gitignore

@@ -97,3 +97,4 @@ cypress*env*json*
 node_modules/
 tests_cypress/cypress/videos/
 tests_cypress/cypress/screenshots/
+.ruff_cache/

Makefile

@@ -57,10 +57,8 @@ run-dev:
 
 .PHONY: format
 format:
-	isort ./app ./tests
-	black ./app ./tests
-	flake8 ./app ./tests
-	isort --check-only ./app ./tests
+	ruff check --select I --fix .
+	ruff format .
 	mypy ./
 	npx prettier --write app/assets/javascripts app/assets/stylesheets tests_cypress/cypress/e2e
 

app/__init__.py

@@ -365,14 +365,10 @@ def get_human_day(time):
 
 
 def format_time(date):
-    return (
-        {"12:00AM": "Midnight", "12:00PM": "Midday"}
-        .get(
-            utc_string_to_aware_gmt_datetime(date).strftime("%-I:%M%p"),
-            utc_string_to_aware_gmt_datetime(date).strftime("%-I:%M%p"),
-        )
-        .lower()
-    )
+    return {"12:00AM": "Midnight", "12:00PM": "Midday"}.get(
+        utc_string_to_aware_gmt_datetime(date).strftime("%-I:%M%p"),
+        utc_string_to_aware_gmt_datetime(date).strftime("%-I:%M%p"),
+    ).lower()
 
 
 def format_date(date):
@@ -450,9 +446,7 @@ def _getStatusByBounceSubtype():
                     "suppressed": _("Blocked"),
                     "on-account-suppression-list": _("Blocked"),
                 },
-            }[
-                template_type
-            ].get(feedback_subtype, _("No such address"))
+            }[template_type].get(feedback_subtype, _("No such address"))
         else:
             return _("No such address")
 
@@ -510,40 +504,36 @@ def format_notification_status_as_time(status, created, updated):
 
 
 def format_notification_status_as_field_status(status, notification_type):
-    return (
-        {
-            "letter": {
-                "failed": "error",
-                "technical-failure": "error",
-                "temporary-failure": "error",
-                "permanent-failure": "error",
-                "delivered": None,
-                "sent": None,
-                "sending": None,
-                "created": None,
-                "accepted": None,
-                "pending-virus-check": None,
-                "virus-scan-failed": "error",
-                "returned-letter": None,
-                "cancelled": "error",
-            }
+    return {
+        "letter": {
+            "failed": "error",
+            "technical-failure": "error",
+            "temporary-failure": "error",
+            "permanent-failure": "error",
+            "delivered": None,
+            "sent": None,
+            "sending": None,
+            "created": None,
+            "accepted": None,
+            "pending-virus-check": None,
+            "virus-scan-failed": "error",
+            "returned-letter": None,
+            "cancelled": "error",
         }
-        .get(
-            notification_type,
-            {
-                "failed": "error",
-                "technical-failure": "error",
-                "temporary-failure": "error",
-                "permanent-failure": "error",
-                "delivered": None,
-                "sent": None,
-                "sending": "default",
-                "created": "default",
-                "pending": "default",
-            },
-        )
-        .get(status, "error")
-    )
+    }.get(
+        notification_type,
+        {
+            "failed": "error",
+            "technical-failure": "error",
+            "temporary-failure": "error",
+            "permanent-failure": "error",
+            "delivered": None,
+            "sent": None,
+            "sending": "default",
+            "created": "default",
+            "pending": "default",
+        },
+    ).get(status, "error")
 
 
 def format_notification_status_as_url(status, notification_type):

app/main/forms.py

@@ -20,9 +20,6 @@
     HiddenField,
     IntegerField,
     PasswordField,
-)
-from wtforms import RadioField as WTFormsRadioField
-from wtforms import (
     SelectField,
     SelectMultipleField,
     StringField,
@@ -31,6 +28,7 @@
     validators,
     widgets,
 )
+from wtforms import RadioField as WTFormsRadioField
 from wtforms.fields import EmailField, SearchField, TelField
 from wtforms.validators import (
     URL,

app/main/views/templates.py

@@ -34,23 +34,19 @@
 )
 from app.extensions import redis_client
 from app.main import main
-from app.main.forms import (
-    EmailTemplateForm,  # remove when FF_TEMPLATE_CATEGORY is removed
-)
-from app.main.forms import (
-    SMSTemplateForm,  # remove when FF_TEMPLATE_CATEGORY is removed
-)
 from app.main.forms import (
     TC_PRIORITY_VALUE,
     AddEmailRecipientsForm,
     AddSMSRecipientsForm,
     CreateTemplateForm,
+    EmailTemplateForm,  # remove when FF_TEMPLATE_CATEGORY is removed
     EmailTemplateFormWithCategory,
     LetterTemplateForm,
     LetterTemplateFormWithCategory,
     LetterTemplatePostageForm,
     SearchByNameForm,
     SetTemplateSenderForm,
+    SMSTemplateForm,  # remove when FF_TEMPLATE_CATEGORY is removed
     SMSTemplateFormWithCategory,
     TemplateAndFoldersSelectionForm,
     TemplateCategoryForm,

application.py

@@ -5,7 +5,6 @@
 from aws_xray_sdk.ext.flask.middleware import XRayMiddleware
 from dotenv import load_dotenv
 from flask import Flask
-
 from werkzeug.middleware.proxy_fix import ProxyFix
 
 from app import create_app

config/mixpanel.py

@@ -7,7 +7,6 @@
 
 
 class NotifyMixpanel:
-
     enabled = False
 
     def __init__(self) -> None:

gunicorn_config.py

@@ -3,13 +3,12 @@
 import traceback
 
 import gunicorn  # type: ignore
-
 import newrelic.agent  # See https://bit.ly/2xBVKBH
 
 newrelic.agent.initialize()  # noqa: E402
 
 # Guincorn sets the server type on our app. We don't want to show it in the header in the response.
-gunicorn.SERVER = 'Undisclosed'
+gunicorn.SERVER = "Undisclosed"
 
 workers = 5
 worker_class = "gevent"