Merge pull request #27 from endlessm/python-3.11

Use Python 3.11

Author: wjt

.github/workflows/tests.yml

@@ -51,8 +51,10 @@ jobs:
           name: image
       - name: Load Docker Image
         run: docker load < docker-image.tar
-      - name: Lint and Type Checking
+      - name: Lint
         run: docker run --rm --entrypoint="" amp pipenv run lint
+      - name: Type Checking
+        run: docker run --rm --entrypoint="" amp pipenv run type-check
 
   push:
     name: Upload the Docker image to Docker Hub

CONTRIBUTING.md

@@ -28,8 +28,8 @@ fixing your issue as quickly as possible.
 
 The tools required to work on the Azafea metrics proxy are the following:
 
-*   Python >= 3.7, with Pip
-*   [pipenv](https://docs.pipenv.org/)
+*   Python >= 3.11, with Pip
+*   [Pipenv](https://docs.pipenv.org/) >= 2023.10.24
 
 Pipenv is not strictly mandatory to contribute to the Azafea metrics proxy, you
 can use any way you prefer to manage the dependencies. We do recommend using it
@@ -69,10 +69,11 @@ community.
 We also use type checking with [mypy](http://www.mypy-lang.org/), which
 prevents a lot of problems inherent to dynamically typed languages like Python.
 
-Both are run automatically with the following command:
+Both are run with the following commands:
 
 ```
 $ pipenv run lint
+$ pipenv run type-check
 ```
 
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.7-alpine
+FROM python:3.11-alpine
 
 RUN pip install --no-cache-dir pipenv template && \
     apk add --update --no-cache git build-base

Pipfile

@@ -1,21 +1,29 @@
+[pipenv]
+sort_pipfile = true
+
+[requires]
+python_version = "3.11"
+
 [dev-packages]
+flake8 = "*"
 flake8-bugbear = "*"
 freezegun = "*"
 mypy = ">=0.720"
 pytest = "*"
 pytest-aiohttp = "*"
+pytest-asyncio = "*"
 pytest-cov = "*"
-pytest-flake8 = "*"
-pytest-mypy = ">=0.3.3"
+types-toml = "*"
 
 [packages]
 aiohttp = ">= 3.5.0"
 aioredis = "~= 1.3"
-pydantic = ">= 1.1"
+pydantic = "~= 2.7"
 toml = "*"
 
 [scripts]
-lint = "py.test --flake8 --mypy -m 'flake8 or mypy'"
+lint = "flake8"
 proxy = "python -m azafea_metrics_proxy"
 test = "py.test --cov=azafea_metrics_proxy --cov-fail-under=99 --no-cov-on-fail -m 'not integration'"
 test-all = "py.test --cov=azafea_metrics_proxy --cov-fail-under=99 --no-cov-on-fail"
+type-check = "mypy"

Pipfile.lock

@@ -23,11 +23,11 @@
 import dataclasses
 import logging
 import os
-from typing import Any, Dict, List, MutableMapping
+from typing import Any, List, MutableMapping
 
-from pydantic.class_validators import validator
+from pydantic import field_validator, ValidationError
 from pydantic.dataclasses import dataclass
-from pydantic.error_wrappers import ValidationError
+from pydantic_core import ErrorDetails
 
 import toml
 
@@ -40,18 +40,32 @@
 
 
 class InvalidConfigurationError(Exception):
-    def __init__(self, errors: List[Dict[str, Any]]) -> None:
+    def __init__(self, errors: List[ErrorDetails]) -> None:
         self.errors = errors
 
     def __str__(self) -> str:
         msg = ['Invalid configuration:']
 
         for e in self.errors:
-            loc = e['loc']
-            msg.append(f"* {'.'.join(loc)}: {e['msg']}")
+            loc = self._loc_str(e)
+            msg.append(f"* {loc}: {e['msg']}")
 
         return '\n'.join(msg)
 
+    # The loc field in ErrorDetails is a tuple of strings and ints.
+    # https://docs.pydantic.dev/latest/errors/errors/#customize-error-messages
+    @staticmethod
+    def _loc_str(details: ErrorDetails) -> str:
+        path = ''
+        for i, element in enumerate(details['loc']):
+            if isinstance(element, str):
+                if i > 0:
+                    path += '.'
+                path += element
+            else:  # pragma: no cover (our config does not use lists)
+                path += f'[{element}]'
+        return path
+
 
 class NoSuchConfigurationError(AttributeError):
     pass
@@ -66,7 +80,7 @@ def __getattr__(self, name: str) -> Any:
 class Main(_Base):
     verbose: bool = False
 
-    @validator('verbose', pre=True)
+    @field_validator('verbose', mode='before')
     def verbose_is_boolean(cls, value: Any) -> bool:
         return is_boolean(value)
 
@@ -78,11 +92,11 @@ class Redis(_Base):
     password: str = DEFAULT_PASSWORD
     ssl: bool = False
 
-    @validator('host', pre=True)
+    @field_validator('host', mode='before')
     def host_is_non_empty_string(cls, value: Any) -> str:
         return is_non_empty_string(value)
 
-    @validator('port', pre=True)
+    @field_validator('port', mode='before')
     def port_is_strictly_positive_integer(cls, value: Any) -> int:
         return is_strictly_positive_integer(value)
 
@@ -92,7 +106,7 @@ class Config(_Base):
     main: Main = dataclasses.field(default_factory=Main)
     redis: Redis = dataclasses.field(default_factory=Redis)
 
-    def __post_init_post_parse__(self) -> None:
+    def __post_init__(self) -> None:
         self.warn_about_default_passwords()
 
     @classmethod

azafea_metrics_proxy/config/__init__.py

@@ -25,14 +25,14 @@
 
 def is_boolean(value: Any) -> bool:
     if not isinstance(value, bool):
-        raise TypeError(f'{value!r} is not a boolean')
+        raise ValueError(f'{value!r} is not a boolean')
 
     return value
 
 
 def is_non_empty_string(value: Any) -> str:
     if not isinstance(value, str):
-        raise TypeError(f'{value!r} is not a string')
+        raise ValueError(f'{value!r} is not a string')
 
     if not value:
         raise ValueError(f'{value!r} is empty')
@@ -42,7 +42,7 @@ def is_non_empty_string(value: Any) -> str:
 
 def is_strictly_positive_integer(value: Any) -> int:
     if type(value) is not int:
-        raise TypeError(f'{value!r} is not an integer')
+        raise ValueError(f'{value!r} is not an integer')
 
     if value < 1:
         raise ValueError(f'{value!r} is not a strictly positive integer')

azafea_metrics_proxy/config/_validators.py

@@ -28,11 +28,6 @@
 
 def pytest_collection_modifyitems(items):
     for item in items:
-        markers = [m for m in item.own_markers if m.name in ('flake8', 'mypy')]
-
-        if markers:
-            continue
-
         if item.nodeid.startswith('azafea_metrics_proxy/tests/integration/'):
             item.add_marker(pytest.mark.integration)
 

azafea_metrics_proxy/tests/conftest.py

@@ -16,8 +16,6 @@
 # along with azafea-metrics-proxy.  If not, see <http://www.gnu.org/licenses/>.
 
 
-from aioredis import Redis
-
 import pytest
 
 from azafea_metrics_proxy.app import get_app
@@ -28,7 +26,7 @@ async def app(make_config):
     config = make_config({})
 
     app = await get_app(config)
-    redis: Redis = app['redis']
+    redis = app['redis']
 
     async def clear_queues():
         queues = await redis.keys('*')

azafea_metrics_proxy/tests/integration/conftest.py

@@ -51,7 +51,10 @@ def test_print_invalid_config(capfd, make_config_file):
         azafea_metrics_proxy.cli.run_command('-c', str(config_file), 'print-config')
 
     capture = capfd.readouterr()
-    assert "Invalid configuration:\n* main.verbose: 'blah' is not a boolean" in capture.err
+    assert (
+        "Invalid configuration:\n"
+        "* main.verbose: Value error, 'blah' is not a boolean"
+    ) in capture.err
 
 
 def test_run(capfd, monkeypatch, make_config_file):
@@ -79,7 +82,10 @@ def test_run_invalid_config(capfd, make_config_file):
         azafea_metrics_proxy.cli.run_command('-c', str(config_file), 'run')
 
     capture = capfd.readouterr()
-    assert "Invalid configuration:\n* main.verbose: 'blah' is not a boolean" in capture.err
+    assert (
+        "Invalid configuration:\n"
+        "* main.verbose: Value error, 'blah' is not a boolean"
+    ) in capture.err
 
 
 def test_run_redis_invalid_host(capfd, make_config_file):