Switch from pydocstringformatter

Author: adamtheturtle

conftest.py

@@ -1,4 +1,6 @@
-"""Setup for Sybil."""
+"""
+Setup for Sybil.
+"""
 
 import io
 import uuid
@@ -19,7 +21,9 @@
 
 
 def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
-    """Apply the beartype decorator to all collected test functions."""
+    """
+    Apply the beartype decorator to all collected test functions.
+    """
     for item in items:
         if isinstance(item, pytest.Function):
             item.obj = beartype(obj=item.obj)

docs/source/__init__.py

@@ -1 +1,3 @@
-"""Documentation."""
+"""
+Documentation.
+"""

docs/source/conf.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
-"""Configuration for Sphinx."""
+"""
+Configuration for Sphinx.
+"""
 
 import importlib.metadata
 from pathlib import Path

pyproject.toml

@@ -344,7 +344,7 @@ reportUnnecessaryTypeIgnoreComment = true
 typeCheckingMode = "strict"
 
 [tool.pydocstringformatter]
-write = true
+write = false
 split-summary-body = false
 beginning-quotes = false
 closing-quotes = false

src/vws/__init__.py

@@ -1,4 +1,6 @@
-"""A library for Vuforia Web Services."""
+"""
+A library for Vuforia Web Services.
+"""
 
 from .query import CloudRecoService
 from .vws import VWS

src/vws/exceptions/__init__.py

@@ -1 +1,3 @@
-"""Custom exceptions raised by this package."""
+"""
+Custom exceptions raised by this package.
+"""

src/vws/exceptions/base_exceptions.py

@@ -10,7 +10,9 @@
 
 @beartype
 class CloudRecoError(Exception):
-    """Base class for Vuforia Cloud Recognition Web API exceptions."""
+    """
+    Base class for Vuforia Cloud Recognition Web API exceptions.
+    """
 
     def __init__(self, response: Response) -> None:
         """
@@ -22,7 +24,9 @@ def __init__(self, response: Response) -> None:
 
     @property
     def response(self) -> Response:
-        """The response returned by Vuforia which included this error."""
+        """
+        The response returned by Vuforia which included this error.
+        """
         return self._response
 
 
@@ -44,5 +48,7 @@ def __init__(self, response: Response) -> None:
 
     @property
     def response(self) -> Response:
-        """The response returned by Vuforia which included this error."""
+        """
+        The response returned by Vuforia which included this error.
+        """
         return self._response

src/vws/exceptions/cloud_reco_exceptions.py

@@ -1,4 +1,6 @@
-"""Exceptions which match errors raised by the Vuforia Cloud Recognition Web APIs."""
+"""
+Exceptions which match errors raised by the Vuforia Cloud Recognition Web APIs.
+"""
 
 from beartype import beartype
 
@@ -15,27 +17,31 @@ class MaxNumResultsOutOfRangeError(CloudRecoError):
 
 @beartype
 class InactiveProjectError(CloudRecoError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'InactiveProject'.
     """
 
 
 @beartype
 class BadImageError(CloudRecoError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'BadImage'.
     """
 
 
 @beartype
 class AuthenticationFailureError(CloudRecoError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'AuthenticationFailure'.
     """
 
 
 @beartype
 class RequestTimeTooSkewedError(CloudRecoError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'RequestTimeTooSkewed'.
     """

src/vws/exceptions/custom_exceptions.py

@@ -11,7 +11,9 @@
 
 @beartype
 class RequestEntityTooLargeError(Exception):
-    """Exception raised when the given image is too large."""
+    """
+    Exception raised when the given image is too large.
+    """
 
     def __init__(self, response: Response) -> None:
         """
@@ -23,18 +25,24 @@ def __init__(self, response: Response) -> None:
 
     @property
     def response(self) -> Response:
-        """The response returned by Vuforia which included this error."""
+        """
+        The response returned by Vuforia which included this error.
+        """
         return self._response
 
 
 @beartype
 class TargetProcessingTimeoutError(Exception):
-    """Exception raised when waiting for a target to be processed times out."""
+    """
+    Exception raised when waiting for a target to be processed times out.
+    """
 
 
 @beartype
 class ServerError(Exception):  # pragma: no cover
-    """Exception raised when VWS returns a server error."""
+    """
+    Exception raised when VWS returns a server error.
+    """
 
     def __init__(self, response: Response) -> None:
         """
@@ -46,5 +54,7 @@ def __init__(self, response: Response) -> None:
 
     @property
     def response(self) -> Response:
-        """The response returned by Vuforia which included this error."""
+        """
+        The response returned by Vuforia which included this error.
+        """
         return self._response

src/vws/exceptions/vws_exceptions.py

@@ -14,13 +14,16 @@
 
 @beartype
 class UnknownTargetError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'UnknownTarget'.
     """
 
     @property
     def target_id(self) -> str:
-        """The unknown target ID."""
+        """
+        The unknown target ID.
+        """
         path = urlparse(url=self.response.url).path
         # Every HTTP path which can raise this error is in the format
         # `/something/{target_id}`.
@@ -29,40 +32,48 @@ def target_id(self) -> str:
 
 @beartype
 class FailError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code 'Fail'."""
+    """
+    Exception raised when Vuforia returns a response with a result code 'Fail'.
+    """
 
 
 @beartype
 class BadImageError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'BadImage'.
     """
 
 
 @beartype
 class AuthenticationFailureError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'AuthenticationFailure'.
     """
 
 
 # See https://github.com/VWS-Python/vws-python/issues/822.
 @beartype
 class RequestQuotaReachedError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'RequestQuotaReached'.
     """
 
 
 @beartype
 class TargetStatusProcessingError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'TargetStatusProcessing'.
     """
 
     @property
     def target_id(self) -> str:
-        """The processing target ID."""
+        """
+        The processing target ID.
+        """
         path = urlparse(url=self.response.url).path
         # Every HTTP path which can raise this error is in the format
         # `/something/{target_id}`.
@@ -72,86 +83,100 @@ def target_id(self) -> str:
 # This is not simulated by the mock.
 @beartype
 class DateRangeError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'DateRangeError'.
     """
 
 
 # This is not simulated by the mock.
 @beartype
 class TargetQuotaReachedError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'TargetQuotaReached'.
     """
 
 
 # This is not simulated by the mock.
 @beartype
 class ProjectSuspendedError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'ProjectSuspended'.
     """
 
 
 # This is not simulated by the mock.
 @beartype
 class ProjectHasNoAPIAccessError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'ProjectHasNoAPIAccess'.
     """
 
 
 @beartype
 class ProjectInactiveError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'ProjectInactive'.
     """
 
 
 @beartype
 class MetadataTooLargeError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'MetadataTooLarge'.
     """
 
 
 @beartype
 class RequestTimeTooSkewedError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'RequestTimeTooSkewed'.
     """
 
 
 @beartype
 class TargetNameExistError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'TargetNameExist'.
     """
 
     @property
     def target_name(self) -> str:
-        """The target name which already exists."""
+        """
+        The target name which already exists.
+        """
         response_body = self.response.request_body or b""
         request_json = json.loads(s=response_body)
         return str(object=request_json["name"])
 
 
 @beartype
 class ImageTooLargeError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'ImageTooLarge'.
     """
 
 
 @beartype
 class TargetStatusNotSuccessError(VWSError):
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'TargetStatusNotSuccess'.
     """
 
     @property
     def target_id(self) -> str:
-        """The unknown target ID."""
+        """
+        The unknown target ID.
+        """
         path = urlparse(url=self.response.url).path
         # Every HTTP path which can raise this error is in the format
         # `/something/{target_id}`.
@@ -160,6 +185,7 @@ def target_id(self) -> str:
 
 @beartype
 class TooManyRequestsError(VWSError):  # pragma: no cover
-    """Exception raised when Vuforia returns a response with a result code
+    """
+    Exception raised when Vuforia returns a response with a result code
     'TooManyRequests'.
     """