Accept all IO[bytes] as image type

Author: adamtheturtle

CHANGELOG.rst

@@ -4,8 +4,7 @@ Changelog
 Next
 ----
 
-2025.03.10.1
-------------
+* Be more flexible in the types of images accepted.
 
 2025.03.10
 ----------

src/vws/query.py

@@ -3,10 +3,9 @@
 """
 
 import datetime
-import io
 import json
 from http import HTTPMethod, HTTPStatus
-from typing import Any, BinaryIO
+from typing import IO, Any
 from urllib.parse import urljoin
 
 import requests
@@ -29,7 +28,7 @@
 from vws.reports import QueryResult, TargetData
 from vws.response import Response
 
-_ImageType = io.BytesIO | BinaryIO
+_ImageType = IO[bytes]
 
 
 @beartype

src/vws/vws.py

@@ -3,12 +3,11 @@
 """
 
 import base64
-import io
 import json
 import time
 from datetime import date
 from http import HTTPMethod, HTTPStatus
-from typing import BinaryIO
+from typing import IO
 from urllib.parse import urljoin
 
 import requests
@@ -47,7 +46,7 @@
 )
 from vws.response import Response
 
-_ImageType = io.BytesIO | BinaryIO
+_ImageType = IO[bytes]
 
 
 @beartype

tests/conftest.py

@@ -5,7 +5,7 @@
 import io
 from collections.abc import Generator
 from pathlib import Path
-from typing import BinaryIO, Literal
+from typing import IO, BinaryIO, Literal
 
 import pytest
 from mock_vws import MockVWS
@@ -70,7 +70,7 @@ def image(
     request: pytest.FixtureRequest,
     high_quality_image: io.BytesIO,
     image_file: BinaryIO,
-) -> io.BytesIO | BinaryIO:
+) -> IO[bytes]:
     """
     An image in any of the types that the API accepts.
     """

tests/test_query.py

@@ -2,9 +2,8 @@
 Tests for the ``CloudRecoService`` querying functionality.
 """
 
-import io
 import uuid
-from typing import BinaryIO
+from typing import IO
 
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
@@ -21,7 +20,7 @@ class TestQuery:
     @staticmethod
     def test_no_matches(
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         An empty list is returned if there are no matches.
@@ -33,7 +32,7 @@ def test_no_matches(
     def test_match(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         Details of matching targets are returned.
@@ -56,7 +55,7 @@ class TestCustomBaseVWQURL:
     """
 
     @staticmethod
-    def test_custom_base_url(image: io.BytesIO | BinaryIO) -> None:
+    def test_custom_base_url(image: IO[bytes]) -> None:
         """
         It is possible to use query a target to a database under a custom VWQ
         URL.
@@ -101,7 +100,7 @@ class TestMaxNumResults:
     def test_default(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         By default the maximum number of results is 1.
@@ -129,7 +128,7 @@ def test_default(
     def test_custom(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to set a custom ``max_num_results``.
@@ -175,7 +174,7 @@ class TestIncludeTargetData:
     def test_default(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         By default, target data is only returned in the top match.
@@ -207,7 +206,7 @@ def test_default(
     def test_top(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         When ``CloudRecoIncludeTargetData.TOP`` is given, target data is only
@@ -241,7 +240,7 @@ def test_top(
     def test_none(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         When ``CloudRecoIncludeTargetData.NONE`` is given, target data is not
@@ -275,7 +274,7 @@ def test_none(
     def test_all(
         vws_client: VWS,
         cloud_reco_client: CloudRecoService,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         When ``CloudRecoIncludeTargetData.ALL`` is given, target data is

tests/test_vws.py

@@ -7,7 +7,7 @@
 import io
 import secrets
 import uuid
-from typing import BinaryIO
+from typing import IO
 
 import pytest
 from freezegun import freeze_time
@@ -37,7 +37,7 @@ class TestAddTarget:
     @pytest.mark.parametrize(argnames="active_flag", argvalues=[True, False])
     def test_add_target(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
         application_metadata: bytes | None,
         cloud_reco_client: CloudRecoService,
         *,
@@ -81,7 +81,7 @@ def test_add_target(
     @staticmethod
     def test_add_two_targets(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """No exception is raised when adding two targets with different names.
 
@@ -103,7 +103,7 @@ class TestCustomBaseVWSURL:
     """
 
     @staticmethod
-    def test_custom_base_url(image: io.BytesIO | BinaryIO) -> None:
+    def test_custom_base_url(image: IO[bytes]) -> None:
         """
         It is possible to use add a target to a database under a custom VWS
         URL.
@@ -135,7 +135,7 @@ class TestListTargets:
     @staticmethod
     def test_list_targets(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to get a list of target IDs.
@@ -165,7 +165,7 @@ class TestDelete:
     @staticmethod
     def test_delete_target(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to delete a target.
@@ -192,7 +192,7 @@ class TestGetTargetSummaryReport:
     @staticmethod
     def test_get_target_summary_report(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         Details of a target are returned by ``get_target_summary_report``.
@@ -294,7 +294,7 @@ class TestGetTargetRecord:
     @staticmethod
     def test_get_target_record(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         Details of a target are returned by ``get_target_record``.
@@ -369,7 +369,7 @@ class TestWaitForTargetProcessed:
     @staticmethod
     def test_wait_for_target_processed(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to wait until a target is processed.
@@ -389,7 +389,7 @@ def test_wait_for_target_processed(
 
     @staticmethod
     def test_default_seconds_between_requests(
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         By default, 0.2 seconds are waited between polling requests.
@@ -441,7 +441,7 @@ def test_default_seconds_between_requests(
 
     @staticmethod
     def test_custom_seconds_between_requests(
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to customize the time waited between polling requests.
@@ -492,7 +492,7 @@ def test_custom_seconds_between_requests(
             assert report.request_usage == expected_requests
 
     @staticmethod
-    def test_custom_timeout(image: io.BytesIO | BinaryIO) -> None:
+    def test_custom_timeout(image: IO[bytes]) -> None:
         """
         It is possible to set a maximum timeout.
         """
@@ -538,7 +538,7 @@ class TestGetDuplicateTargets:
     @staticmethod
     def test_get_duplicate_targets(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to get the IDs of similar targets.
@@ -572,7 +572,7 @@ class TestUpdateTarget:
     @staticmethod
     def test_update_target(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
         different_high_quality_image: io.BytesIO,
         cloud_reco_client: CloudRecoService,
     ) -> None:
@@ -633,7 +633,7 @@ def test_update_target(
     @staticmethod
     def test_no_fields_given(
         vws_client: VWS,
-        image: io.BytesIO | BinaryIO,
+        image: IO[bytes],
     ) -> None:
         """
         It is possible to give no update fields.