Adding a method to get options

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "framegrab"
-version = "0.11.0"
+version = "0.11.1"
 description = "Easily grab frames from cameras or streams"
 authors = ["Groundlight <[email protected]>"]
 license = "MIT"

src/framegrab/config.py

@@ -284,6 +284,13 @@ def create(cls, input_type: Optional[InputTypes] = None, **kwargs) -> "FrameGrab
                     continue
             raise ValueError("Could not determine input type from provided arguments")
 
+    def get_options(self) -> dict:
+        """
+        Return the FrameGrabber options portion of the config as a dictionary,
+        consistent with the 'options' key in the Framegrab standard format.
+        """
+        return self.to_framegrab_config_dict().get("options", {})
+
 
 class WithResolutionMixin(FrameGrabberConfig, ABC):
     """Mixin class to add resolution configuration to FrameGrabberConfig."""

test/test_all_grabber_types_generic.py

@@ -337,3 +337,21 @@ def test_determine_input_type_in_create(self):
         # this won't work because there are multiple input types that could be mapped to the serial_number field
         with self.assertRaises(ValueError):
             FrameGrabberConfig.create(serial_number="1234567890", resolution_width=640, resolution_height=480, digital_zoom=2)
+
+    # def test_get_and_apply_options(self):
+    #     """
+    #     Test that we can get the grabber's options and make an update to the options
+    #     """
+    #     original_zoom = 2.0
+    #     new_zoom = 2.1
+
+    #     config = MockFrameGrabberConfig(digital_zoom=original_zoom)
+    #     grabber = FrameGrabber.create_grabber(config)
+
+    #     assert grabber.config.get_options() == {'zoom': {'digital': original_zoom}}
+
+    #     new_options = grabber.config.get_options()
+    #     new_options["zoom"] = {'digital': new_zoom}
+    #     grabber.apply_options(new_options)
+    #     options = grabber.config.get_options()
+    #     assert options == {'zoom': {'digital': new_zoom}}