vws-python 2023.12.26__tar.gz → 2024.2.4__tar.gz

{vws-python-2023.12.26 → vws-python-2024.2.4}/.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
@@ -55,4 +55,4 @@ jobs:
           pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests . --cov-report=xml
 
       - name: "Upload coverage to Codecov"
-        uses: "codecov/codecov-action@v3"
+        uses: "codecov/codecov-action@v4"

{vws-python-2023.12.26 → vws-python-2024.2.4}/.github/workflows/release.yml

@@ -9,6 +9,17 @@ jobs:
     name: Publish a release
     runs-on: ubuntu-latest
 
+    # Specifying an environment is strongly recommended by PyPI.
+    # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
+    environment: release
+
+    permissions:
+      # This is needed for PyPI publishing.
+      # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
+      id-token: write
+      # This is needed for https://github.com/stefanzweifel/git-auto-commit-action.
+      contents: write
+
     strategy:
       matrix:
         python-version: ["3.12"]
@@ -65,12 +76,13 @@ jobs:
         run: |
           # Checkout the latest tag - the one we just created.
           git fetch --tags
-          git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
+          git checkout "$(git describe --tags "$(git rev-list --tags --max-count=1)")"
           python -m pip install build
           python -m build --sdist --wheel --outdir dist/ .
 
+      # We use PyPI trusted publishing rather than a PyPI API token.
+      # See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1/?tab=readme-ov-file#trusted-publishing.
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
           verbose: true

{vws-python-2023.12.26 → vws-python-2024.2.4}/.github/workflows/windows-ci.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ~\AppData\Local\pip\Cache
           key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}

{vws-python-2023.12.26 → vws-python-2024.2.4}/.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "[python]": {
         "editor.codeActionsOnSave": {
-            "source.fixAll": true
+            "source.fixAll": "explicit"
         },
         "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnSave": true

{vws-python-2023.12.26 → vws-python-2024.2.4}/CHANGELOG.rst

@@ -4,6 +4,17 @@ Changelog
 Next
 ----
 
+2024.02.04
+------------
+
+* Return a new error (``vws.custom_exceptions.ServerError``) when the server returns a 5xx status code.
+
+2023.12.27
+------------
+
+* Breaking change: The ``vws.exceptions.cloud_reco_exceptions.UnknownVWSErrorPossiblyBadName`` is now ``vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName``.
+* ``vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName`` now has a ``response`` parameter and attribute.
+
 2023.12.26
 ------------
 

{vws-python-2023.12.26 → vws-python-2024.2.4}/Makefile

@@ -7,6 +7,7 @@ SPHINXOPTS := -W
 
 .PHONY: lint
 lint: \
+    actionlint \
     check-manifest \
     doc8 \
     linkcheck \

{vws-python-2023.12.26 → vws-python-2024.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vws-python
-Version: 2023.12.26
+Version: 2024.2.4
 Summary: Interact with the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License: The MIT License
@@ -40,34 +40,35 @@ Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: VWS-Auth-Tools
 Provides-Extra: dev
+Requires-Dist: actionlint-py==1.6.26.11; extra == "dev"
 Requires-Dist: check-manifest==0.49; extra == "dev"
 Requires-Dist: doc8==1.1.1; extra == "dev"
 Requires-Dist: dodgy==0.2.1; extra == "dev"
 Requires-Dist: freezegun==1.4.0; extra == "dev"
-Requires-Dist: furo==2023.9.10; extra == "dev"
+Requires-Dist: furo==2024.1.29; extra == "dev"
 Requires-Dist: mypy==1.8.0; extra == "dev"
-Requires-Dist: pdm==2.11.1; extra == "dev"
+Requires-Dist: pdm==2.12.3; extra == "dev"
 Requires-Dist: pip_check_reqs==2.5.3; extra == "dev"
 Requires-Dist: pydocstyle==6.3; extra == "dev"
 Requires-Dist: pyenchant==3.2.2; extra == "dev"
 Requires-Dist: Pygments==2.17.2; extra == "dev"
 Requires-Dist: pylint==3.0.3; extra == "dev"
-Requires-Dist: pyproject-fmt==1.5.3; extra == "dev"
-Requires-Dist: pyright==1.1.343; extra == "dev"
+Requires-Dist: pyproject-fmt==1.7.0; extra == "dev"
+Requires-Dist: pyright==1.1.349; extra == "dev"
 Requires-Dist: pyroma==4.2; extra == "dev"
-Requires-Dist: pytest==7.4.3; extra == "dev"
+Requires-Dist: pytest==8.0.0; extra == "dev"
 Requires-Dist: pytest-cov==4.1; extra == "dev"
 Requires-Dist: PyYAML==6.0.1; extra == "dev"
-Requires-Dist: ruff==0.1.9; extra == "dev"
+Requires-Dist: ruff==0.2.0; extra == "dev"
 Requires-Dist: Sphinx==7.2.6; extra == "dev"
-Requires-Dist: sphinx-autodoc-typehints==1.25.2; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints==1.25.3; extra == "dev"
 Requires-Dist: sphinx-prompt==1.8; extra == "dev"
 Requires-Dist: Sphinx-Substitution-Extensions==2022.2.16; extra == "dev"
 Requires-Dist: sphinxcontrib-spelling==8; extra == "dev"
-Requires-Dist: sybil==6.0.2; extra == "dev"
-Requires-Dist: types-requests==2.31.0.10; extra == "dev"
-Requires-Dist: vulture==2.10; extra == "dev"
-Requires-Dist: VWS-Python-Mock==2023.5.21; extra == "dev"
+Requires-Dist: sybil==6.0.3; extra == "dev"
+Requires-Dist: types-requests==2.31.0.20240125; extra == "dev"
+Requires-Dist: vulture==2.11; extra == "dev"
+Requires-Dist: VWS-Python-Mock==2024.1.21; extra == "dev"
 Requires-Dist: VWS-Test-Fixtures==2023.3.5; extra == "dev"
 
 |Build Status| |codecov| |PyPI| |Documentation Status|

{vws-python-2023.12.26 → vws-python-2024.2.4}/conftest.py

@@ -2,14 +2,14 @@
 
 from doctest import ELLIPSIS
 
-from sybil import Sybil  # pyright: ignore[reportMissingTypeStubs]
-from sybil.parsers.rest import (  # pyright: ignore[reportMissingTypeStubs]
+from sybil import Sybil
+from sybil.parsers.rest import (
     ClearNamespaceParser,
     DocTestParser,
     PythonCodeBlockParser,
 )
 
-pytest_collect_file = Sybil(  # pyright: ignore[reportUnknownVariableType]
+pytest_collect_file = Sybil(
     parsers=[
         ClearNamespaceParser(),
         DocTestParser(optionflags=ELLIPSIS),

{vws-python-2023.12.26 → vws-python-2024.2.4}/lint.mk

@@ -2,6 +2,10 @@
 
 SHELL := /bin/bash -euxo pipefail
 
+.PHONY: actionlint
+actionlint:
+	actionlint
+
 .PHONY: mypy
 mypy:
 	mypy .
@@ -54,11 +58,11 @@ linkcheck:
 
 .PHONY: pyproject-fmt
  pyproject-fmt:
-	pyproject-fmt --keep-full-version --check --indent=4 pyproject.toml
+	pyproject-fmt --check pyproject.toml
 
  .PHONY: fix-pyproject-fmt
  fix-pyproject-fmt:
-	pyproject-fmt --keep-full-version --indent=4 pyproject.toml
+	pyproject-fmt pyproject.toml
 
 .PHONY: spelling
 spelling:

{vws-python-2023.12.26 → vws-python-2024.2.4}/pyproject.toml

@@ -10,9 +10,28 @@
 
     # List of plugins (as comma separated values of python modules names) to load,
     # usually to register additional checkers.
+    # See https://chezsoi.org/lucas/blog/pylint-strict-base-configuration.html.
+    # We do not use the plugins:
+    # - pylint.extensions.code_style
+    # - pylint.extensions.magic_value
+    # - pylint.extensions.while_used
+    # as they seemed to get in the way.
     load-plugins = [
+        'pylint.extensions.bad_builtin',
+        'pylint.extensions.comparison_placement',
+        'pylint.extensions.consider_refactoring_into_while_condition',
         'pylint.extensions.docparams',
+        'pylint.extensions.dunder',
+        'pylint.extensions.eq_without_hash',
+        'pylint.extensions.for_any_all',
+        'pylint.extensions.mccabe',
         'pylint.extensions.no_self_use',
+        'pylint.extensions.overlapping_exceptions',
+        'pylint.extensions.private_import',
+        'pylint.extensions.redefined_loop_name',
+        'pylint.extensions.redefined_variable_type',
+        'pylint.extensions.set_membership',
+        'pylint.extensions.typing',
     ]
 
     # Allow loading of arbitrary C extensions. Extensions are imported into the
@@ -26,7 +45,11 @@
     # multiple time (only on the command line, not in the configuration file where
     # it should appear only once). See also the "--disable" option for examples.
     enable = [
+        'bad-inline-option',
+        'deprecated-pragma',
+        'file-ignored',
         'spelling',
+        'use-symbolic-message-instead',
         'useless-suppression',
     ]
 
@@ -89,7 +112,7 @@
 branch = true
 
 [tool.coverage.report]
-exclude_lines = ["pragma: no cover", "if TYPE_CHECKING:"]
+exclude_also = ["if TYPE_CHECKING:"]
 
 [tool.pytest.ini_options]
 
@@ -150,14 +173,18 @@ requires = [
 universal = true
 
 [tool.ruff]
-select = ["ALL"]
 line-length = 79
 
+[tool.ruff.lint]
+select = ["ALL"]
+
 ignore = [
     # We do not annotate the type of 'self'.
     "ANN101",
     # We are happy to manage our own "complexity".
     "C901",
+    # Ruff warns that this conflicts with the formatter.
+    "COM812",
     # Allow our chosen docstring line-style - no one-line summary.
     "D200",
     "D203",
@@ -170,6 +197,9 @@ ignore = [
     # docstrings.
     "D406",
     "D407",
+    "D413",
+    # Ruff warns that this conflicts with the formatter.
+    "ISC001",
     # We have an existing interface to support and so we do not want to change
     # exception names.
     "N818",
@@ -187,7 +217,7 @@ ignore = [
 # is sometimes annoyingly removed.
 unfixable = ["ERA001"]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/test_*.py" = [
     # Do not require tests to have a one-line summary.
     "D205",
@@ -223,34 +253,35 @@ dependencies = [
 ]
 [project.optional-dependencies]
 dev = [
+    "actionlint-py==1.6.26.11",
     "check-manifest==0.49",
     "doc8==1.1.1",
     "dodgy==0.2.1",
     "freezegun==1.4.0",
-    "furo==2023.9.10",
+    "furo==2024.1.29",
     "mypy==1.8.0",
-    "pdm==2.11.1",
+    "pdm==2.12.3",
     "pip_check_reqs==2.5.3",
     "pydocstyle==6.3",
     "pyenchant==3.2.2",
     "Pygments==2.17.2",
     "pylint==3.0.3",
-    "pyproject-fmt==1.5.3",
-    "pyright==1.1.343",
+    "pyproject-fmt==1.7.0",
+    "pyright==1.1.349",
     "pyroma==4.2",
-    "pytest==7.4.3",
+    "pytest==8.0.0",
     "pytest-cov==4.1",
     "PyYAML==6.0.1",
-    "ruff==0.1.9",
+    "ruff==0.2.0",
     "Sphinx==7.2.6",
-    "sphinx-autodoc-typehints==1.25.2",
+    "sphinx-autodoc-typehints==1.25.3",
     "sphinx-prompt==1.8",
     "Sphinx-Substitution-Extensions==2022.2.16",
     "sphinxcontrib-spelling==8",
-    "sybil==6.0.2",
-    "types-requests==2.31.0.10",
-    "vulture==2.10",
-    "VWS-Python-Mock==2023.5.21",
+    "sybil==6.0.3",
+    "types-requests==2.31.0.20240125",
+    "vulture==2.11",
+    "VWS-Python-Mock==2024.1.21",
     "VWS-Test-Fixtures==2023.3.5",
 ]
 [project.urls]
@@ -268,6 +299,11 @@ vws = ["py.typed"]
 
 [tool.setuptools_scm]
 
+[tool.pyproject-fmt]
+indent = 4
+keep_full_version = true
+
 [tool.pyright]
 
+reportUnnecessaryTypeIgnoreComment = true
 typeCheckingMode = "strict"

{vws-python-2023.12.26 → vws-python-2024.2.4}/spelling_private_dict.txt

@@ -22,7 +22,7 @@ TargetStatusProcessing
 TooManyRequests
 Ubuntu
 UnknownTarget
-UnknownVWSErrorPossiblyBadName
+OopsAnErrorOccurredPossiblyBadName
 admin
 api
 args

vws-python-2024.2.4/src/vws/exceptions/custom_exceptions.py

@@ -0,0 +1,87 @@
+"""
+Exceptions which do not map to errors at
+https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes
+or simple errors given by the cloud recognition service.
+"""
+
+
+from requests import Response
+
+
+class OopsAnErrorOccurredPossiblyBadName(Exception):
+    """
+    Exception raised when VWS returns an HTML page which says "Oops, an error
+    occurred".
+
+    This has been seen to happen when the given name includes a bad character.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response returned by Vuforia.
+        """
+        super().__init__(response.text)
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
+
+
+class RequestEntityTooLarge(Exception):
+    """
+    Exception raised when the given image is too large.
+    """
+
+
+class TargetProcessingTimeout(Exception):
+    """
+    Exception raised when waiting for a target to be processed times out.
+    """
+
+
+class ServerError(Exception):  # pragma: no cover
+    """
+    Exception raised when VWS returns a server error.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response returned by Vuforia.
+        """
+        super().__init__(response.text)
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response
+
+
+class TooManyRequests(Exception):  # pragma: no cover
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'TooManyRequests'.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response returned by Vuforia.
+        """
+        super().__init__(response.text)
+        self._response = response
+
+    @property
+    def response(self) -> Response:
+        """
+        The response returned by Vuforia which included this error.
+        """
+        return self._response

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws/exceptions/vws_exceptions.py

@@ -56,13 +56,6 @@ class RequestQuotaReached(VWSException):  # pragma: no cover
     """
 
 
-class TooManyRequests(VWSException):  # pragma: no cover
-    """
-    Exception raised when Vuforia returns a response with a result code
-    'TooManyRequests'.
-    """
-
-
 class TargetStatusProcessing(VWSException):
     """
     Exception raised when Vuforia returns a response with a result code

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws/query.py

@@ -22,6 +22,7 @@ from vws.exceptions.cloud_reco_exceptions import (
 )
 from vws.exceptions.custom_exceptions import (
     RequestEntityTooLarge,
+    ServerError,
 )
 from vws.include_target_data import CloudRecoIncludeTargetData
 from vws.reports import QueryResult, TargetData
@@ -94,6 +95,8 @@ class CloudRecoService:
                 file in the grayscale or RGB color space.
             ~vws.exceptions.custom_exceptions.RequestEntityTooLarge: The given
                 image is too large.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
 
         Returns:
             An ordered list of target details of matching targets.
@@ -145,6 +148,11 @@ class CloudRecoService:
         if "Integer out of range" in response.text:
             raise MaxNumResultsOutOfRange(response=response)
 
+        if (
+            response.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
+        ):  # pragma: no cover
+            raise ServerError(response=response)
+
         result_code = response.json()["result_code"]
         if result_code != "Success":
             exception = {

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws/vws.py

@@ -17,8 +17,10 @@ from requests import Response
 from vws_auth_tools import authorization_header, rfc_1123_date
 
 from vws.exceptions.custom_exceptions import (
+    OopsAnErrorOccurredPossiblyBadName,
+    ServerError,
     TargetProcessingTimeout,
-    UnknownVWSErrorPossiblyBadName,
+    TooManyRequests,
 )
 from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
@@ -36,7 +38,6 @@ from vws.exceptions.vws_exceptions import (
     TargetQuotaReached,
     TargetStatusNotSuccess,
     TargetStatusProcessing,
-    TooManyRequests,
     UnknownTarget,
 )
 from vws.reports import (
@@ -162,10 +163,14 @@ class VWS:
             The response to the request made by `requests`.
 
         Raises:
-            ~vws.exceptions.UnknownVWSErrorPossiblyBadName: Vuforia returns an
-                HTML page with the text "Oops, an error occurred". This has
+            ~vws.exceptions.OopsAnErrorOccurredPossiblyBadName: Vuforia returns
+                an HTML page with the text "Oops, an error occurred". This has
                 been seen to happen when the given name includes a bad
                 character.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
             json.decoder.JSONDecodeError: The server did not respond with valid
                 JSON. This may happen if the server address is not a valid
                 Vuforia server.
@@ -180,7 +185,7 @@ class VWS:
         )
 
         if "Oops, an error occurred" in response.text:
-            raise UnknownVWSErrorPossiblyBadName
+            raise OopsAnErrorOccurredPossiblyBadName(response=response)
 
         if (
             response.status_code == HTTPStatus.TOO_MANY_REQUESTS
@@ -188,6 +193,11 @@ class VWS:
             # The Vuforia API returns a 429 response with no JSON body.
             raise TooManyRequests(response=response)
 
+        if (
+            response.status_code >= HTTPStatus.INTERNAL_SERVER_ERROR
+        ):  # pragma: no cover
+            raise ServerError(response=response)
+
         result_code = response.json()["result_code"]
 
         if result_code == expected_result_code:
@@ -264,10 +274,14 @@ class VWS:
                 inactive.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
-            ~vws.exceptions.custom_exceptions.UnknownVWSErrorPossiblyBadName:
+            ~vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName:
                 Vuforia returns an HTML page with the text "Oops, an error
                 occurred". This has been seen to happen when the given name
                 includes a bad character.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         image_data = _get_image_data(image=image)
         image_data_encoded = base64.b64encode(image_data).decode("ascii")
@@ -314,6 +328,10 @@ class VWS:
                 does not match a target in the database.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         response = self._make_request(
             method="GET",
@@ -371,6 +389,10 @@ class VWS:
                 does not match a target in the database.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         start_time = time.monotonic()
         while True:
@@ -402,6 +424,10 @@ class VWS:
                 known database.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         response = self._make_request(
             method="GET",
@@ -435,6 +461,10 @@ class VWS:
                 does not match a target in the database.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         response = self._make_request(
             method="GET",
@@ -474,6 +504,10 @@ class VWS:
                 known database.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         response = self._make_request(
             method="GET",
@@ -520,6 +554,10 @@ class VWS:
                 target is in the processing state.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         self._make_request(
             method="DELETE",
@@ -553,6 +591,10 @@ class VWS:
                 inactive.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         response = self._make_request(
             method="GET",
@@ -612,6 +654,10 @@ class VWS:
                 inactive.
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
+            ~vws.exceptions.custom_exceptions.ServerError: There is an error
+                with Vuforia's servers.
+            ~vws.exceptions.custom_exceptions.TooManyRequests: Vuforia is rate
+                limiting access.
         """
         data: dict[str, str | bool | float | int] = {}
 

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vws-python
-Version: 2023.12.26
+Version: 2024.2.4
 Summary: Interact with the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License: The MIT License
@@ -40,34 +40,35 @@ Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: VWS-Auth-Tools
 Provides-Extra: dev
+Requires-Dist: actionlint-py==1.6.26.11; extra == "dev"
 Requires-Dist: check-manifest==0.49; extra == "dev"
 Requires-Dist: doc8==1.1.1; extra == "dev"
 Requires-Dist: dodgy==0.2.1; extra == "dev"
 Requires-Dist: freezegun==1.4.0; extra == "dev"
-Requires-Dist: furo==2023.9.10; extra == "dev"
+Requires-Dist: furo==2024.1.29; extra == "dev"
 Requires-Dist: mypy==1.8.0; extra == "dev"
-Requires-Dist: pdm==2.11.1; extra == "dev"
+Requires-Dist: pdm==2.12.3; extra == "dev"
 Requires-Dist: pip_check_reqs==2.5.3; extra == "dev"
 Requires-Dist: pydocstyle==6.3; extra == "dev"
 Requires-Dist: pyenchant==3.2.2; extra == "dev"
 Requires-Dist: Pygments==2.17.2; extra == "dev"
 Requires-Dist: pylint==3.0.3; extra == "dev"
-Requires-Dist: pyproject-fmt==1.5.3; extra == "dev"
-Requires-Dist: pyright==1.1.343; extra == "dev"
+Requires-Dist: pyproject-fmt==1.7.0; extra == "dev"
+Requires-Dist: pyright==1.1.349; extra == "dev"
 Requires-Dist: pyroma==4.2; extra == "dev"
-Requires-Dist: pytest==7.4.3; extra == "dev"
+Requires-Dist: pytest==8.0.0; extra == "dev"
 Requires-Dist: pytest-cov==4.1; extra == "dev"
 Requires-Dist: PyYAML==6.0.1; extra == "dev"
-Requires-Dist: ruff==0.1.9; extra == "dev"
+Requires-Dist: ruff==0.2.0; extra == "dev"
 Requires-Dist: Sphinx==7.2.6; extra == "dev"
-Requires-Dist: sphinx-autodoc-typehints==1.25.2; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints==1.25.3; extra == "dev"
 Requires-Dist: sphinx-prompt==1.8; extra == "dev"
 Requires-Dist: Sphinx-Substitution-Extensions==2022.2.16; extra == "dev"
 Requires-Dist: sphinxcontrib-spelling==8; extra == "dev"
-Requires-Dist: sybil==6.0.2; extra == "dev"
-Requires-Dist: types-requests==2.31.0.10; extra == "dev"
-Requires-Dist: vulture==2.10; extra == "dev"
-Requires-Dist: VWS-Python-Mock==2023.5.21; extra == "dev"
+Requires-Dist: sybil==6.0.3; extra == "dev"
+Requires-Dist: types-requests==2.31.0.20240125; extra == "dev"
+Requires-Dist: vulture==2.11; extra == "dev"
+Requires-Dist: VWS-Python-Mock==2024.1.21; extra == "dev"
 Requires-Dist: VWS-Test-Fixtures==2023.3.5; extra == "dev"
 
 |Build Status| |codecov| |PyPI| |Documentation Status|

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws_python.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@
 CHANGELOG.rst
 CODE_OF_CONDUCT.rst
 LICENSE
-MANIFEST.in
 Makefile
 README.rst
 codecov.yaml

{vws-python-2023.12.26 → vws-python-2024.2.4}/src/vws_python.egg-info/requires.txt

@@ -3,32 +3,33 @@ urllib3
 VWS-Auth-Tools
 
 [dev]
+actionlint-py==1.6.26.11
 check-manifest==0.49
 doc8==1.1.1
 dodgy==0.2.1
 freezegun==1.4.0
-furo==2023.9.10
+furo==2024.1.29
 mypy==1.8.0
-pdm==2.11.1
+pdm==2.12.3
 pip_check_reqs==2.5.3
 pydocstyle==6.3
 pyenchant==3.2.2
 Pygments==2.17.2
 pylint==3.0.3
-pyproject-fmt==1.5.3
-pyright==1.1.343
+pyproject-fmt==1.7.0
+pyright==1.1.349
 pyroma==4.2
-pytest==7.4.3
+pytest==8.0.0
 pytest-cov==4.1
 PyYAML==6.0.1
-ruff==0.1.9
+ruff==0.2.0
 Sphinx==7.2.6
-sphinx-autodoc-typehints==1.25.2
+sphinx-autodoc-typehints==1.25.3
 sphinx-prompt==1.8
 Sphinx-Substitution-Extensions==2022.2.16
 sphinxcontrib-spelling==8
-sybil==6.0.2
-types-requests==2.31.0.10
-vulture==2.10
-VWS-Python-Mock==2023.5.21
+sybil==6.0.3
+types-requests==2.31.0.20240125
+vulture==2.11
+VWS-Python-Mock==2024.1.21
 VWS-Test-Fixtures==2023.3.5

{vws-python-2023.12.26 → vws-python-2024.2.4}/tests/test_vws_exceptions.py

@@ -13,7 +13,7 @@ from mock_vws.database import VuforiaDatabase
 from mock_vws.states import States
 from vws import VWS
 from vws.exceptions.base_exceptions import VWSException
-from vws.exceptions.custom_exceptions import UnknownVWSErrorPossiblyBadName
+from vws.exceptions.custom_exceptions import OopsAnErrorOccurredPossiblyBadName
 from vws.exceptions.vws_exceptions import (
     AuthenticationFailure,
     BadImage,
@@ -69,11 +69,11 @@ 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, an
-    ``UnknownVWSErrorPossiblyBadName`` exception is raised.
+    ``OopsAnErrorOccurredPossiblyBadName`` exception is raised.
     """
     max_char_value = 65535
     bad_name = chr(max_char_value + 1)
-    with pytest.raises(UnknownVWSErrorPossiblyBadName):
+    with pytest.raises(OopsAnErrorOccurredPossiblyBadName) as exc:
         vws_client.add_target(
             name=bad_name,
             width=1,
@@ -82,6 +82,8 @@ def test_add_bad_name(vws_client: VWS, high_quality_image: io.BytesIO) -> None:
             application_metadata=None,
         )
 
+    assert exc.value.response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR
+
 
 def test_request_quota_reached() -> None:
     """

vws-python-2023.12.26/MANIFEST.in

@@ -1,2 +0,0 @@
-include src/vws/py.typed
-include pyproject.toml

vws-python-2023.12.26/src/vws/exceptions/custom_exceptions.py

@@ -1,26 +0,0 @@
-"""
-Exceptions which do not map to errors at
-https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes
-or simple errors given by the cloud recognition service.
-"""
-
-
-class UnknownVWSErrorPossiblyBadName(Exception):
-    """
-    Exception raised when VWS returns an HTML page which says "Oops, an error
-    occurred".
-
-    This has been seen to happen when the given name includes a bad character.
-    """
-
-
-class RequestEntityTooLarge(Exception):
-    """
-    Exception raised when the given image is too large.
-    """
-
-
-class TargetProcessingTimeout(Exception):
-    """
-    Exception raised when waiting for a target to be processed times out.
-    """