fix docstring.

.gitignore

@@ -1,14 +1,8 @@
-# Generated by ignr: github.com/onyx-and-iris/ignr
-
-## Python ##
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[codz]
+*.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -23,22 +17,11 @@ parts/
 sdist/
 var/
 wheels/
-share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -49,169 +32,27 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py.cover
 .hypothesis/
 .pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# UV
-#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#uv.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-#poetry.toml
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
-#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
-#pdm.lock
-#pdm.toml
-.pdm-python
-.pdm-build/
-
-# pixi
-#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
-#pixi.lock
-#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
-#   in the .venv directory. It is recommended not to include this directory in version control.
-.pixi
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
 
 # Environments
 .env
-.envrc
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
+.hatch
 
-# Spyder project settings
+# pyenv
-.spyderproject
+#   For a library or package, you might want to ignore these files since the code is
-.spyproject
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
 
-# Rope project settings
+# Test/config
-.ropeproject
+quick.py
+config.toml
+obsws.log
 
-# mkdocs documentation
+.vscode/
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-# Abstra
-# Abstra is an AI-powered process automation framework.
-# Ignore directories containing user credentials, local state, and settings.
-# Learn more at https://abstra.io/docs
-.abstra/
-
-# Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
-#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
-#  you could uncomment the following to ignore the entire vscode folder
-.vscode/
-
-# Ruff stuff:
-.ruff_cache/
-
-# PyPI configuration file
-.pypirc
-
-# Cursor
-#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
-#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
-#  refer to https://docs.cursor.com/context/ignore-files
-.cursorignore
-.cursorindexingignore
-
-# Marimo
-marimo/_static/
-marimo/_lsp/
-__marimo__/
-
-# End of ignr
-
-tools/
-
-test-*.py
-config.toml

.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/

Taskfile.yaml

@@ -1,23 +0,0 @@
-version: '3'
-
-tasks:
-  default:
-    desc: Generate ReqClient methods from the API spec
-    deps: [generate]
-
-  generate:
-    desc: Generate ReqClient methods from the API spec
-    deps: [pull-protocol-json]
-    cmds:
-      - python tools/generate.py
-      - hatch run style:fmt
-    internal: true
-
-  pull-protocol-json:
-    desc: Pull the latest API spec from the obs-websocket repository
-    preconditions:
-      - sh: '[ ! -f tools/protocol.json ] || [ "$(find tools/protocol.json -mmin +1440)" ]'
-        msg: 'The protocol.json file is up to date (last modified less than 24 hours ago).'
-    cmds:
-      - curl -sSfL -o tools/protocol.json "https://raw.githubusercontent.com/obsproject/obs-websocket/refs/heads/master/docs/generated/protocol.json"
-    internal: true

examples/events/__main__.py

@@ -1,13 +1,11 @@
-import os
+import time
-from threading import Event
 
 import obsws_python as obs
 
 
 class Observer:
-    def __init__(self, host, port, password, stop_event):
+    def __init__(self):
-        self._client = obs.EventClient(host=host, port=port, password=password)
+        self._client = obs.EventClient()
-        self._stop_event = stop_event
         self._client.callback.register(
             [
                 self.on_current_program_scene_changed,
@@ -17,12 +15,7 @@ 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."""
@@ -38,16 +31,13 @@ class Observer:
 
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
-        print("OBS closing!")
+        print(f"OBS closing!")
-        self._stop_event.set()
+        self._client.unsubscribe()
+        self.running = False
 
 
 if __name__ == "__main__":
-    host = os.getenv("OBSWS_HOST", "localhost")
+    observer = Observer()
-    port = int(os.getenv("OBSWS_PORT", 4455))
-    password = os.getenv("OBSWS_PASSWORD", "")
 
-    stop_event = Event()
+    while observer.running:
-
+        time.sleep(0.1)
-    with Observer(host, port, password, stop_event) as observer:
-        stop_event.wait()

examples/hotkeys/__main__.py

@@ -1,23 +1,15 @@
 import inspect
-import os
-
-import keyboard  # type: ignore
 
+import keyboard
 import obsws_python as obs
 
 
 class Observer:
-    def __init__(self, host, port, password):
+    def __init__(self):
-        self._client = obs.EventClient(host=host, port=port, password=password)
+        self._client = obs.EventClient()
         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
@@ -35,20 +27,17 @@ def version():
 
 
 def set_scene(scene, *args):
-    req_client.set_current_program_scene(scene_name=scene)
+    req_client.set_current_program_scene(scene)
 
 
 if __name__ == "__main__":
-    host = os.getenv("OBSWS_HOST", "localhost")
+    req_client = obs.ReqClient()
-    port = int(os.getenv("OBSWS_PORT", 4455))
+    observer = Observer()
-    password = os.getenv("OBSWS_PASSWORD", "")
 
-    with obs.ReqClient(host=host, port=port, password=password) as req_client:
+    keyboard.add_hotkey("0", version)
-        with Observer(host, port, password) as observer:
+    keyboard.add_hotkey("1", set_scene, args=("START",))
-            keyboard.add_hotkey("0", version)
+    keyboard.add_hotkey("2", set_scene, args=("BRB",))
-            keyboard.add_hotkey("1", set_scene, args=("START",))
+    keyboard.add_hotkey("3", set_scene, args=("END",))
-            keyboard.add_hotkey("2", set_scene, args=("BRB",))
-            keyboard.add_hotkey("3", set_scene, args=("END",))
 
-            print("press ctrl+enter to quit")
+    print("press ctrl+enter to quit")
-            keyboard.wait("ctrl+enter")
+    keyboard.wait("ctrl+enter")

examples/levels/__main__.py

@@ -1,4 +1,3 @@
-import os
 from enum import IntEnum
 from math import log
 
@@ -10,8 +9,6 @@ LEVELTYPE = IntEnum(
     start=0,
 )
 
-DEVICE = "Desktop Audio"
-
 
 def on_input_mute_state_changed(data):
     """An input's mute state has changed."""
@@ -35,21 +32,15 @@ def on_input_volume_meters(data):
 
 
 def main():
-    host = os.getenv("OBSWS_HOST", "localhost")
+    client = obs.EventClient(subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS))
-    port = int(os.getenv("OBSWS_PORT", 4455))
+    client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
-    password = os.getenv("OBSWS_PASSWORD", "")
 
-    with obs.EventClient(
+    while cmd := input("<Enter> to exit>\n"):
-        host=host,
+        if not cmd:
-        port=port,
+            break
-        password=password,
-        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"):
-            pass
 
 
 if __name__ == "__main__":
+    DEVICE = "Desktop Audio"
+
     main()

examples/scene_rotate/__main__.py

@@ -1,21 +1,16 @@
-import os
 import time
 
 import obsws_python as obs
 
 
 def main():
-    host = os.getenv("OBSWS_HOST", "localhost")
+    with obs.ReqClient() as client:
-    port = int(os.getenv("OBSWS_PORT", 4455))
-    password = os.getenv("OBSWS_PASSWORD", "")
-
-    with obs.ReqClient(host=host, port=port, password=password) as client:
         resp = client.get_scene_list()
         scenes = [di.get("sceneName") for di in reversed(resp.scenes)]
 
         for scene in scenes:
             print(f"Switching to scene {scene}")
-            client.set_current_program_scene(scene_name=scene)
+            client.set_current_program_scene(scene)
             time.sleep(0.5)
 
 

obsws_python/baseclient.py

@@ -96,8 +96,10 @@ class ObsClient:
 
             auth = base64.b64encode(
                 hashlib.sha256(
-                    secret
+                    (
-                    + self.server_hello["d"]["authentication"]["challenge"].encode()
+                        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)
-                    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
-            except (WebSocketConnectionClosedException, OSError) as e:
+            self.logger.debug(f"Event received {event}")
-                self.logger.debug(f"{type(e).__name__} terminating the event thread")
+            type_, data = (
-                stop_event.set()
+                event["d"].get("eventType"),
-
+                event["d"].get("eventData"),
-    def disconnect(self):
+            )
-        """stop listening for events"""
+            self.callback.trigger(type_, data if data else {})
+            time.sleep(self.DELAY)
 
+    def unsubscribe(self):
+        """
+        stop listening for events
+        """
+        self.running = False
         self.base_client.ws.close()
-        self.worker.join()
-
-    unsubscribe = disconnect

obsws_python/version.py

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

pyproject.toml

@@ -7,10 +7,23 @@ 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" }]
+authors = [
-dependencies = ["tomli >= 2.0.1;python_version < '3.11'", "websocket-client"]
+    { name = "Adem Atikturk", email = "aatikturk@gmail.com" },
+]
+dependencies = [
+    "tomli >= 2.0.1;python_version < '3.11'",
+    "websocket-client",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "isort",
+    "pytest",
+    "pytest-randomly",
+]
 
 [project.urls]
 Homepage = "https://github.com/aatikturk/obsws-python"
@@ -19,64 +32,23 @@ Homepage = "https://github.com/aatikturk/obsws-python"
 path = "obsws_python/version.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["/obsws_python"]
+include = [
-
+    "/obsws_python",
-[tool.hatch.env]
+]
-requires = ["hatch-dotenv"]
-
-[tool.hatch.env.collectors.dotenv.e]
-env-files = [".env"]
-# fail-on-missing = true # breaks publish workflow
-
-[tool.hatch.env.collectors.dotenv.hatch-test]
-env-files = [".env"]
-# fail-on-missing = true # breaks publish workflow
-
-[tool.hatch.envs.default]
-dependencies = ["pre-commit"]
-
-[tool.hatch.envs.e]
-dependencies = ["keyboard"]
-# env-include = ["OBSWS_*"] # causes issues on Windows.
 
 [tool.hatch.envs.e.scripts]
-events = "python -m examples.events"
+events = "python {root}\\examples\\events\\."
-hotkeys = "python -m examples.hotkeys"
+hotkeys = "python {root}\\examples\\hotkeys\\."
-levels = "python -m examples.levels"
+levels = "python {root}\\examples\\levels\\."
-scene-rotate = "python -m examples.scene_rotate"
+scene_rotate = "python {root}\\examples\\scene_rotate\\."
 
-[tool.hatch.envs.hatch-test]
+[tool.hatch.envs.test]
-randomize = true
+dependencies = [
-# env-include = ["OBSWS_*"] # causes issues on Windows.
+  "pytest",
+]
 
-[tool.hatch.envs.hatch-test.scripts]
+[tool.hatch.envs.test.scripts]
-run = "pytest{env:HATCH_TEST_ARGS:} {args}"
+run = 'pytest -v'
 
-[[tool.hatch.envs.hatch-test.matrix]]
+[[tool.hatch.envs.test.matrix]]
-python = ["313", "312", "311", "310", "39"]
+python = ["39", "310", "311"]
-
-[tool.hatch.envs.style]
-detached = true
-dependencies = ["black", "isort"]
-
-[tool.hatch.envs.style.scripts]
-check = ["black --check --diff .", "isort --check-only --diff ."]
-fmt = ["isort .", "black ."]
-
-[tool.black]
-line-length = 88
-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/__init__.py

@@ -1,25 +1,19 @@
-import os
-
 import obsws_python as obs
 
-req_cl = obs.ReqClient(
+req_cl = obs.ReqClient()
-    host=os.getenv("OBSWS_HOST", "localhost"),
-    port=int(os.getenv("OBSWS_PORT", 4455)),
-    password=os.getenv("OBSWS_PASSWORD", ""),
-)
 
 
 def setup_module():
-    req_cl.create_scene(scene_name="START_TEST")
+    req_cl.create_scene("START_TEST")
-    req_cl.create_scene(scene_name="BRB_TEST")
+    req_cl.create_scene("BRB_TEST")
-    req_cl.create_scene(scene_name="END_TEST")
+    req_cl.create_scene("END_TEST")
 
 
 def teardown_module():
-    req_cl.remove_scene(scene_name="START_TEST")
+    req_cl.remove_scene("START_TEST")
-    req_cl.remove_scene(scene_name="BRB_TEST")
+    req_cl.remove_scene("BRB_TEST")
-    req_cl.remove_scene(scene_name="END_TEST")
+    req_cl.remove_scene("END_TEST")
     resp = req_cl.get_studio_mode_enabled()
     if resp.studio_mode_enabled:
-        req_cl.set_studio_mode_enabled(studio_mode_enabled=False)
+        req_cl.set_studio_mode_enabled(False)
     req_cl.base_client.ws.close()

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_error.py

@@ -1,5 +1,3 @@
-import os
-
 import pytest
 
 import obsws_python as obsws
@@ -10,11 +8,7 @@ class TestErrors:
     __test__ = True
 
     def test_it_raises_an_obssdk_error_on_incorrect_password(self):
-        bad_conn = {
+        bad_conn = {"host": "localhost", "port": 4455, "password": "incorrectpassword"}
-            "host": os.getenv("OBSWS_HOST", "localhost"),
-            "port": int(os.getenv("OBSWS_PORT", 4455)),
-            "password": "incorrectpassword",
-        }
         with pytest.raises(
             obsws.error.OBSSDKError,
             match="failed to identify client with the server, please check connection settings",
@@ -22,11 +16,7 @@ class TestErrors:
             obsws.ReqClient(**bad_conn)
 
     def test_it_raises_an_obssdk_error_if_auth_enabled_but_no_password_provided(self):
-        bad_conn = {
+        bad_conn = {"host": "localhost", "port": 4455, "password": ""}
-            "host": os.getenv("OBSWS_HOST", "localhost"),
-            "port": int(os.getenv("OBSWS_PORT", 4455)),
-            "password": "",
-        }
         with pytest.raises(
             obsws.error.OBSSDKError,
             match="authentication enabled but no password provided",
@@ -38,7 +28,7 @@ class TestErrors:
             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(scene_name="invalid")
+            req_cl.set_current_program_scene("invalid")
 
         e = exc_info.value
         assert e.req_name == "SetCurrentProgramScene"

tests/test_request.py

@@ -11,10 +11,35 @@ class TestRequests:
         assert hasattr(resp, "obs_version")
         assert hasattr(resp, "obs_web_socket_version")
 
-    def test_get_hotkey_list(self):
+    def test_get_hot_key_list(self):
-        resp = req_cl.get_hotkey_list()
+        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",
@@ -24,20 +49,15 @@ class TestRequests:
         ],
     )
     def test_persistent_data(self, name, data):
-        req_cl.set_persistent_data(
+        req_cl.set_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name, data)
-            realm="OBS_WEBSOCKET_DATA_REALM_PROFILE", slot_name=name, slot_value=data
+        resp = req_cl.get_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name)
-        )
-        resp = req_cl.get_persistent_data(
-            realm="OBS_WEBSOCKET_DATA_REALM_PROFILE", slot_name=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(profile_name="test")
+        req_cl.create_profile("test")
         resp = req_cl.get_profile_list()
         assert "test" in resp.profiles
-        req_cl.remove_profile(profile_name="test")
+        req_cl.remove_profile("test")
         resp = req_cl.get_profile_list()
         assert "test" not in resp.profiles
 
@@ -47,8 +67,8 @@ class TestRequests:
             "key": "live_myvery_secretkey",
         }
         req_cl.set_stream_service_settings(
-            stream_service_type="rtmp_common",
+            "rtmp_common",
-            stream_service_settings=settings,
+            settings,
         )
         resp = req_cl.get_stream_service_settings()
         assert resp.stream_service_type == "rtmp_common"
@@ -66,40 +86,28 @@ class TestRequests:
         ],
     )
     def test_current_program_scene(self, scene):
-        req_cl.set_current_program_scene(scene_name=scene)
+        req_cl.set_current_program_scene(scene)
         resp = req_cl.get_current_program_scene()
         assert resp.current_program_scene_name == scene
 
     def test_input_list(self):
         req_cl.create_input(
-            scene_name="START_TEST",
+            "START_TEST", "test", "color_source_v3", {"color": 4294945535}, True
-            input_name="test",
-            input_kind="color_source_v3",
-            input_settings={"color": 4294945535},
-            scene_item_enabled=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:
+        resp = req_cl.get_input_settings("test")
-            # 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(input_name="test")
         assert resp.input_kind == "color_source_v3"
         assert resp.input_settings == {"color": 4294945535}
-        req_cl.remove_input(input_name="test")
+        req_cl.remove_input("test")
 
     def test_source_filter(self):
-        req_cl.create_source_filter(
+        req_cl.create_source_filter("START_TEST", "test", "color_key_filter_v2")
-            source_name="START_TEST",
+        resp = req_cl.get_source_filter_list("START_TEST")
-            filter_name="test",
-            filter_kind="color_key_filter_v2",
-        )
-        resp = req_cl.get_source_filter_list(source_name="START_TEST")
         assert resp.filters == [
             {
                 "filterEnabled": True,
@@ -109,7 +117,7 @@ class TestRequests:
                 "filterSettings": {},
             }
         ]
-        req_cl.remove_source_filter(source_name="START_TEST", filter_name="test")
+        req_cl.remove_source_filter("START_TEST", "test")
 
     @pytest.mark.parametrize(
         "state",
@@ -119,6 +127,6 @@ class TestRequests:
         ],
     )
     def test_studio_mode_enabled(self, state):
-        req_cl.set_studio_mode_enabled(studio_mode_enabled=state)
+        req_cl.set_studio_mode_enabled(state)
         resp = req_cl.get_studio_mode_enabled()
         assert resp.studio_mode_enabled == state