[pre-commit.ci lite] apply automatic fixes

Author: pre-commit-ci-lite[bot]

admin/__init__.py

@@ -1 +1,3 @@
-"""Admin tools."""
+"""
+Admin tools.
+"""

admin/create_secrets_files.py

@@ -1,5 +1,4 @@
-"""
-Create licenses and target databases for the tests to run against.
+"""Create licenses and target databases for the tests to run against.
 
 Usage:
 
@@ -11,7 +10,6 @@
     $ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
     # You may have to run this a few times, but it is idempotent.
     $ python admin/create_secrets_files.py
-
 """
 
 import datetime
@@ -27,7 +25,9 @@
 
 
 def main() -> None:
-    """Create secrets files."""
+    """
+    Create secrets files.
+    """
     email_address = os.environ["VWS_EMAIL_ADDRESS"]
     password = os.environ["VWS_PASSWORD"]
     new_secrets_dir = Path(os.environ["NEW_SECRETS_DIR"]).expanduser()

ci/__init__.py

@@ -1 +1,3 @@
-"""CI helpers."""
+"""
+CI helpers.
+"""

ci/test_custom_linters.py

@@ -91,8 +91,7 @@ def test_tests_collected_once(
     capsys: pytest.CaptureFixture[str],
     request: pytest.FixtureRequest,
 ) -> None:
-    """
-    Each test in the test suite is collected exactly once.
+    """Each test in the test suite is collected exactly once.
 
     This does not necessarily mean that they are run - they may be skipped.
     """

conftest.py

@@ -1,4 +1,6 @@
-"""Setup for Sybil."""
+"""
+Setup for Sybil.
+"""
 
 from doctest import ELLIPSIS
 
@@ -35,8 +37,7 @@ def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
 @beartype
 @pytest.hookimpl(optionalhook=True)
 def pytest_set_filtered_exceptions() -> tuple[type[Exception], ...]:
-    """
-    Return exceptions to retry on.
+    """Return exceptions to retry on.
 
     This is for ``pytest-retry``.
     The configuration for retries is in ``pyproject.toml``.

docs/source/__init__.py

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

src/mock_vws/_base64_decoding.py

@@ -11,8 +11,7 @@
 
 @beartype
 def decode_base64(encoded_data: str) -> bytes:
-    """
-    Decode base64 somewhat like Vuforia does.
+    """Decode base64 somewhat like Vuforia does.
 
     Raises:
         binascii.Error: Vuforia would consider this encoded data as an

src/mock_vws/_constants.py

@@ -9,8 +9,7 @@
 
 @beartype
 class ResultCodes(Enum):
-    """
-    Constants representing various VWS result codes.
+    """Constants representing various VWS result codes.
 
     See
     https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes.
@@ -44,8 +43,7 @@ class ResultCodes(Enum):
 
 @beartype
 class TargetStatuses(Enum):
-    """
-    Constants representing VWS target statuses.
+    """Constants representing VWS target statuses.
 
     See the 'status' field in
     https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record

src/mock_vws/_database_matchers.py

@@ -19,8 +19,7 @@ def get_database_matching_client_keys(
     request_path: str,
     databases: Iterable[VuforiaDatabase],
 ) -> VuforiaDatabase:
-    """
-    Return the first of the given databases which is being accessed by the
+    """Return the first of the given databases which is being accessed by the
     given client request.
 
     Args:
@@ -65,8 +64,7 @@ def get_database_matching_server_keys(
     request_path: str,
     databases: Iterable[VuforiaDatabase],
 ) -> VuforiaDatabase:
-    """
-    Return the first of the given databases which is being accessed by the
+    """Return the first of the given databases which is being accessed by the
     given server request.
 
     Args:

src/mock_vws/_flask_server/__init__.py

@@ -1 +1,3 @@
-"""Flask server for the mock Vuforia web service."""
+"""
+Flask server for the mock Vuforia web service.
+"""

src/mock_vws/_flask_server/target_manager.py

@@ -32,14 +32,18 @@
 
 @beartype
 class _TargetRaterChoice(StrEnum):
-    """Target rater choices."""
+    """
+    Target rater choices.
+    """
 
     BRISQUE = auto()
     PERFECT = auto()
     RANDOM = auto()
 
     def to_target_rater(self) -> TargetTrackingRater:
-        """Get the target rater."""
+        """
+        Get the target rater.
+        """
         match self:
             case self.BRISQUE:
                 return BrisqueTargetTrackingRater()
@@ -53,7 +57,9 @@ def to_target_rater(self) -> TargetTrackingRater:
 
 @beartype
 class TargetManagerSettings(BaseSettings):
-    """Settings for the Target Manager Flask app."""
+    """
+    Settings for the Target Manager Flask app.
+    """
 
     target_manager_host: str = ""
     target_rater: _TargetRaterChoice = _TargetRaterChoice.BRISQUE
@@ -65,8 +71,7 @@ class TargetManagerSettings(BaseSettings):
 )
 @beartype
 def delete_database(database_name: str) -> Response:
-    """
-    Delete a database.
+    """Delete a database.
 
     :status 200: The database has been deleted.
     """
@@ -99,32 +104,29 @@ def get_databases() -> Response:
 @TARGET_MANAGER_FLASK_APP.route("/databases", methods=[HTTPMethod.POST])
 @beartype
 def create_database() -> Response:
-    """
-    Create a new database.
-
-    :reqheader Content-Type: application/json
-    :resheader Content-Type: application/json
-
-    :reqjson string client_access_key: (Optional) The client access key for the
-      database.
-    :reqjson string client_secret_key: (Optional) The client secret key for the
-      database.
-    :reqjson string database_name: (Optional) The name of the database.
-    :reqjson string server_access_key: (Optional) The server access key for the
-      database.
-    :reqjson string server_secret_key: (Optional) The server secret key for the
-      database.
-    :reqjson string state_name: (Optional) The state of the database. This can
-     be "WORKING" or "PROJECT_INACTIVE". This defaults to "WORKING".
-
-    :resjson string client_access_key: The client access key for the database.
-    :resjson string client_secret_key: The client secret key for the database.
-    :resjson string database_name: The database name.
-    :resjson string server_access_key: The server access key for the database.
-    :resjson string server_secret_key: The server secret key for the database.
-    :resjson string state_name: The database state. This will be "WORKING" or
-      "PROJECT_INACTIVE".
-    :reqjsonarr targets: The targets in the database.
+    """Create a new database.
+
+    :reqheader Content-Type: application/json :resheader Content-Type:
+    application/json
+
+    :reqjson string client_access_key: (Optional) The client access key
+    for the   database. :reqjson string client_secret_key: (Optional)
+    The client secret key for the   database. :reqjson string
+    database_name: (Optional) The name of the database. :reqjson string
+    server_access_key: (Optional) The server access key for the
+    database. :reqjson string server_secret_key: (Optional) The server
+    secret key for the   database. :reqjson string state_name:
+    (Optional) The state of the database. This can  be "WORKING" or
+    "PROJECT_INACTIVE". This defaults to "WORKING".
+
+    :resjson string client_access_key: The client access key for the
+    database. :resjson string client_secret_key: The client secret key
+    for the database. :resjson string database_name: The database name.
+    :resjson string server_access_key: The server access key for the
+    database. :resjson string server_secret_key: The server secret key
+    for the database. :resjson string state_name: The database state.
+    This will be "WORKING" or   "PROJECT_INACTIVE". :reqjsonarr targets:
+    The targets in the database.
 
     :status 201: The database has been successfully created.
     """

src/mock_vws/_flask_server/vwq.py

@@ -1,5 +1,4 @@
-"""
-A fake implementation of the Vuforia Web Query API using Flask.
+"""A fake implementation of the Vuforia Web Query API using Flask.
 
 See
 https://developer.vuforia.com/library/web-api/vuforia-query-web-api
@@ -34,13 +33,17 @@
 
 @beartype
 class _ImageMatcherChoice(StrEnum):
-    """Image matcher choices."""
+    """
+    Image matcher choices.
+    """
 
     EXACT = auto()
     STRUCTURAL_SIMILARITY = auto()
 
     def to_image_matcher(self) -> ImageMatcher:
-        """Get the image matcher."""
+        """
+        Get the image matcher.
+        """
         match self:
             case self.EXACT:
                 return ExactMatcher()
@@ -52,7 +55,9 @@ def to_image_matcher(self) -> ImageMatcher:
 
 @beartype
 class VWQSettings(BaseSettings):
-    """Settings for the VWQ Flask app."""
+    """
+    Settings for the VWQ Flask app.
+    """
 
     vwq_host: str = ""
     target_manager_base_url: str
@@ -80,10 +85,9 @@ def get_all_databases() -> set[VuforiaDatabase]:
 @CLOUDRECO_FLASK_APP.before_request
 @beartype
 def set_terminate_wsgi_input() -> None:
-    """
-    We set ``wsgi.input_terminated`` to ``True`` when going through
-    ``requests`` in our tests, so that requests have the given
-    ``Content-Length`` headers and the given data in ``request.headers`` and
+    """We set ``wsgi.input_terminated`` to ``True`` when going through
+    ``requests`` in our tests, so that requests have the given ``Content-
+    Length`` headers and the given data in ``request.headers`` and
     ``request.data``.
 
     We do not set this at all when running an application as standalone.