chore: use ruff pydocstyle instead of docformatter

Author: azmeuk

.pre-commit-config.yaml

@@ -15,10 +15,6 @@ repos:
       - id: end-of-file-fixer
         exclude: "\\.svg$|\\.map$|\\.min\\.css$|\\.min\\.js$|\\.po$|\\.pot$"
       - id: check-toml
-  - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.5
-    hooks:
-      - id: docformatter
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.11.2
     hooks:

pyproject.toml

@@ -81,6 +81,7 @@ exclude_lines = [
 
 [tool.ruff.lint]
 select = [
+    "D", # pydocstyle
     "E", # pycodestyle
     "F", # pyflakes
     "I", # isort
@@ -89,6 +90,16 @@ select = [
 ignore = [
     "E501", # line-too-long
     "E722", # bare-except
+    "D100", # public module
+    "D101", # public class
+    "D102", # public method
+    "D103", # public function
+    "D104", # public package
+    "D105", # magic method
+    "D106", # nested class
+    "D107", # public init
+    "D203", # no-blank-line-before-class
+    "D213", # multi-line-summary-second-line
 ]
 
 [tool.ruff.lint.isort]

scim2_cli/__init__.py

@@ -21,7 +21,6 @@
 @click.pass_context
 def cli(ctx, url):
     """SCIM application development CLI."""
-
     ctx.ensure_object(dict)
     ctx.obj["URL"] = url
     client = Client(base_url=ctx.obj["URL"])

scim2_cli/create.py

@@ -52,8 +52,7 @@ def create_factory(model):
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
     def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
-        """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
-        on resources endpoint.
+        r"""Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
 
@@ -74,8 +73,8 @@ def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
         .. code-block:: bash
 
             echo '{"userName": "[email protected]", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example create user
-        """
 
+        """
         if obj == model():
             obj = None
 
@@ -106,8 +105,7 @@ def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
     "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
 )
 def create_cli(ctx, indent, headers):
-    """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
-    on resources endpoint.
+    """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.
     See the attributes for :code:`user` with:
@@ -121,8 +119,8 @@ def create_cli(ctx, indent, headers):
     .. code-block:: bash
 
         echo '{"userName": "[email protected]", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example create
-    """
 
+    """
     if ctx.invoked_subcommand is not None:
         return
 

scim2_cli/delete.py

@@ -32,7 +32,6 @@ def delete_cli(ctx, resource_type, id, headers, indent):
 
         scim https://scim.example delete user 1234
     """
-
     try:
         resource_type = ctx.obj["resource_types"][resource_type]
     except KeyError:

scim2_cli/query.py

@@ -69,8 +69,7 @@ def query_cli(
     headers: list[str],
     indent: bool,
 ):
-    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request
-    on the :code:`RESOURCE_TYPE` endpoint.
+    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`RESOURCE_TYPE` endpoint.
 
     - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is `1234`, then the request will made on the :code:`/Users/1234` endpoint.
     - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is not set, then the request will made on the :code:`/Users` endpoint.
@@ -81,8 +80,8 @@ def query_cli(
     .. code-block:: bash
 
         echo '{"startIndex": 50, "count": 10}' | scim https://scim.example query user
-    """
 
+    """
     if resource_type:
         try:
             resource_type = ctx.obj["resource_types"][resource_type]

scim2_cli/replace.py

@@ -53,8 +53,7 @@ def replace_factory(model):
     @from_pydantic("obj", model, exclude=exclude)
     @click.pass_context
     def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
-        """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
-        on resources endpoint.
+        r"""Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request on resources endpoint.
 
         Input data can be passed through parameters like :code:`--external-id`.
 
@@ -76,8 +75,8 @@ def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
         .. code-block:: bash
 
             echo '{"id": "xxxx-yyyy", "userName": "[email protected]", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example replace user
-        """
 
+        """
         if obj == model():
             obj = None
 
@@ -108,8 +107,7 @@ def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
     help="Indent JSON response payloads.",
 )
 def replace_cli(ctx, headers, indent):
-    """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request
-    on the resources endpoint.
+    """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request on the resources endpoint.
 
     There are subcommands for all the available models, with dynamic attributes.
     See the attributes for :code:`user` with:

scim2_cli/search.py

@@ -65,16 +65,15 @@ def search_cli(
     headers: list[str],
     indent: bool,
 ):
-    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request
-    on the :code:`/.search` endpoint.
+    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request on the :code:`/.search` endpoint.
 
     Data passed in JSON format to stdin is sent as request arguments and all the other query arguments are ignored:
 
     .. code-block:: bash
 
         echo '{"startIndex": 50, "count": 10}' | scim https://scim.example search user
-    """
 
+    """
     if ctx.obj.get("stdin"):
         check_request_payload = False
         payload = ctx.obj.get("stdin")

scim2_cli/test.py

@@ -15,14 +15,12 @@
 )
 @click.option("-v", "--verbose", is_flag=True, help="Enables verbose mode")
 def test_cli(ctx, headers, verbose):
-    """Perform a server SCIM compliance check using :doc:`scim2-tester
-    <scim2-tester:index>`.
+    """Perform a server SCIM compliance check using :doc:`scim2-tester <scim2-tester:index>`.
 
     .. code-block:: bash
 
         scim https://scim.example test
     """
-
     client = ctx.obj["client"]
     client.client.headers.update(split_headers(headers))
     results = check_server(client)

scim2_cli/utils.py

@@ -35,10 +35,8 @@ def formatted_payload(obj, indent):
 def split_headers(headers: list[str]) -> dict[str, str]:
     """Make a dict from header strings.
 
-    ['Authorization: Bearer token'] → '{"Authorization": "Bearer
-    token"}'
+    ['Authorization: Bearer token'] → '{"Authorization": "Bearer token"}'
     """
-
     return {
         header[: header.index(":")].strip(): header[header.index(":") + 1 :].strip()
         for header in headers
@@ -67,9 +65,7 @@ def get_command(self, ctx, cmd_name):
 
 
 def is_field_acceptable(context, model, field_name) -> bool:
-    """Indicate whether a field is acceptable as part of a SCIM payload for a
-    given context."""
-
+    """Indicate whether a field is acceptable as part of a SCIM payload for a given context."""
     from scim2_models import Context
     from scim2_models import Mutability