bump to 1.7.0

then catch and log OSError and close thread.

README.md

@@ -9,10 +9,10 @@ Not all endpoints in the official documentation are implemented.
 
 ## Requirements
 
--   [OBS Studio](https://obsproject.com/)
--   [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
-    -   With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS.
--   Python 3.9 or greater
+- [OBS Studio](https://obsproject.com/)
+- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
+  - With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS.
+- Python 3.9 or greater
 
 ### How to install using pip
 
@@ -24,10 +24,10 @@ pip install obsws-python
 
 By default the clients connect with parameters:
 
--   `host`: "localhost"
--   `port`: 4455
--   `password`: ""
--   `timeout`: None
+- `host`: "localhost"
+- `port`: 4455
+- `password`: ""
+- `timeout`: None
 
 You may override these parameters by storing them in a toml config file or passing them as keyword arguments.
 
@@ -62,7 +62,7 @@ cl.toggle_input_mute('Mic/Aux')
 
 ### Requests
 
-Method names for requests match the API calls but snake cased.
+Method names for requests match the API calls but snake cased. If a successful call is made with the Request client and the response is expected to contain fields then a response object will be returned. You may then access the response fields as class attributes. They will be snake cased.
 
 example:
 
@@ -70,13 +70,28 @@ example:
 # load conn info from config.toml
 cl = obs.ReqClient()
 
-# GetVersion
+# GetVersion, returns a response object
 resp = cl.get_version()
+# Access it's field as an attribute
+print(f"OBS Version: {resp.obs_version}")
+
 
 # SetCurrentProgramScene
 cl.set_current_program_scene("BRB")
 ```
 
+#### `send(param, data=None, raw=False)`
+
+If you prefer to work with the JSON data directly the {ReqClient}.send() method accepts an argument, `raw`. If set to True the raw response data will be returned, instead of a response object.
+
+example:
+
+```python
+resp = cl_req.send("GetVersion", raw=True)
+
+print(f"response data: {resp}")
+```
+
 For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
 
 ### Events
@@ -128,11 +143,13 @@ def on_scene_created(data):
 
 ### Errors
 
-If a request fails an `OBSSDKError` will be raised with a status code.
-
-For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
-
-If a timeout occurs during sending/receiving a request or receiving an event an `OBSSDKTimeoutError` will be raised.
+- `OBSSDKError`: Base error class.
+- `OBSSDKTimeoutError`: Raised if a timeout occurs during sending/receiving a request or receiving an event
+- `OBSSDKRequestError`: Raised when a request returns an error code.
+  - The following attributes are available:
+    - `req_name`: name of the request.
+    - `code`: request status code.
+  - For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 
 ### Logging
 
@@ -165,4 +182,4 @@ pytest -v
 
 For the full documentation:
 
--   [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)
+- [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)

examples/events/__main__.py

@@ -17,6 +17,12 @@ class Observer:
         print(f"Registered events: {self._client.callback.get()}")
         self.running = True
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self._client.disconnect()
+
     def on_current_program_scene_changed(self, data):
         """The current program scene has changed."""
         print(f"Switched to scene {data.scene_name}")
@@ -31,13 +37,11 @@ class Observer:
 
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
-        print(f"OBS closing!")
-        self._client.unsubscribe()
+        print("OBS closing!")
         self.running = False
 
 
 if __name__ == "__main__":
-    observer = Observer()
-
-    while observer.running:
-        time.sleep(0.1)
+    with Observer() as observer:
+        while observer.running:
+            time.sleep(0.1)

examples/hotkeys/__main__.py

@@ -1,6 +1,7 @@
 import inspect
 
 import keyboard
+
 import obsws_python as obs
 
 
@@ -10,6 +11,12 @@ class Observer:
         self._client.callback.register(self.on_current_program_scene_changed)
         print(f"Registered events: {self._client.callback.get()}")
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self._client.disconnect()
+
     @property
     def event_identifier(self):
         return inspect.stack()[1].function
@@ -31,13 +38,12 @@ def set_scene(scene, *args):
 
 
 if __name__ == "__main__":
-    req_client = obs.ReqClient()
-    observer = Observer()
+    with obs.ReqClient() as req_client:
+        with Observer() as observer:
+            keyboard.add_hotkey("0", version)
+            keyboard.add_hotkey("1", set_scene, args=("START",))
+            keyboard.add_hotkey("2", set_scene, args=("BRB",))
+            keyboard.add_hotkey("3", set_scene, args=("END",))
 
-    keyboard.add_hotkey("0", version)
-    keyboard.add_hotkey("1", set_scene, args=("START",))
-    keyboard.add_hotkey("2", set_scene, args=("BRB",))
-    keyboard.add_hotkey("3", set_scene, args=("END",))
-
-    print("press ctrl+enter to quit")
-    keyboard.wait("ctrl+enter")
+            print("press ctrl+enter to quit")
+            keyboard.wait("ctrl+enter")

examples/levels/__main__.py

@@ -9,6 +9,8 @@ LEVELTYPE = IntEnum(
     start=0,
 )
 
+DEVICE = "Desktop Audio"
+
 
 def on_input_mute_state_changed(data):
     """An input's mute state has changed."""
@@ -32,15 +34,14 @@ def on_input_volume_meters(data):
 
 
 def main():
-    client = obs.EventClient(subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS))
-    client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
+    with obs.EventClient(
+        subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS)
+    ) as client:
+        client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
 
-    while cmd := input("<Enter> to exit>\n"):
-        if not cmd:
-            break
+        while _ := input("Press <Enter> to exit\n"):
+            pass
 
 
 if __name__ == "__main__":
-    DEVICE = "Desktop Audio"
-
     main()

obsws_python/baseclient.py

@@ -43,7 +43,7 @@ class ObsClient:
         except ValueError as e:
             self.logger.error(f"{type(e).__name__}: {e}")
             raise
-        except (ConnectionRefusedError, WebSocketTimeoutException) as e:
+        except (ConnectionRefusedError, TimeoutError, WebSocketTimeoutException) as e:
             self.logger.exception(f"{type(e).__name__}: {e}")
             raise
 
@@ -97,9 +97,9 @@ class ObsClient:
             auth = base64.b64encode(
                 hashlib.sha256(
                     (
-                        secret.decode()
-                        + self.server_hello["d"]["authentication"]["challenge"]
-                    ).encode()
+                        secret
+                        + self.server_hello["d"]["authentication"]["challenge"].encode()
+                    )
                 ).digest()
             ).decode()
 
@@ -110,7 +110,7 @@ class ObsClient:
             response = json.loads(self.ws.recv())
             if response["op"] != 2:
                 raise OBSSDKError(
-                    "failed to identify client with the server, expected response with OpCode 2 Identified"
+                    "failed to identify client with the server, expected response with OpCode 2"
                 )
             return response["d"]
         except json.decoder.JSONDecodeError:

obsws_python/error.py

@@ -1,6 +1,18 @@
 class OBSSDKError(Exception):
-    """Exception raised when general errors occur"""
+    """Base class for OBSSDK errors"""
 
 
-class OBSSDKTimeoutError(Exception):
+class OBSSDKTimeoutError(OBSSDKError):
     """Exception raised when a connection times out"""
+
+
+class OBSSDKRequestError(OBSSDKError):
+    """Exception raised when a request returns an error code"""
+
+    def __init__(self, req_name, code, comment):
+        self.req_name = req_name
+        self.code = code
+        message = f"Request {self.req_name} returned code {self.code}."
+        if comment:
+            message += f" With message: {comment}"
+        super().__init__(message)

obsws_python/events.py

@@ -1,9 +1,8 @@
 import json
 import logging
-import time
-from threading import Thread
+import threading
 
-from websocket import WebSocketTimeoutException
+from websocket import WebSocketConnectionClosedException, WebSocketTimeoutException
 
 from .baseclient import ObsClient
 from .callback import Callback
@@ -20,8 +19,6 @@ logger = logging.getLogger(__name__)
 
 
 class EventClient:
-    DELAY = 0.001
-
     def __init__(self, **kwargs):
         self.logger = logger.getChild(self.__class__.__name__)
         defaultkwargs = {"subs": Subs.LOW_VOLUME}
@@ -38,6 +35,12 @@ class EventClient:
         self.callback = Callback()
         self.subscribe()
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self.disconnect()
+
     def __repr__(self):
         return type(
             self
@@ -49,33 +52,40 @@ class EventClient:
         return type(self).__name__
 
     def subscribe(self):
-        worker = Thread(target=self.trigger, daemon=True)
-        worker.start()
+        self.base_client.ws.settimeout(None)
+        stop_event = threading.Event()
+        self.worker = threading.Thread(
+            target=self.trigger, daemon=True, args=(stop_event,)
+        )
+        self.worker.start()
 
-    def trigger(self):
+    def trigger(self, stop_event):
         """
         Continuously listen for events.
 
         Triggers a callback on event received.
         """
-        self.running = True
-        while self.running:
+        while not stop_event.is_set():
             try:
-                event = json.loads(self.base_client.ws.recv())
+                if response := self.base_client.ws.recv():
+                    event = json.loads(response)
+                    self.logger.debug(f"Event received {event}")
+                    type_, data = (
+                        event["d"].get("eventType"),
+                        event["d"].get("eventData"),
+                    )
+                    self.callback.trigger(type_, data if data else {})
             except WebSocketTimeoutException as e:
                 self.logger.exception(f"{type(e).__name__}: {e}")
                 raise OBSSDKTimeoutError("Timeout while waiting for event") from e
-            self.logger.debug(f"Event received {event}")
-            type_, data = (
-                event["d"].get("eventType"),
-                event["d"].get("eventData"),
-            )
-            self.callback.trigger(type_, data if data else {})
-            time.sleep(self.DELAY)
+            except (WebSocketConnectionClosedException, OSError) as e:
+                self.logger.debug(f"{type(e).__name__} terminating the event thread")
+                stop_event.set()
+
+    def disconnect(self):
+        """stop listening for events"""
 
-    def unsubscribe(self):
-        """
-        stop listening for events
-        """
-        self.running = False
         self.base_client.ws.close()
+        self.worker.join()
+
+    unsubscribe = disconnect

obsws_python/reqs.py

@@ -1,7 +1,8 @@
 import logging
+from warnings import warn
 
 from .baseclient import ObsClient
-from .error import OBSSDKError
+from .error import OBSSDKError, OBSSDKRequestError
 from .util import as_dataclass
 
 """
@@ -30,7 +31,7 @@ class ReqClient:
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
-        self.base_client.ws.close()
+        self.disconnect()
 
     def __repr__(self):
         return type(
@@ -41,16 +42,22 @@ class ReqClient:
 
     def __str__(self):
         return type(self).__name__
+    
+    def disconnect(self):
+        self.base_client.ws.close()
 
     def send(self, param, data=None, raw=False):
-        response = self.base_client.req(param, data)
-        if not response["requestStatus"]["result"]:
-            error = (
-                f"Request {response['requestType']} returned code {response['requestStatus']['code']}",
-            )
-            if "comment" in response["requestStatus"]:
-                error += (f"With message: {response['requestStatus']['comment']}",)
-            raise OBSSDKError("\n".join(error))
+        try:
+            response = self.base_client.req(param, data)
+            if not response["requestStatus"]["result"]:
+                raise OBSSDKRequestError(
+                    response["requestType"],
+                    response["requestStatus"]["code"],
+                    response["requestStatus"].get("comment"),
+                )
+        except OBSSDKRequestError as e:
+            self.logger.exception(f"{type(e).__name__}: {e}")
+            raise
         if "responseData" in response:
             if raw:
                 return response["responseData"]
@@ -429,6 +436,19 @@ class ReqClient:
         """
         return self.send("GetRecordDirectory")
 
+    def set_record_directory(self, recordDirectory):
+        """
+        Sets the current directory that the record output writes files to. 
+        IMPORTANT NOTE: Requires obs websocket v5.3 or higher.
+
+        :param recordDirectory: Output directory
+        :type recordDirectory: str
+        """
+        payload = {
+            "recordDirectory": recordDirectory,
+        }
+        return self.send("SetRecordDirectory", payload)
+    
     def get_source_active(self, name):
         """
         Gets the active and show state of a source
@@ -1935,3 +1955,66 @@ class ReqClient:
 
         """
         return self.send("GetMonitorList")
+
+    def open_video_mix_projector(
+        self, video_mix_type, monitor_index=-1, projector_geometry=None
+    ):
+        """
+        Opens a projector for a specific output video mix.
+
+        The available mix types are:
+            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW
+            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM
+            OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW
+
+        :param video_mix_type: Type of mix to open.
+        :type video_mix_type:  str
+        :param monitor_index: Monitor index, use GetMonitorList to obtain index
+        :type monitor_index:  int
+        :param projector_geometry:
+            Size/Position data for a windowed projector, in Qt Base64 encoded format.
+            Mutually exclusive with monitorIndex
+        :type projector_geometry: str
+
+        """
+        warn(
+            "open_video_mix_projector request serves to provide feature parity with 4.x. "
+            "It is very likely to be changed/deprecated in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        payload = {
+            "videoMixType": video_mix_type,
+            "monitorIndex": monitor_index,
+            "projectorGeometry": projector_geometry,
+        }
+        self.send("OpenVideoMixProjector", payload)
+
+    def open_source_projector(
+        self, source_name, monitor_index=-1, projector_geometry=None
+    ):
+        """
+        Opens a projector for a source.
+
+        :param source_name: Name of the source to open a projector for
+        :type source_name:  str
+        :param monitor_index: Monitor index, use GetMonitorList to obtain index
+        :type monitor_index:  int
+        :param projector_geometry:
+            Size/Position data for a windowed projector, in Qt Base64 encoded format.
+            Mutually exclusive with monitorIndex
+        :type projector_geometry: str
+
+        """
+        warn(
+            "open_source_projector request serves to provide feature parity with 4.x. "
+            "It is very likely to be changed/deprecated in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        payload = {
+            "sourceName": source_name,
+            "monitorIndex": monitor_index,
+            "projectorGeometry": projector_geometry,
+        }
+        self.send("OpenSourceProjector", payload)

obsws_python/version.py

@@ -1 +1 @@
-version = "1.5.2"
+version = "1.7.0"

tests/test_error.py

@@ -0,0 +1,35 @@
+import pytest
+
+import obsws_python as obsws
+from tests import req_cl
+
+
+class TestErrors:
+    __test__ = True
+
+    def test_it_raises_an_obssdk_error_on_incorrect_password(self):
+        bad_conn = {"host": "localhost", "port": 4455, "password": "incorrectpassword"}
+        with pytest.raises(
+            obsws.error.OBSSDKError,
+            match="failed to identify client with the server, please check connection settings",
+        ):
+            obsws.ReqClient(**bad_conn)
+
+    def test_it_raises_an_obssdk_error_if_auth_enabled_but_no_password_provided(self):
+        bad_conn = {"host": "localhost", "port": 4455, "password": ""}
+        with pytest.raises(
+            obsws.error.OBSSDKError,
+            match="authentication enabled but no password provided",
+        ):
+            obsws.ReqClient(**bad_conn)
+
+    def test_it_raises_a_request_error_on_invalid_request(self):
+        with pytest.raises(
+            obsws.error.OBSSDKRequestError,
+            match="Request SetCurrentProgramScene returned code 600. With message: No source was found by the name of `invalid`.",
+        ) as exc_info:
+            req_cl.set_current_program_scene("invalid")
+
+        e = exc_info.value
+        assert e.req_name == "SetCurrentProgramScene"
+        assert e.code == 600

tests/test_request.py

@@ -15,9 +15,9 @@ class TestRequests:
         resp = req_cl.get_hot_key_list()
         obsbasic_hotkey_list = [
             "OBSBasic.SelectScene",
-            "OBSBasic.SelectScene",
-            "OBSBasic.SelectScene",
-            "OBSBasic.SelectScene",
+            "OBSBasic.QuickTransition.1",
+            "OBSBasic.QuickTransition.2",
+            "OBSBasic.QuickTransition.3",
             "OBSBasic.StartStreaming",
             "OBSBasic.StopStreaming",
             "OBSBasic.ForceStopStreaming",
@@ -25,15 +25,17 @@ class TestRequests:
             "OBSBasic.StopRecording",
             "OBSBasic.PauseRecording",
             "OBSBasic.UnpauseRecording",
+            "OBSBasic.SplitFile",
             "OBSBasic.StartReplayBuffer",
             "OBSBasic.StopReplayBuffer",
             "OBSBasic.StartVirtualCam",
             "OBSBasic.StopVirtualCam",
             "OBSBasic.EnablePreview",
             "OBSBasic.DisablePreview",
+            "OBSBasic.EnablePreviewProgram",
+            "OBSBasic.DisablePreviewProgram",
             "OBSBasic.ShowContextBar",
             "OBSBasic.HideContextBar",
-            "OBSBasic.TogglePreviewProgram",
             "OBSBasic.Transition",
             "OBSBasic.ResetStats",
             "OBSBasic.Screenshot",