[DATA-665] Change getImage default to empty (#181)

Author: kharijarrett

docs/examples/example.ipynb

@@ -161,7 +161,7 @@
     "\n",
     "robot = await connect_with_channel()\n",
     "camera = Camera.from_robot(robot, \"camera0\")\n",
-    "image = await camera.get_image()\n",
+    "image = await camera.get_image(CameraMimeType.JPEG)\n",
     "image.save(\"foo.png\")\n",
     "\n",
     "# Don't forget to close the robot when you're done!\n",

examples/server/v1/components.py

@@ -33,7 +33,6 @@
 from viam.errors import ComponentNotFoundError
 from viam.media import MediaStreamWithIterator
 from viam.media.audio import Audio, AudioStream
-from viam.media.video import CameraMimeType
 from viam.operations import run_with_operation
 from viam.proto.common import (
     AnalogStatus,
@@ -318,7 +317,7 @@ def __init__(self, name: str):
     def __del__(self):
         self.image.close()
 
-    async def get_image(self, mime_type: str = CameraMimeType.PNG, **kwargs) -> Image.Image:
+    async def get_image(self, mime_type: str = "", **kwargs) -> Image.Image:
         return self.image.copy()
 
     async def get_point_cloud(self, **kwargs) -> Tuple[bytes, str]:

src/viam/components/camera/camera.py

@@ -3,7 +3,7 @@
 
 from PIL.Image import Image
 
-from viam.media.video import CameraMimeType, RawImage
+from viam.media.video import RawImage
 from viam.proto.component.camera import DistortionParameters, IntrinsicParameters
 
 from ..component_base import ComponentBase
@@ -31,7 +31,7 @@ class Properties(NamedTuple):
         """The distortion parameters of the camera"""
 
     @abc.abstractmethod
-    async def get_image(self, mime_type: str = CameraMimeType.PNG, *, timeout: Optional[float] = None, **kwargs) -> Union[Image, RawImage]:
+    async def get_image(self, mime_type: str = "", *, timeout: Optional[float] = None, **kwargs) -> Union[Image, RawImage]:
         """Get the next image from the camera as an Image or RawImage.
         Be sure to close the image when finished.
 

src/viam/components/camera/client.py

@@ -29,7 +29,7 @@ def __init__(self, name: str, channel: Channel):
         self.client = CameraServiceStub(channel)
         super().__init__(name)
 
-    async def get_image(self, mime_type: str = CameraMimeType.PNG, *, timeout: Optional[float] = None) -> Union[Image.Image, RawImage]:
+    async def get_image(self, mime_type: str = "", *, timeout: Optional[float] = None) -> Union[Image.Image, RawImage]:
         request = GetImageRequest(name=self.name, mime_type=mime_type)
         response: GetImageResponse = await self.client.GetImage(request, timeout=timeout)
         _, is_lazy = CameraMimeType.from_lazy(request.mime_type)

tests/mocks/components.py

@@ -366,7 +366,7 @@ def __init__(self, name: str):
         super().__init__(name)
 
     async def get_image(
-        self, mime_type: str = CameraMimeType.PNG, timeout: Optional[float] = None, **kwargs
+        self, mime_type: str = "", timeout: Optional[float] = None, **kwargs
     ) -> Union[Image.Image, RawImage]:
         self.timeout = timeout
         mime_type, is_lazy = CameraMimeType.from_lazy(mime_type)

tests/test_camera.py

@@ -182,7 +182,7 @@ async def test_get_frame(self, camera: MockCamera, service: CameraService, image
             client = CameraClient("camera", channel)
 
             # Test known mime type
-            png_img = await client.get_image(timeout=1.82)
+            png_img = await client.get_image(timeout=1.82, mime_type=CameraMimeType.PNG)
             assert isinstance(png_img, Image.Image)
             assert png_img.tobytes() == image.tobytes()
             assert camera.timeout == loose_approx(1.82)