Merge pull request #747 from VWS-Python/exp2

Change target to remove unhashable type

Author: adamtheturtle

src/mock_vws/_flask_server/storage.py

@@ -5,7 +5,6 @@
 import base64
 import dataclasses
 import datetime
-import io
 import random
 from http import HTTPStatus
 from typing import List, Tuple
@@ -79,11 +78,10 @@ def create_target(database_name: str) -> Tuple[str, int]:
     ]
     image_base64 = request.json['image_base64']
     image_bytes = base64.b64decode(image_base64)
-    image = io.BytesIO(image_bytes)
     target = Target(
         name=request.json['name'],
         width=request.json['width'],
-        image=image,
+        image_value=image_bytes,
         active_flag=request.json['active_flag'],
         processing_time_seconds=request.json['processing_time_seconds'],
         application_metadata=request.json['application_metadata'],
@@ -138,11 +136,9 @@ def update_target(database_name: str, target_id: str) -> Tuple[str, int]:
         target.application_metadata,
     )
 
-    image_file = target.image
+    image_value = target.image_value
     if 'image' in request.json:
-        image = request.json['image']
-        decoded = base64.b64decode(image)
-        image_file = io.BytesIO(decoded)
+        image_value = base64.b64decode(request.json['image'])
 
     # In the real implementation, the tracking rating can stay the same.
     # However, for demonstration purposes, the tracking rating changes but
@@ -159,7 +155,7 @@ def update_target(database_name: str, target_id: str) -> Tuple[str, int]:
         width=width,
         active_flag=active_flag,
         application_metadata=application_metadata,
-        image=image_file,
+        image_value=image_value,
         processed_tracking_rating=processed_tracking_rating,
         last_modified_date=last_modified_date,
     )

src/mock_vws/_flask_server/vws.py

@@ -7,15 +7,13 @@
 
 import base64
 import email.utils
-import io
 import json
 import uuid
 from http import HTTPStatus
 from typing import Final, List, Set
 
 import requests
 from flask import Flask, Response, request
-from PIL import Image
 
 from mock_vws._constants import ResultCodes, TargetStatuses
 from mock_vws._database_matchers import get_database_matching_server_keys
@@ -118,14 +116,10 @@ def add_target() -> Response:
     if active_flag is None:
         active_flag = True
 
-    image = request_json['image']
-    decoded = base64.b64decode(image)
-    image_file = io.BytesIO(decoded)
-
     new_target = Target(
         name=name,
         width=request_json['width'],
-        image=image_file,
+        image_value=base64.b64decode(request_json['image']),
         active_flag=active_flag,
         processing_time_seconds=processing_time_seconds,
         application_metadata=request_json.get('application_metadata'),
@@ -380,7 +374,7 @@ def get_duplicates(target_id: str) -> Response:
     similar_targets: List[str] = [
         other.target_id
         for other in other_targets
-        if Image.open(other.image) == Image.open(target.image)
+        if other.image_value == target.image_value
         and TargetStatuses.FAILED.value not in (target.status, other.status)
         and TargetStatuses.PROCESSING.value != other.status
         and other.active_flag

src/mock_vws/_query_tools.py

@@ -30,19 +30,6 @@ class ActiveMatchingTargetsDeleteProcessing(Exception):
     """
 
 
-def _images_match(image: io.BytesIO, another_image: io.BytesIO) -> bool:
-    """
-    Given two images, return whether they are matching.
-
-    In the real Vuforia, this matching is fuzzy.
-    For now, we check exact byte matching.
-
-    See https://github.com/VWS-Python/vws-python-mock/issues/3 for changing
-    that.
-    """
-    return bool(image.getvalue() == another_image.getvalue())
-
-
 def get_query_match_response_text(
     request_headers: Dict[str, str],
     request_body: bytes,
@@ -90,9 +77,8 @@ def get_query_match_response_text(
     [include_target_data] = parsed.get('include_target_data', ['top'])
     include_target_data = include_target_data.lower()
 
-    [image_bytes] = parsed['image']
-    assert isinstance(image_bytes, bytes)
-    image = io.BytesIO(image_bytes)
+    [image_value] = parsed['image']
+    assert isinstance(image_value, bytes)
     gmt = ZoneInfo('GMT')
     now = datetime.datetime.now(tz=gmt)
 
@@ -117,7 +103,7 @@ def get_query_match_response_text(
     matching_targets = [
         target
         for target in database.targets
-        if _images_match(image=target.image, another_image=image)
+        if target.image_value == image_value
     ]
 
     not_deleted_matches = [

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -9,15 +9,13 @@
 import dataclasses
 import datetime
 import email.utils
-import io
 import random
 import uuid
 from http import HTTPStatus
 from typing import Any, Callable, Dict, List, Set, Tuple, Union
 
 import wrapt
 from backports.zoneinfo import ZoneInfo
-from PIL import Image
 from requests_mock import DELETE, GET, POST, PUT
 from requests_mock.request import _RequestObjectProxy
 from requests_mock.response import _Context
@@ -181,18 +179,12 @@ def add_target(
             False: False,
         }[given_active_flag]
 
-        image = request.json()['image']
-        decoded = base64.b64decode(image)
-        image_file = io.BytesIO(decoded)
-
-        name = request.json()['name']
-        width = request.json()['width']
         application_metadata = request.json().get('application_metadata')
 
         new_target = Target(
-            name=name,
-            width=width,
-            image=image_file,
+            name=request.json()['name'],
+            width=request.json()['width'],
+            image_value=base64.b64decode(request.json()['image']),
             active_flag=active_flag,
             processing_time_seconds=self._processing_time_seconds,
             application_metadata=application_metadata,
@@ -426,7 +418,7 @@ def get_duplicates(
         similar_targets: List[str] = [
             other.target_id
             for other in other_targets
-            if Image.open(other.image) == Image.open(target.image)
+            if other.image_value == target.image_value
             and TargetStatuses.FAILED.value
             not in (target.status, other.status)
             and TargetStatuses.PROCESSING.value != other.status
@@ -496,11 +488,9 @@ def update_target(
             target.application_metadata,
         )
 
-        image_file = target.image
+        image_value = target.image_value
         if 'image' in request.json():
-            image = request.json()['image']
-            decoded = base64.b64decode(image)
-            image_file = io.BytesIO(decoded)
+            image_value = base64.b64decode(request.json()['image'])
 
         if 'active_flag' in request.json() and active_flag is None:
             raise Fail(status_code=HTTPStatus.BAD_REQUEST)
@@ -526,7 +516,7 @@ def update_target(
             width=width,
             active_flag=active_flag,
             application_metadata=application_metadata,
-            image=image_file,
+            image_value=image_value,
             processed_tracking_rating=processed_tracking_rating,
             last_modified_date=last_modified_date,
         )

src/mock_vws/target.py

@@ -67,9 +67,7 @@ class Target:  # pylint: disable=too-many-instance-attributes
 
     active_flag: bool
     application_metadata: Optional[str]
-    # Comparison of io.BytesIO compares the object, not the file contents.
-    # data we care about, so we leave this.
-    image: io.BytesIO = field(compare=False)
+    image_value: bytes
     name: str
     processing_time_seconds: float
     width: float
@@ -95,7 +93,8 @@ def _post_processing_status(self) -> TargetStatuses:
         How VWS determines this is unknown, but it relates to how suitable the
         target is for detection.
         """
-        image = Image.open(self.image)
+        image_file = io.BytesIO(self.image_value)
+        image = Image.open(image_file)
         image_stat = ImageStat.Stat(image)
 
         average_std_dev = statistics.mean(image_stat.stddev)
@@ -171,9 +170,8 @@ def from_dict(cls, target_dict: TargetDict) -> Target:
         active_flag = target_dict['active_flag']
         width = target_dict['width']
         image_base64 = target_dict['image_base64']
+        image_value = base64.b64decode(image_base64)
         processed_tracking_rating = target_dict['processed_tracking_rating']
-        image_bytes = base64.b64decode(image_base64)
-        image = io.BytesIO(image_bytes)
         processing_time_seconds = target_dict['processing_time_seconds']
         application_metadata = target_dict['application_metadata']
         target_id = target_dict['target_id']
@@ -196,7 +194,7 @@ def from_dict(cls, target_dict: TargetDict) -> Target:
             name=name,
             active_flag=active_flag,
             width=width,
-            image=image,
+            image_value=image_value,
             processing_time_seconds=processing_time_seconds,
             application_metadata=application_metadata,
             delete_date=delete_date,
@@ -214,8 +212,7 @@ def to_dict(self) -> TargetDict:
         if self.delete_date:
             delete_date = datetime.datetime.isoformat(self.delete_date)
 
-        image_value = self.image.getvalue()
-        image_base64 = base64.encodebytes(image_value).decode()
+        image_base64 = base64.encodebytes(self.image_value).decode()
 
         return {
             'name': self.name,

tests/mock_vws/test_usage.py

@@ -539,7 +539,6 @@ def test_to_dict(self, high_quality_image: io.BytesIO) -> None:
         assert json.dumps(target_dict)
 
         new_target = Target.from_dict(target_dict=target_dict)
-        assert new_target.image.getvalue() == target.image.getvalue()
         assert new_target == target
 
     def test_to_dict_deleted(self, high_quality_image: io.BytesIO) -> None: