Ditch named tuples for dataclasses.
[python_utils.git] / camera_utils.py
index c789ed61e19d304391c9d10393bcb22094b0b7d7..99ccdb32a5e949e7edd1b6ce89e866b6b6c63119 100644 (file)
@@ -6,7 +6,8 @@ import logging
 import platform
 import subprocess
 import warnings
-from typing import NamedTuple, Optional
+from dataclasses import dataclass
+from typing import Optional
 
 import cv2  # type: ignore
 import numpy as np
@@ -18,19 +19,21 @@ import exceptions
 logger = logging.getLogger(__name__)
 
 
-class RawJpgHsv(NamedTuple):
+@dataclass
+class RawJpgHsv:
     """Raw image bytes, the jpeg image and the HSV (hue saturation value) image."""
 
-    raw: Optional[bytes]
-    jpg: Optional[np.ndarray]
-    hsv: Optional[np.ndarray]
+    raw: Optional[bytes] = None
+    jpg: Optional[np.ndarray] = None
+    hsv: Optional[np.ndarray] = None
 
 
-class SanityCheckImageMetadata(NamedTuple):
+@dataclass
+class SanityCheckImageMetadata:
     """Is a Blue Iris image bad (big grey borders around it) or infrared?"""
 
-    is_bad_image: bool
-    is_infrared_image: bool
+    is_bad_image: bool = False
+    is_infrared_image: bool = False
 
 
 def sanity_check_image(hsv: np.ndarray) -> SanityCheckImageMetadata:
@@ -76,20 +79,26 @@ def fetch_camera_image_from_video_server(
             tmp = np.frombuffer(raw, dtype="uint8")
             logger.debug(
                 'Translated raw content into %s %s with element type %s',
-                tmp.shape, type(tmp), type(tmp[0]),
+                tmp.shape,
+                type(tmp),
+                type(tmp[0]),
             )
             jpg = cv2.imdecode(tmp, cv2.IMREAD_COLOR)
             logger.debug(
                 'Decoded into %s jpeg %s with element type %s',
-                jpg.shape, type(jpg), type(jpg[0][0])
+                jpg.shape,
+                type(jpg),
+                type(jpg[0][0]),
             )
             hsv = cv2.cvtColor(jpg, cv2.COLOR_BGR2HSV)
             logger.debug(
                 'Converted JPG into %s HSV HSV %s with element type %s',
-                hsv.shape, type(hsv), type(hsv[0][0])
+                hsv.shape,
+                type(hsv),
+                type(hsv[0][0]),
             )
-            (_, is_bad_image) = sanity_check_image(hsv)
-            if not is_bad_image:
+            ret = sanity_check_image(hsv)
+            if not ret.is_bad_image:
                 return raw
     except Exception as e:
         logger.exception(e)