Linewrap with pydocstringformatter

Author: adamtheturtle

pyproject.toml

@@ -346,6 +346,8 @@ typeCheckingMode = "strict"
 [tool.pydocstringformatter]
 write = true
 split-summary-body = false
+max-line-length = 79
+linewrap-full-docstring = true
 
 [tool.interrogate]
 fail-under = 100

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
 

src/vws/exceptions/custom_exceptions.py

@@ -1,6 +1,7 @@
 """
 Exceptions which do not map to errors at
-https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes
+https://developer.vuforia.com/library/web-api/cloud-targets-web-services-
+api#result-codes
 or simple errors given by the cloud recognition service.
 """
 
@@ -29,7 +30,9 @@ def response(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

src/vws/exceptions/vws_exceptions.py

@@ -1,7 +1,8 @@
 """
 Exception raised when Vuforia returns a response with a result code matching
 one of those documented at
-https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes.
+https://developer.vuforia.com/library/web-api/cloud-targets-web-services-
+api#result-codes.
 """
 
 import json
@@ -29,7 +30,9 @@ 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

tests/test_cloud_reco_exceptions.py

@@ -61,7 +61,9 @@ def test_image_too_large(
 
 
 def test_cloudrecoexception_inheritance() -> None:
-    """CloudRecoService-specific exceptions inherit from CloudRecoException."""
+    """CloudRecoService-specific exceptions inherit from
+    CloudRecoException.
+    """
     subclasses = [
         MaxNumResultsOutOfRangeError,
         InactiveProjectError,
@@ -77,7 +79,8 @@ def test_authentication_failure(
     high_quality_image: io.BytesIO,
 ) -> None:
     """
-    An ``AuthenticationFailure`` exception is raised when the client access key
+    An ``AuthenticationFailure`` exception is raised when the client access
+    key
     exists but the client secret key is incorrect.
     """
     database = VuforiaDatabase()

tests/test_query.py

@@ -48,7 +48,8 @@ class TestCustomBaseVWQURL:
     @staticmethod
     def test_custom_base_url(image: io.BytesIO | BinaryIO) -> None:
         """
-        It is possible to use query a target to a database under a custom VWQ
+        It is possible to use query a target to a database under a custom
+        VWQ
         URL.
         """
         base_vwq_url = "http://example.com"
@@ -190,7 +191,8 @@ def test_top(
         image: io.BytesIO | BinaryIO,
     ) -> None:
         """
-        When ``CloudRecoIncludeTargetData.TOP`` is given, target data is only
+        When ``CloudRecoIncludeTargetData.TOP`` is given, target data is
+        only
         returned in the top match.
         """
         target_id = vws_client.add_target(
@@ -224,7 +226,8 @@ def test_none(
         image: io.BytesIO | BinaryIO,
     ) -> None:
         """
-        When ``CloudRecoIncludeTargetData.NONE`` is given, target data is not
+        When ``CloudRecoIncludeTargetData.NONE`` is given, target data is
+        not
         returned in any match.
         """
         target_id = vws_client.add_target(

tests/test_vws.py

@@ -176,7 +176,9 @@ def test_get_target_summary_report(
         vws_client: VWS,
         image: io.BytesIO | BinaryIO,
     ) -> None:
-        """Details of a target are returned by ``get_target_summary_report``."""
+        """Details of a target are returned by
+        ``get_target_summary_report``.
+        """
         date = "2018-04-25"
         target_name = uuid.uuid4().hex
         with freeze_time(time_to_freeze=date):
@@ -224,7 +226,9 @@ class TestGetDatabaseSummaryReport:
 
     @staticmethod
     def test_get_target(vws_client: VWS) -> None:
-        """Details of a database are returned by ``get_database_summary_report``."""
+        """Details of a database are returned by
+        ``get_database_summary_report``.
+        """
         report = vws_client.get_database_summary_report()
 
         expected_report = DatabaseSummaryReport(
@@ -407,7 +411,9 @@ def test_default_seconds_between_requests(
     def test_custom_seconds_between_requests(
         image: io.BytesIO | BinaryIO,
     ) -> None:
-        """It is possible to customize the time waited between polling requests."""
+        """It is possible to customize the time waited between polling
+        requests.
+        """
         with MockVWS(processing_time_seconds=0.5) as mock:
             database = VuforiaDatabase()
             mock.add_database(database=database)

tests/test_vws_exceptions.py

@@ -40,7 +40,8 @@ def test_image_too_large(
     png_too_large: io.BytesIO | io.BufferedRandom,
 ) -> None:
     """
-    When giving an image which is too large, an ``ImageTooLarge`` exception is
+    When giving an image which is too large, an ``ImageTooLarge`` exception
+    is
     raised.
     """
     with pytest.raises(expected_exception=ImageTooLargeError) as exc:
@@ -69,7 +70,8 @@ def test_invalid_given_id(vws_client: VWS) -> None:
 
 def test_add_bad_name(vws_client: VWS, high_quality_image: io.BytesIO) -> None:
     """
-    When a name with a bad character is given, a ``ServerError`` exception is
+    When a name with a bad character is given, a ``ServerError`` exception
+    is
     raised.
     """
     max_char_value = 65535
@@ -96,7 +98,9 @@ def test_request_quota_reached() -> None:
 
 
 def test_fail(high_quality_image: io.BytesIO) -> None:
-    """A ``Fail`` exception is raised when the server access key does not exist."""
+    """A ``Fail`` exception is raised when the server access key does not
+    exist.
+    """
     with MockVWS():
         vws_client = VWS(
             server_access_key=uuid.uuid4().hex,
@@ -135,7 +139,8 @@ def test_target_name_exist(
     high_quality_image: io.BytesIO,
 ) -> None:
     """
-    A ``TargetNameExist`` exception is raised after adding two targets with the
+    A ``TargetNameExist`` exception is raised after adding two targets with
+    the
     same name.
     """
     vws_client.add_target(
@@ -162,7 +167,8 @@ def test_project_inactive(
     high_quality_image: io.BytesIO,
 ) -> None:
     """
-    A ``ProjectInactive`` exception is raised if adding a target to an inactive
+    A ``ProjectInactive`` exception is raised if adding a target to an
+    inactive
     database.
     """
     database = VuforiaDatabase(state=States.PROJECT_INACTIVE)
@@ -267,7 +273,8 @@ def test_authentication_failure(
     high_quality_image: io.BytesIO,
 ) -> None:
     """
-    An ``AuthenticationFailure`` exception is raised when the server access key
+    An ``AuthenticationFailure`` exception is raised when the server access
+    key
     exists but the server secret key is incorrect, or when a client key is
     incorrect.
     """