fix docstring.

.gitignore

@@ -51,7 +51,7 @@ venv.bak/
 .python-version
 
 # Test/config
-test-*.py
+quick.py
 config.toml
 obsws.log
 

.pre-commit-config.yaml

@@ -1,10 +0,0 @@
-repos:
-  - repo: local
-    hooks:
-      - id: format
-        name: format
-        entry: hatch run style:fmt
-        language: system
-        pass_filenames: false
-        verbose: true
-        files: \.(py)$

README.md

@@ -1,6 +1,5 @@
 [![PyPI version](https://badge.fury.io/py/obsws-python.svg)](https://badge.fury.io/py/obsws-python)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/aatikturk/obsstudio_sdk/blob/main/LICENSE)
-[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
@@ -93,7 +92,7 @@ resp = cl_req.send("GetVersion", raw=True)
 print(f"response data: {resp}")
 ```
 
-For a full list of requests refer to [Requests][obsws-reqs]
+For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
 
 ### Events
 
@@ -126,7 +125,7 @@ cl.callback.deregister(on_input_mute_state_changed)
 
 `register(fns)` and `deregister(fns)` accept both single functions and lists of functions.
 
-For a full list of events refer to [Events][obsws-events]
+For a full list of events refer to [Events](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events)
 
 ### Attributes
 
@@ -150,7 +149,7 @@ def on_scene_created(data):
   - 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][obsws-codes]
+  - For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 
 ### Logging
 
@@ -169,21 +168,18 @@ logging.basicConfig(level=logging.DEBUG)
 
 ### Tests
 
-Install [hatch][hatch-install] and then:
+First install development dependencies:
+
+`pip install -e .['dev']`
+
+To run all tests:
 
 ```
-hatch test
+pytest -v
 ```
 
 ### Official Documentation
 
 For the full documentation:
 
-- [OBS Websocket SDK][obsws-pro]
+- [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)
-
-
-[obsws-reqs]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests
-[obsws-events]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events
-[obsws-codes]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus
-[obsws-pro]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol
-[hatch-install]: https://hatch.pypa.io/latest/install/

examples/events/__main__.py

@@ -17,12 +17,6 @@ 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}")
@@ -37,11 +31,13 @@ class Observer:
 
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
-        print("OBS closing!")
+        print(f"OBS closing!")
+        self._client.unsubscribe()
         self.running = False
 
 
 if __name__ == "__main__":
-    with Observer() as observer:
+    observer = Observer()
+
     while observer.running:
         time.sleep(0.1)

examples/hotkeys/__main__.py

@@ -1,7 +1,6 @@
 import inspect
 
 import keyboard
-
 import obsws_python as obs
 
 
@@ -11,12 +10,6 @@ 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
@@ -38,8 +31,9 @@ def set_scene(scene, *args):
 
 
 if __name__ == "__main__":
-    with obs.ReqClient() as req_client:
+    req_client = obs.ReqClient()
-        with Observer() as observer:
+    observer = Observer()
+
     keyboard.add_hotkey("0", version)
     keyboard.add_hotkey("1", set_scene, args=("START",))
     keyboard.add_hotkey("2", set_scene, args=("BRB",))

examples/levels/__main__.py

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

obsws_python/baseclient.py

@@ -96,8 +96,10 @@ class ObsClient:
 
             auth = base64.b64encode(
                 hashlib.sha256(
+                    (
                         secret
                         + self.server_hello["d"]["authentication"]["challenge"].encode()
+                    )
                 ).digest()
             ).decode()
 

obsws_python/callback.py

@@ -1,5 +1,4 @@
-from collections.abc import Callable, Iterable
+from typing import Callable, Iterable, Union
-from typing import Union
 
 from .util import as_dataclass, to_camel_case, to_snake_case
 

obsws_python/events.py

@@ -1,8 +1,9 @@
 import json
 import logging
-import threading
+import time
+from threading import Thread
 
-from websocket import WebSocketConnectionClosedException, WebSocketTimeoutException
+from websocket import WebSocketTimeoutException
 
 from .baseclient import ObsClient
 from .callback import Callback
@@ -19,6 +20,8 @@ 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}
@@ -35,12 +38,6 @@ 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
@@ -52,40 +49,33 @@ class EventClient:
         return type(self).__name__
 
     def subscribe(self):
-        self.base_client.ws.settimeout(None)
+        worker = Thread(target=self.trigger, daemon=True)
-        stop_event = threading.Event()
+        worker.start()
-        self.worker = threading.Thread(
-            target=self.trigger, daemon=True, args=(stop_event,)
-        )
-        self.worker.start()
 
-    def trigger(self, stop_event):
+    def trigger(self):
         """
         Continuously listen for events.
 
         Triggers a callback on event received.
         """
-        while not stop_event.is_set():
+        self.running = True
+        while self.running:
             try:
-                if response := self.base_client.ws.recv():
+                event = json.loads(self.base_client.ws.recv())
-                    event = json.loads(response)
+            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 {})
-            except WebSocketTimeoutException as e:
+            time.sleep(self.DELAY)
-                self.logger.exception(f"{type(e).__name__}: {e}")
-                raise OBSSDKTimeoutError("Timeout while waiting for event") from e
-            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

@@ -31,7 +31,7 @@ class ReqClient:
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
-        self.disconnect()
+        self.base_client.ws.close()
 
     def __repr__(self):
         return type(
@@ -43,9 +43,6 @@ 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):
         try:
             response = self.base_client.req(param, data)
@@ -138,39 +135,39 @@ class ReqClient:
 
     get_hotkey_list = get_hot_key_list
 
-    def trigger_hot_key_by_name(self, hotkeyName, contextName=None):
+    def trigger_hot_key_by_name(self, hotkeyName):
         """
         Triggers a hotkey using its name. For hotkey names
         See GetHotkeyList
 
         :param hotkeyName: Name of the hotkey to trigger
         :type hotkeyName: str
-        :param contextName: Name of context of the hotkey to trigger
-        :type contextName: str, optional
 
 
         """
-        payload = {"hotkeyName": hotkeyName, "contextName": contextName}
+        payload = {"hotkeyName": hotkeyName}
         self.send("TriggerHotkeyByName", payload)
 
     trigger_hotkey_by_name = trigger_hot_key_by_name
 
     def trigger_hot_key_by_key_sequence(
-        self, keyId, pressShift=None, pressCtrl=None, pressAlt=None, pressCmd=None
+        self, keyId, pressShift, pressCtrl, pressAlt, pressCmd
     ):
         """
         Triggers a hotkey using a sequence of keys.
 
         :param keyId: The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
         :type keyId: str
-        :param pressShift: Press Shift
+        :param keyModifiers: Object containing key modifiers to apply.
-        :type pressShift: bool, optional
+        :type keyModifiers: dict
-        :param pressCtrl: Press CTRL
+        :param keyModifiers.shift: Press Shift
-        :type pressCtrl: bool, optional
+        :type keyModifiers.shift: bool
-        :param pressAlt: Press ALT
+        :param keyModifiers.control: Press CTRL
-        :type pressAlt: bool, optional
+        :type keyModifiers.control: bool
-        :param pressCmd: Press CMD (Mac)
+        :param keyModifiers.alt: Press ALT
-        :type pressCmd: bool, optional
+        :type keyModifiers.alt: bool
+        :param keyModifiers.cmd: Press CMD (Mac)
+        :type keyModifiers.cmd: bool
 
 
         """
@@ -436,19 +433,6 @@ 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
@@ -1100,14 +1084,6 @@ class ReqClient:
         payload = {"position": pos, "release": release}
         self.send("SetTBarPosition", payload)
 
-    def get_source_filter_kind_list(self):
-        """
-        Gets an array of all available source filter kinds.
-
-
-        """
-        return self.send("GetSourceFilterKindList")
-
     def get_source_filter_list(self, name):
         """
         Gets a list of all of a source's filters.
@@ -1319,23 +1295,6 @@ class ReqClient:
         }
         return self.send("GetSceneItemId", payload)
 
-    def get_scene_item_source(self, scene_name, scene_item_id):
-        """
-        Gets the source associated with a scene item.
-
-        :param scene_item_id: Numeric ID of the scene item (>= 0)
-        :type scene_item_id: int
-        :param scene_name: Name of the scene the item is in.
-        :type scene_name: str
-
-
-        """
-        payload = {
-            "sceneItemId": scene_item_id,
-            "sceneName": scene_name,
-        }
-        return self.send("GetSceneItemSource", payload)
-
     def create_scene_item(self, scene_name, source_name, enabled=None):
         """
         Creates a new scene item using a source.
@@ -1809,7 +1768,7 @@ class ReqClient:
 
 
         """
-        return self.send("ToggleRecord")
+        self.send("ToggleRecord")
 
     def start_record(self):
         """
@@ -1851,28 +1810,6 @@ class ReqClient:
         """
         self.send("ResumeRecord")
 
-    def split_record_file(self):
-        """
-        Splits the current file being recorded into a new file.
-
-
-        """
-        self.send("SplitRecordFile")
-
-    def create_record_chapter(self, chapter_name=None):
-        """
-        Adds a new chapter marker to the file currently being recorded.
-
-        Note: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.
-
-        :param chapter_name: Name of the new chapter
-        :type chapter_name: str
-
-
-        """
-        payload = {"chapterName": chapter_name}
-        self.send("CreateRecordChapter", payload)
-
     def get_media_input_status(self, name):
         """
         Gets the status of a media input.
@@ -2009,24 +1946,16 @@ class ReqClient:
         """
         Opens a projector for a specific output video mix.
 
-        The available mix types are:
+        :param videoMixType: Type of mix to open
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW
+        :type videoMixType:  str
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM
+        :param monitorIndex: Monitor index, use GetMonitorList to obtain index
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW
+        :type monitorIndex:  int
-
+        :param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
-        :param video_mix_type: Type of mix to open.
+        :type projectorGeometry: str
-        :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. "
+            "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.",
-            "It is very likely to be changed/deprecated in a future release.",
             DeprecationWarning,
             stacklevel=2,
         )
@@ -2043,19 +1972,16 @@ class ReqClient:
         """
         Opens a projector for a source.
 
-        :param source_name: Name of the source to open a projector for
+        :param sourceName: Name of the source to open a projector for
-        :type source_name:  str
+        :type sourceName:  str
-        :param monitor_index: Monitor index, use GetMonitorList to obtain index
+        :param monitorIndex: Monitor index, use GetMonitorList to obtain index
-        :type monitor_index:  int
+        :type monitorIndex:  int
-        :param projector_geometry:
+        :param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
-            Size/Position data for a windowed projector, in Qt Base64 encoded format.
+        :type projectorGeometry: str
-            Mutually exclusive with monitorIndex
-        :type projector_geometry: str
 
         """
         warn(
-            "open_source_projector request serves to provide feature parity with 4.x. "
+            "open_source_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
-            "It is very likely to be changed/deprecated in a future release.",
             DeprecationWarning,
             stacklevel=2,
         )

obsws_python/version.py

@@ -1 +1 @@
-version = "1.8.0"
+version = "1.6.0"

pyproject.toml

@@ -7,7 +7,7 @@ name = "obsws-python"
 dynamic = ["version"]
 description = "A Python SDK for OBS Studio WebSocket v5.0"
 readme = "README.md"
-license = { text = "GPL-3.0-only" }
+license = "GPL-3.0-only"
 requires-python = ">=3.9"
 authors = [
     { name = "Adem Atikturk", email = "aatikturk@gmail.com" },
@@ -17,6 +17,14 @@ dependencies = [
     "websocket-client",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "black",
+    "isort",
+    "pytest",
+    "pytest-randomly",
+]
+
 [project.urls]
 Homepage = "https://github.com/aatikturk/obsws-python"
 
@@ -28,58 +36,19 @@ include = [
     "/obsws_python",
 ]
 
-[tool.hatch.envs.default]
-dependencies = ["pre-commit"]
-
-[tool.hatch.envs.e]
-dependencies = ["keyboard"]
-
 [tool.hatch.envs.e.scripts]
 events = "python {root}\\examples\\events\\."
 hotkeys = "python {root}\\examples\\hotkeys\\."
 levels = "python {root}\\examples\\levels\\."
 scene_rotate = "python {root}\\examples\\scene_rotate\\."
 
-[tool.hatch.envs.hatch-test]
+[tool.hatch.envs.test]
-randomize = true
-
-[tool.hatch.envs.hatch-test.scripts]
-run = "pytest{env:HATCH_TEST_ARGS:} {args}"
-
-[[tool.hatch.envs.hatch-test.matrix]]
-python = ["313", "312", "311", "310", "39"]
-
-[tool.hatch.envs.style]
-detached = true
 dependencies = [
-    "black",
+  "pytest",
-    "isort",
 ]
 
-[tool.hatch.envs.style.scripts]
+[tool.hatch.envs.test.scripts]
-check = [
+run = 'pytest -v'
-    "black --check --diff .",
-    "isort --check-only --diff .",
-]
-fmt = [
-    "isort .",
-    "black .",
-]
 
-[tool.black]
+[[tool.hatch.envs.test.matrix]]
-line-length = 88
+python = ["39", "310", "311"]
-include = '\.pyi?$'
-# 'extend-exclude' excludes files or directories in addition to the defaults
-extend-exclude = '''
-(
-    ^/\.git/  # exclude all files in the .git directory
-    ^/\.hatch/  # exclude all files in the .hatch directory
-    ^/\.pytest_cache/  # exclude all files in the .pytest_cache directory
-    | .*_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
-)
-'''
-
-[tool.isort]
-profile = "black"
-skip = [".gitignore", ".dockerignore"]
-skip_glob = [".git/*", ".hatch/*", ".pytest_cache/*"]

tests/test_attrs.py

@@ -18,12 +18,7 @@ class TestAttrs:
 
     def test_get_current_program_scene_attrs(self):
         resp = req_cl.get_current_program_scene()
-        assert resp.attrs() == [
+        assert resp.attrs() == ["current_program_scene_name"]
-            "current_program_scene_name",
-            "current_program_scene_uuid",
-            "scene_name",
-            "scene_uuid",
-        ]
 
     def test_get_transition_kind_list_attrs(self):
         resp = req_cl.get_transition_kind_list()

tests/test_callback.py

@@ -1,5 +1,4 @@
 import pytest
-
 from obsws_python.callback import Callback
 
 

tests/test_request.py

@@ -13,8 +13,33 @@ class TestRequests:
 
     def test_get_hot_key_list(self):
         resp = req_cl.get_hot_key_list()
-        assert resp.hotkeys
+        obsbasic_hotkey_list = [
-        assert any(x.startswith("OBSBasic.") for x in resp.hotkeys)
+            "OBSBasic.SelectScene",
+            "OBSBasic.SelectScene",
+            "OBSBasic.SelectScene",
+            "OBSBasic.SelectScene",
+            "OBSBasic.StartStreaming",
+            "OBSBasic.StopStreaming",
+            "OBSBasic.ForceStopStreaming",
+            "OBSBasic.StartRecording",
+            "OBSBasic.StopRecording",
+            "OBSBasic.PauseRecording",
+            "OBSBasic.UnpauseRecording",
+            "OBSBasic.StartReplayBuffer",
+            "OBSBasic.StopReplayBuffer",
+            "OBSBasic.StartVirtualCam",
+            "OBSBasic.StopVirtualCam",
+            "OBSBasic.EnablePreview",
+            "OBSBasic.DisablePreview",
+            "OBSBasic.ShowContextBar",
+            "OBSBasic.HideContextBar",
+            "OBSBasic.TogglePreviewProgram",
+            "OBSBasic.Transition",
+            "OBSBasic.ResetStats",
+            "OBSBasic.Screenshot",
+            "OBSBasic.SelectedSourceScreenshot",
+        ]
+        assert all(x in resp.hotkeys for x in obsbasic_hotkey_list)
 
     @pytest.mark.parametrize(
         "name,data",
@@ -28,7 +53,6 @@ class TestRequests:
         resp = req_cl.get_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name)
         assert resp.slot_value == data
 
-    @pytest.mark.skip(reason="possible bug in obs-websocket, needs checking")
     def test_profile_list(self):
         req_cl.create_profile("test")
         resp = req_cl.get_profile_list()
@@ -71,15 +95,11 @@ class TestRequests:
             "START_TEST", "test", "color_source_v3", {"color": 4294945535}, True
         )
         resp = req_cl.get_input_list()
-        for input_item in resp.inputs:
+        assert {
-            if input_item["inputName"] == "test":
+            "inputKind": "color_source_v3",
-                assert input_item["inputKind"] == "color_source_v3"
+            "inputName": "test",
-                assert input_item["unversionedInputKind"] == "color_source"
+            "unversionedInputKind": "color_source",
-                break
+        } in resp.inputs
-        else:
-            # This else block is executed if the for loop completes without finding the input_item with inputName "test"
-            raise AssertionError("Input with inputName 'test' not found")
-
         resp = req_cl.get_input_settings("test")
         assert resp.input_kind == "color_source_v3"
         assert resp.input_settings == {"color": 4294945535}