NS-193: Upgrade to Python 3.12

.env.example

@@ -23,4 +23,4 @@ SENTRY_TRACES_SAMPLE_RATE=0.1
 ALLOWED_HOSTS=*
 
 AUDIT_LOG_ENABLED=1
-AUDIT_LOG_STORE_OBJECT_STATE=old-and-new
+AUDIT_LOG_STORE_OBJECT_STATE=old-and-new

.github/dependabot.yml

@@ -8,5 +8,3 @@ updates:
       prefix: "deps"
     # Disable version updates and only allow security updates
     open-pull-requests-limit: 0
-      - "City-of-Helsinki/kuva-backend"
-      - "City-of-Helsinki/kuva-developers"

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     uses: City-of-Helsinki/.github/.github/workflows/ci-django-api.yml@main
     secrets: inherit
     with:
-      python-version: 3.11
       postgres-major-version: 13
+      python-version: 3.12
       extra-commands: |
         echo 'SECRET_KEY=topsecret123' >> .env

.gitignore

@@ -80,4 +80,4 @@ venv/
 .ruff_cache/
 docker-compose.env
 docker-compose.env.yaml
-.vscode/
+.vscode/

.pre-commit-config.yaml

@@ -1,27 +1,25 @@
-# Pre-commit hook documentation:
-# - https://pre-commit.com/
-# - https://pre-commit.com/hooks.html
-#
-# Ruff pre-commit hook documentation:
-# - https://github.com/astral-sh/ruff-pre-commit
+# Keep tool versions in sync with the versions in requirements-dev.txt
 default_language_version:
-  python: python3.11
+    python: python3
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit, manual]
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version
-    rev: v0.5.2
+    rev: v0.13.0
     hooks:
-      # Run the linter
+      # Run the linter.
       - id: ruff
-        args: [ --fix ]
-      # Run the formatter
+        args: [ "--fix" ]
+      # Run the formatter.
       - id: ruff-format
-  - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v3.4.0
-    hooks:
-      - id: conventional-pre-commit
-        stages: [commit-msg]
-        args: []
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
     rev: v9.22.0
     hooks:

Dockerfile

@@ -1,5 +1,5 @@
 # ==============================
-FROM registry.access.redhat.com/ubi9/python-311 AS appbase
+FROM registry.access.redhat.com/ubi9/python-312 AS appbase
 # ==============================
 
 USER root

README.md

@@ -90,7 +90,7 @@ These are the basic internal dependencies of the project. If you are running the
 
 ### Python
 
-Python 3.11 is the minimum version required. You can check your version by running `python --version`.
+Python 3.12 is the minimum version required. You can check your version by running `python --version`.
 
 If you encounter deprecation warnings on newer versions, you may need to downgrade to Python 3.11, but ideally fix the deprecation warnings and upgrade the container's python base version.
 
@@ -267,68 +267,43 @@ AUDIT_LOG = {
 
 ## Keeping Python requirements up to date
 
-1. Install `pip-tools`:
+1. Add new packages to `requirements.in` or `requirements-dev.in`
 
-   - `pip install pip-tools`
-
-2. Add new packages to `requirements.in` or `requirements-dev.in`
-
-3. Update `.txt` file for the changed requirements file:
+2. Update `.txt` file for the changed requirements file:
 
    - `pip-compile requirements.in`
    - `pip-compile requirements-dev.in`
 
-4. If you want to update dependencies to their newest versions, run:
+3. If you want to update dependencies to their newest versions, run:
 
    - `pip-compile --upgrade requirements.in`
 
-5. To install Python requirements run:
+4. To install Python requirements run:
 
    - `pip-sync requirements.txt`
 
-6. To install Python development requirements run:
+5. To install Python development requirements run:
 
    - `pip-sync requirements-dev.txt`
 
-7. To install Python production requirements run:
+6. To install Python production requirements run:
 
    - `pip-sync requirements.txt requirements-prod.txt`
 
-## Code formatting
-
-This project uses [`ruff`](https://docs.astral.sh/ruff/formatter/) for Python code formatting. Basic `ruff` commands:
-
-`ruff format` is the primary entrypoint to the formatter. It accepts a list of files or directories, and formats all discovered Python files:
+## Code format
 
-```
-
-ruff format # Format all files in the current directory.
-ruff format path/to/code/ # Format all files in `path/to/code` (and any subdirectories).
-ruff format path/to/file.py # Format a single file.
-
-```
+This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and quality checking.
 
-> Similar to Black, running ruff format /path/to/file.py will format the given file or directory in-place, while ruff format --check /path/to/file.py will avoid writing any formatted files back, and instead exit with a non-zero status code upon detecting any unformatted files.
-
-To run the Ruff Linter use `ruff check`.
-
-> `ruff check` is the primary entrypoint to the Ruff linter. It accepts a list of files or directories, and lints all discovered Python files, optionally fixing any fixable errors:
-
-```
-
-ruff check # Lint all files in the current directory.
-ruff check --fix # Lint all files in the current directory, and fix any fixable errors.
-ruff check --watch # Lint all files in the current directory, and re-lint on change.
-ruff check path/to/code/ # Lint all files in `path/to/code` (and any subdirectories).
-
-```
+Basic `ruff` commands:
 
-1. Install `pre-commit` (there are many ways to do but let's use pip as an example):
-   - `pip install pre-commit`
-2. Set up git hooks from `.pre-commit-config.yaml`, run this command from project root:
-   - `pre-commit install`
+* lint: `ruff check`
+* apply safe lint fixes: `ruff check --fix`
+* check formatting: `ruff format --check`
+* format: `ruff format`
 
-After that, formatting hooks will run against all changed files before committing
+[`pre-commit`](https://pre-commit.com/) can be used to install and
+run all the formatting tools as git hooks automatically before a
+commit.
 
 ## Releases, changelogs and deployments
 

api/tests/__snapshots__/test_api.ambr

@@ -0,0 +1,61 @@
+# serializer version: 1
+# name: test_get_delivery_log
+  dict({
+    'errors': list([
+    ]),
+    'messages': dict({
+      '+358461231231': dict({
+        'converted': '+358461231231',
+        'status': 'CREATED',
+      }),
+    }),
+    'warnings': list([
+    ]),
+  })
+# ---
+# name: test_send_sms
+  dict({
+    'errors': list([
+    ]),
+    'messages': dict({
+      '+358461231231': dict({
+        'converted': '+358461231231',
+        'status': 'CREATED',
+      }),
+    }),
+    'warnings': list([
+    ]),
+  })
+# ---
+# name: test_webhook_delivery_log
+  dict({
+    'errors': list([
+    ]),
+    'messages': dict({
+      '+358461231231': dict({
+        'converted': '+358461231231',
+        'status': 'CREATED',
+      }),
+    }),
+    'warnings': list([
+    ]),
+  })
+# ---
+# name: test_webhook_delivery_log.1
+  dict({
+    'errors': list([
+    ]),
+    'messages': dict({
+      '+358461231231': dict({
+        'billingref': 'Palvelutarjotin',
+        'destination': '+358461231231',
+        'sender': 'hel.fi',
+        'smscount': '1',
+        'status': 'DELIVERED',
+        'statustime': '2020-07-21T09:18:00Z',
+      }),
+    }),
+    'warnings': list([
+    ]),
+  })
+# ---

api/tests/test_api.py

@@ -13,7 +13,6 @@
 @pytest.fixture(autouse=True)
 def autouse_db(db):
     """Rename the db fixture"""
-    pass
 
 
 SMS_PAYLOAD: SendMessagePayload = {

api/tests/test_audit_log.py

@@ -161,9 +161,9 @@ def test_bulk_deleting_delivery_logs_writes_delete_log(admin_user):
     client = Client()
     client.force_login(admin_user)
 
-    COUNT = 3
+    count = 3
 
-    delivery_logs = DeliveryLogFactory.create_batch(COUNT)
+    delivery_logs = DeliveryLogFactory.create_batch(count)
     object_ids = [str(log.pk) for log in delivery_logs]
 
     # Get the URL for the changelist view
@@ -187,7 +187,7 @@ def test_bulk_deleting_delivery_logs_writes_delete_log(admin_user):
     audit_log_entry = qs.first()
 
     # Verify the audit log entry details
-    assert len(audit_log_entry.message["audit_event"]["target"]["object_ids"]) == COUNT
+    assert len(audit_log_entry.message["audit_event"]["target"]["object_ids"]) == count
     assert sorted(
         audit_log_entry.message["audit_event"]["target"]["object_ids"]
     ) == sorted(object_ids)

audit_log/exceptions.py

@@ -1,4 +1,2 @@
 class AuditLoggingDisabledError(Exception):
     """Raised when audit logging is disabled and an attempt is made to log an event."""
-
-    pass

common/tests/test_prune_django_admin_log.py

@@ -72,7 +72,7 @@ def test_valid_months(
     dry_run_msg = "Running in dry-run mode i.e. not committing changes!\n"
     del_msg = (
         f"Deleted {expected_deletion_count} Django admin logs "
-        f"created at least {5*12 if months is None else months} months ago"
+        f"created at least {5 * 12 if months is None else months} months ago"
     )
     assert captured.err == ""
     assert del_msg in captured.out

docs/development-without-docker.md

@@ -21,7 +21,7 @@ Please refer to the [main README](/README.md) for the latest instructions.
 ## Prerequisites
 
 - PostgreSQL 13
-- Python 3.11
+- Python 3.12
 - Keycloak
 
 ### Installing Python requirements

keycloak/realm.json

@@ -50,4 +50,4 @@
             ]
         }
     ]
-}
+}

openapi.yaml

@@ -181,4 +181,3 @@ components:
       in: header
       name: Authorization
       description: DRF TokenAuthentication. You need to generate an API token for each client.
-

pipelines/notification-service-api-review.yml

@@ -8,14 +8,14 @@
 trigger: none
 
 # Pull request (PR) triggers cause a pipeline to run whenever a pull request is
-# opened with one of the specified target branches, or when updates are made to 
+# opened with one of the specified target branches, or when updates are made to
 # such a pull request.
 #
-# GitHub creates a new ref when a pull request is created. The ref points to a 
-# merge commit, which is the merged code between the source and target branches 
+# GitHub creates a new ref when a pull request is created. The ref points to a
+# merge commit, which is the merged code between the source and target branches
 # of the pull request.
 #
-# Opt out of pull request validation 
+# Opt out of pull request validation
 pr:
   # PR target branch
   branches: