chore: add docformatter pre-commit

Author: azmeuk

.pre-commit-config.yaml

@@ -1,31 +1,32 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: fix-byte-order-marker
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-toml
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.284'
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
     hooks:
-      - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
+      - id: pyupgrade
+        args: ["--py38-plus"]
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.10.0
+    rev: v3.12.0
     hooks:
       - id: reorder-python-imports
         args: ["--application-directories", "canaille"]
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.1.9'
     hooks:
-      - id: pyupgrade
-        args: ["--py38-plus"]
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
     hooks:
-      - id: black
+      - id: docformatter
   - repo: https://github.com/rtts/djhtml
     rev: 3.0.6
     hooks:

pytest_iam/__init__.py

@@ -23,9 +23,7 @@
 
 
 class Server:
-    """
-    A proxy object that is returned by the pytest fixture.
-    """
+    """A proxy object that is returned by the pytest fixture."""
 
     #: The port on which the local http server listens
     port: int
@@ -50,14 +48,12 @@ def logged_user():
 
     @property
     def url(self) -> str:
-        """
-        The URL at which the IAM server is accessible.
-        """
+        """The URL at which the IAM server is accessible."""
         return f"http://localhost:{self.port}/"
 
     def random_user(self, **kwargs) -> User:
-        """
-        Generates a :class:`~canaille.core.models.User` with random values.
+        """Generates a :class:`~canaille.core.models.User` with random values.
+
         Any parameter will be used instead of a random value.
         """
         with self.app.app_context():
@@ -68,8 +64,8 @@ def random_user(self, **kwargs) -> User:
         return user
 
     def random_group(self, **kwargs) -> Group:
-        """
-        Generates a :class:`~canaille.core.models.Group` with random values.
+        """Generates a :class:`~canaille.core.models.Group` with random values.
+
         Any parameter will be used instead of a random value.
         """
         with self.app.app_context():
@@ -80,8 +76,9 @@ def random_group(self, **kwargs) -> Group:
         return group
 
     def random_token(self, subject, client, **kwargs) -> Token:
-        """
-        Generates a test :class:`~canaille.oidc.basemodels.Token` with random values.
+        """Generates a test :class:`~canaille.oidc.basemodels.Token` with
+        random values.
+
         Any parameter will be used instead of a random value.
         """
         with self.app.app_context():
@@ -104,15 +101,14 @@ def random_token(self, subject, client, **kwargs) -> Token:
         return token
 
     def login(self, user):
-        """
-        Opens a session for the user in the IAM session.
+        """Opens a session for the user in the IAM session.
+
         This allows to skip the connection screen.
         """
         self.logged_user = user
 
     def consent(self, user, client=None) -> Consent | List[Consent]:
-        """
-        Make a user consent to share data with OIDC clients.
+        """Make a user consent to share data with OIDC clients.
 
         :param client: If :const:`None`, all existing clients are consented.
         """
@@ -143,9 +139,8 @@ def consent(self, user, client=None) -> Consent | List[Consent]:
 
 @pytest.fixture(scope="session")
 def iam_configuration() -> Dict[str, Any]:
-    """
-    Fixture for editing the configuration of :meth:`~pytest_iam.iam_server`.
-    """
+    """Fixture for editing the configuration of
+    :meth:`~pytest_iam.iam_server`."""
 
     private_key, public_key = generate_keypair()
     return {
@@ -170,9 +165,8 @@ def iam_configuration() -> Dict[str, Any]:
 
 @pytest.fixture(scope="session")
 def iam_server(iam_configuration) -> Server:
-    """
-    Fixture that creates a Canaille server listening a random port in a thread.
-    """
+    """Fixture that creates a Canaille server listening a random port in a
+    thread."""
 
     port = portpicker.pick_unused_port()
     app = create_app(config=iam_configuration)