Reinstate migration to the Ruff formatter

.devcontainer/devcontainer.json

@@ -10,18 +10,17 @@
 	"customizations": {
 		"vscode": {
 			"settings": {
+				"ruff.lint.ignore": ["F401"],
+				"ruff.lint.run": "onSave",
+				"ruff.organizeImports": false,
 				"[python]": {
-					"editor.formatOnSave": true
-				},
-				"python.formatting.blackPath": "/usr/local/bin/black",
-				"python.linting.enabled": true,
-				"python.linting.pylintEnabled": true,
-				"python.linting.pylintPath": "/usr/local/bin/pylint",
-				"python.pythonPath": "/usr/local/bin/python"
+					"editor.defaultFormatter": "charliermarsh.ruff"
+				}
 			},
 			"extensions": [
-				"bungcip.better-toml",
+				"tamasfe.even-better-toml",
 				"donjayamanne.python-extension-pack",
+				"-ms-python.autopep8",
 				"eamodio.gitlens",
 				"fill-labs.dependi",
 				"GitHub.copilot",
@@ -43,7 +42,8 @@
 				"visualstudioexptteam.vscodeintellicode",
 				"wenfangdu.jump",
 				"wholroyd.jinja",
-				"yzhang.markdown-all-in-one"
+				"yzhang.markdown-all-in-one",
+				"charliermarsh.ruff"
 			]
 		}
 	},

.devcontainer/scripts/notify-dev-entrypoint.sh

@@ -40,7 +40,7 @@ cd /workspace
 echo -e "fpath+=/.zfunc" >> ~/.zshrc
 echo -e "autoload -Uz compinit && compinit"
 
-pip install poetry==${POETRY_VERSION}
+pip install poetry=="${POETRY_VERSION}" poetry-plugin-sort
 export PATH=$PATH:/home/vscode/.local/bin/
 which poetry
 poetry --version
@@ -55,6 +55,9 @@ make generate-version-file
 # Install dependencies
 poetry install
 
+# Install pre-commit hooks
+poetry run pre-commit install
+
 # Upgrade schema of the notification_api database.
 poetry run flask db upgrade
 

.github/workflows/test.yaml

@@ -36,7 +36,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: Check poetry.lock aligns with pyproject.toml
       run: poetry check --lock
     - name: Install requirements

.gitignore

@@ -91,3 +91,5 @@ jinja_templates/
 cypress.env.json
 node_modules/
 tests_cypress/cypress/videos/
+
+.ruff_cache/

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.5.5
+  hooks:
+    # Run the linter
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter
+    - id: ruff-format

Makefile

@@ -37,10 +37,10 @@ clean:
 
 .PHONY: format
 format:
-	poetry run isort .
-	poetry run black --config pyproject.toml .
-	poetry run flake8 .
-	poetry run mypy .
+	ruff check --fix .
+	ruff check
+	ruff format .
+	mypy ./
 
 .PHONY: smoke-test
 smoke-test:

app/celery/scheduled_tasks.py

@@ -215,9 +215,9 @@ def replay_created_notifications():
 
         if len(notifications_to_resend) > 0:
             current_app.logger.info(
-                "Sending {} {} notifications "
-                "to the delivery queue because the notification "
-                "status was created.".format(len(notifications_to_resend), notification_type)
+                "Sending {} {} notifications " "to the delivery queue because the notification " "status was created.".format(
+                    len(notifications_to_resend), notification_type
+                )
             )
 
         for n in notifications_to_resend:

app/celery/tasks.py

@@ -635,9 +635,7 @@ def send_inbound_sms_to_service(self, inbound_sms_id, service_id):
             except self.MaxRetriesExceededError:
                 current_app.logger.error(
                     """Retry: send_inbound_sms_to_service has retried the max number of
-                     times for service: {} and  inbound_sms {}""".format(
-                        service_id, inbound_sms_id
-                    )
+                     times for service: {} and  inbound_sms {}""".format(service_id, inbound_sms_id)
                 )
 
 

app/encryption.py

@@ -37,7 +37,7 @@ def init_app(self, app: Any, secret_key: str | List[str], salt: str) -> None:
             salt (str): The salt to use for signing.
         """
         self.app = app
-        self.secret_key = cast(List[str], [secret_key] if type(secret_key) is str else secret_key)
+        self.secret_key = cast(List[str], [secret_key] if isinstance(secret_key, str) else secret_key)
         self.serializer = URLSafeSerializer(secret_key)
         self.salt = salt
 

app/service/callback_rest.py

@@ -165,8 +165,8 @@ def handle_sql_error(e, table_name):
         and hasattr(e.orig, "pgerror")
         and e.orig.pgerror
         and (
-            'insert or update on table "{0}" violates '
-            'foreign key constraint "{0}_service_id_fkey"'.format(table_name) in e.orig.pgerror
+            'insert or update on table "{0}" violates ' 'foreign key constraint "{0}_service_id_fkey"'.format(table_name)
+            in e.orig.pgerror
         )
     ):
         return jsonify(result="error", message="No result found"), 404

app/v2/notifications/post_notifications.py

@@ -23,7 +23,6 @@
     email_normal_publish,
     email_priority_publish,
     notify_celery,
-    redis_store,
     signer_notification,
     sms_bulk_publish,
     sms_normal_publish,
@@ -684,7 +683,7 @@ def get_reply_to_text(notification_type, form, template, form_field=None):
 
 
 def strip_keys_from_personalisation_if_send_attach(personalisation):
-    return {k: v for (k, v) in personalisation.items() if not (type(v) is dict and v.get("sending_method") == "attach")}
+    return {k: v for (k, v) in personalisation.items() if not (isinstance(v, dict) and v.get("sending_method") == "attach")}
 
 
 def check_for_csv_errors(recipient_csv, max_rows, remaining_daily_messages, remaining_annual_messages):

gunicorn_config.py

@@ -70,9 +70,7 @@ def worker_abort(worker):
 def on_exit(server):
     elapsed_time = time.time() - start_time
     server.log.info("Stopping Notifications API")
-    server.log.info(
-        "Total gunicorn API running time: {:.2f} seconds".format(elapsed_time)
-    )
+    server.log.info("Total gunicorn API running time: {:.2f} seconds".format(elapsed_time))
 
 
 def worker_int(worker):