Add docs and tests

Author: njooma

src/viam/media/video.py

@@ -1,7 +1,7 @@
 from array import array
 from typing import Any, List, Optional, Tuple
 
-from typing_extensions import Self, ClassVar
+from typing_extensions import ClassVar, Self
 
 from viam.errors import NotSupportedError
 from viam.proto.component.camera import Format
@@ -24,6 +24,12 @@ def __setattr__(cls, name: str, value: Any):
 
 
 class CameraMimeType(str, metaclass=_FrozenClassAttributesMeta):
+    """
+    The compatible mime-types for cameras and vision services.
+
+    You can use the `CameraMimeType.CUSTOM(...)` method to use an unlisted mime-type.
+    """
+
     VIAM_RGBA: ClassVar[Self]
     VIAM_RAW_DEPTH: ClassVar[Self]
     JPEG: ClassVar[Self]
@@ -82,7 +88,8 @@ def from_proto(cls, format: Format.ValueType) -> Self:
         }
         return cls(mimetypes.get(format, cls.JPEG))
 
-    def to_proto(self) -> Format.ValueType:
+    @property
+    def proto(self) -> Format.ValueType:
         """Returns the mimetype in a proto enum.
 
         Returns:
@@ -96,6 +103,12 @@ def to_proto(self) -> Format.ValueType:
         }
         return formats.get(self, Format.FORMAT_UNSPECIFIED)
 
+    def to_proto(self) -> Format.ValueType:
+        """
+        DEPRECATED: Use `CameraMimeType.proto`
+        """
+        return self.proto
+
 
 CameraMimeType.VIAM_RGBA = CameraMimeType.from_string("image/vnd.viam.rgba")
 CameraMimeType.VIAM_RAW_DEPTH = CameraMimeType.from_string("image/vnd.viam.dep")

src/viam/services/worldstatestore/__init__.py

@@ -1,9 +1,9 @@
+from viam.proto.service.worldstatestore import StreamTransformChangesResponse, TransformChangeType
 from viam.resource.registry import Registry, ResourceRegistration
 
 from .client import WorldStateStoreClient
 from .service import WorldStateStoreService
 from .worldstatestore import WorldStateStore
-from viam.proto.service.worldstatestore import StreamTransformChangesResponse, TransformChangeType
 
 __all__ = [
     "WorldStateStore",

tests/test_media.py

@@ -7,7 +7,7 @@
 
 from viam.errors import NotSupportedError
 from viam.media.utils.pil import pil_to_viam_image, viam_to_pil_image
-from viam.media.video import CameraMimeType, NamedImage, ViamImage
+from viam.media.video import CameraMimeType, Format, NamedImage, ViamImage
 
 
 class TestViamImage:
@@ -113,6 +113,52 @@ def test_value(self):
         mime_type = CameraMimeType.CUSTOM("SOME CUSTOM MIME TYPE")
         assert mime_type.value == "SOME CUSTOM MIME TYPE"
 
+    def test_from_proto(self):
+        format = Format.FORMAT_RAW_RGBA
+        mime_type = CameraMimeType.from_proto(format)
+        assert mime_type == CameraMimeType.VIAM_RGBA
+
+        format = Format.FORMAT_RAW_DEPTH
+        mime_type = CameraMimeType.from_proto(format)
+        assert mime_type == CameraMimeType.VIAM_RAW_DEPTH
+
+        format = Format.FORMAT_JPEG
+        mime_type = CameraMimeType.from_proto(format)
+        assert mime_type == CameraMimeType.JPEG
+
+        format = Format.FORMAT_PNG
+        mime_type = CameraMimeType.from_proto(format)
+        assert mime_type == CameraMimeType.PNG
+
+        format = Format.FORMAT_UNSPECIFIED
+        mime_type = CameraMimeType.from_proto(format)
+        assert mime_type == CameraMimeType.JPEG  # unspecified defaults to jpeg
+
+    def test_to_proto(self):
+        mime_type = CameraMimeType.VIAM_RGBA
+        format = mime_type.proto
+        assert format == Format.FORMAT_RAW_RGBA
+
+        mime_type = CameraMimeType.VIAM_RAW_DEPTH
+        format = mime_type.proto
+        assert format == Format.FORMAT_RAW_DEPTH
+
+        mime_type = CameraMimeType.JPEG
+        format = mime_type.proto
+        assert format == Format.FORMAT_JPEG
+
+        mime_type = CameraMimeType.PNG
+        format = mime_type.proto
+        assert format == Format.FORMAT_PNG
+
+        mime_type = CameraMimeType.PCD
+        format = mime_type.proto
+        assert format == Format.FORMAT_UNSPECIFIED
+
+        mime_type = CameraMimeType.CUSTOM("some custom mime")
+        format = mime_type.proto
+        assert format == Format.FORMAT_UNSPECIFIED
+
 
 def test_image_conversion():
     i = Image.new("RGBA", (100, 100), "#AABBCCDD")