40 Commits

Author SHA1 Message Date
3d312c18ed upd .gitignore 2026-03-26 07:39:20 +00:00
9d99ea0aea add autogenerated reqclient methods
update tests so they pass

add Taskfile

add hatch-dotenv plugin
2026-03-26 07:05:34 +00:00
4e9fb934be fix payload key 2025-07-05 15:42:40 +01:00
82baa40e79 reqclient rework initial commit
position arguments removed.

keyword-only argument enforced.

type annotations added

this is a breaking change and would required a major version bump.
2025-06-28 14:24:50 +01:00
3bce50701e add v5.4, v5.5 methods
v5.4:
- get_source_filter_kind_list
- get_scene_item_source

v5.5:
- split_record_file
- create_record_chapter

minor bump
2025-06-23 06:25:31 +01:00
8e8062d5c8 Merge pull request #57 from onyx-and-iris/dev
Return response class for toggle_record
2025-05-14 20:19:49 +01:00
6f64e884d8 md fix 2025-05-07 22:00:19 +01:00
90abc4f9ee upd test_get_hot_key_list
- check hotkey list is not empty
- check it has at least one OBSBasic. hotkey.
2025-05-07 19:13:09 +01:00
f564f53c69 return response class for toggle_record()
patch bump
2025-05-07 18:42:29 +01:00
4d9dfa9d11 Merge pull request #55 from onyx-and-iris/dev
Update tests
2025-02-11 14:19:27 +00:00
9e361f0f8a fix hatch link 2025-02-11 10:16:56 +00:00
797161a6f2 import Callable, Iterable from collections.abs instead of typing.
update tests to reflect changes in the API.

reorganise hatch envs

add black,isort configs to pyproject.toml

add pre-commit config
2025-02-11 09:51:00 +00:00
0fe78197fc Merge branch 'aatikturk:main' into dev 2025-02-10 12:27:07 +00:00
Adem
9c4c5a1df9 Merge pull request #53 from Zynthasius39/dev-zynt
Fix Trigger Hotkey Methods
2025-02-10 15:02:36 +03:00
f52ac163b8 patch bump version 2025-02-10 09:12:09 +00:00
Zynthasius39
197a60a7cd Fix trigger_hot_key_by_key_sequence() method 2025-02-08 18:31:12 +04:00
Zynthasius39
633093ead4 Fix trigger_hot_key_by_name() method 2025-02-08 17:59:45 +04:00
935392a0b6 Merge branch 'aatikturk:main' into dev 2025-01-25 22:34:36 +00:00
d2f2926334 Merge pull request #51 from marzeq/patch-1
Fix project.license field in pyproject.toml so that setup.py doesn't fail
2025-01-25 21:48:55 +00:00
marzeq
58cd50dd6c Fix project.license field in pyproject.toml so that setup.py doesn't fail 2025-01-25 21:34:27 +01:00
7614cdfe4a add py12 to test matrix 2024-02-21 14:15:40 +00:00
Adem
9402f2e472 Merge pull request #43 from onyx-and-iris/fix-disconnect
Add disconnect() methods. Default ws timeout to None for event thread.
2024-01-21 15:45:06 +03:00
ef8df5cf4d bump to 1.7.0 2024-01-21 12:34:10 +00:00
1abca0c7e4 bump to 1.7.0b0 2024-01-09 15:37:33 +00:00
85180c1d94 upd variable name 2024-01-09 12:17:47 +00:00
f4db1ad95c fix prompt 2024-01-07 14:37:15 +00:00
efaee7594e should a socket operation be attempted after socket closed
then catch and log OSError and close thread.
2024-01-07 12:35:20 +00:00
2cebd5eedb upd examples, they now use context managers 2024-01-07 11:21:01 +00:00
cac236c004 removes timeout for socket before starting worker thread 2024-01-07 11:19:33 +00:00
6aa6db09eb adds an event object and listens until its set
sets the event object on WebSocketConnectionClosedException

adds __enter__(), __exit__() methods

adds disconnect() to event client. aliases it as unsubscribe

checks for non-empty response with:
`if r := self.base_client.ws.recv()`
before attempting to json.load() it.
2024-01-05 09:57:08 +00:00
f1c2efa4a1 adds disconnect() method to ReqClient
now calling disconnect() in __exit__()
2024-01-05 09:36:02 +00:00
Adem
4654d2529f Merge pull request #39 from onyx-and-iris/dev
patch bump for PR #37
2023-10-23 14:58:56 +03:00
1494208f63 patch bump for issue #37 2023-10-23 12:43:59 +01:00
Adem
d217630289 Merge pull request #37 from aatikturk/implement_v5.3_methods
Update reqs.py

implemented  set_record_directory method. (only availabe for obs websocket v5.3 or higher)
2023-10-23 14:00:08 +03:00
Adem
5bfe792fa6 Update reqs.py
added set_record_directory  method to ReqClient.
2023-10-23 09:29:16 +03:00
3c36619173 Merge pull request #36 from onyx-and-iris/add-projector-methods
Add projector methods
2023-10-10 17:38:53 +01:00
c4cf817042 split at full stop 2023-10-09 22:34:05 +01:00
ba5da8dfef upd obsbasic hotkey list in tests 2023-10-09 22:29:18 +01:00
83577e2d61 adds projector methods with a deprecation warning
patch bump

closes #35
2023-10-09 22:06:18 +01:00
Adem
8aa2e78ba6 Merge pull request #32 from onyx-and-iris/add-request-error-class
Error handling with base error class
2023-08-14 14:38:43 +03:00
18 changed files with 2772 additions and 1539 deletions

181
.gitignore vendored
View File

@@ -1,8 +1,14 @@
# Generated by ignr: github.com/onyx-and-iris/ignr
## Python ##
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*.py[codz]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
@@ -17,11 +23,22 @@ 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/
@@ -32,27 +49,169 @@ 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
# 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
# Spyder project settings
.spyderproject
.spyproject
# Test/config
quick.py
config.toml
obsws.log
# Rope project settings
.ropeproject
.vscode/
# mkdocs documentation
/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

10
.pre-commit-config.yaml Normal file
View File

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

View File

@@ -1,5 +1,6 @@
[![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/)
@@ -92,7 +93,7 @@ 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)
For a full list of requests refer to [Requests][obsws-reqs]
### Events
@@ -125,7 +126,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](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events)
For a full list of events refer to [Events][obsws-events]
### Attributes
@@ -149,7 +150,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](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
- For a full list of status codes refer to [Codes][obsws-codes]
### Logging
@@ -168,18 +169,21 @@ logging.basicConfig(level=logging.DEBUG)
### Tests
First install development dependencies:
`pip install -e .['dev']`
To run all tests:
Install [hatch][hatch-install] and then:
```
pytest -v
hatch test
```
### Official Documentation
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][obsws-pro]
[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/

23
Taskfile.yaml Normal file
View File

@@ -0,0 +1,23 @@
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

View File

@@ -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)

View File

@@ -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")

View File

@@ -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()

View File

@@ -96,10 +96,8 @@ 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()

View File

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

View File

@@ -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

File diff suppressed because it is too large Load Diff

View File

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

View File

@@ -7,23 +7,10 @@ name = "obsws-python"
dynamic = ["version"]
description = "A Python SDK for OBS Studio WebSocket v5.0"
readme = "README.md"
license = "GPL-3.0-only"
license = { text = "GPL-3.0-only" }
requires-python = ">=3.9"
authors = [
{ 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",
]
authors = [{ name = "Adem Atikturk", email = "aatikturk@gmail.com" }]
dependencies = ["tomli >= 2.0.1;python_version < '3.11'", "websocket-client"]
[project.urls]
Homepage = "https://github.com/aatikturk/obsws-python"
@@ -32,9 +19,16 @@ 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.envs.default]
dependencies = ["pre-commit"]
[tool.hatch.envs.e]
dependencies = ["keyboard"]
[tool.hatch.envs.e.scripts]
events = "python {root}\\examples\\events\\."
@@ -42,13 +36,42 @@ hotkeys = "python {root}\\examples\\hotkeys\\."
levels = "python {root}\\examples\\levels\\."
scene_rotate = "python {root}\\examples\\scene_rotate\\."
[tool.hatch.envs.test]
dependencies = [
"pytest",
]
[tool.hatch.envs.hatch-test]
randomize = true
env-include = ["OBSWS_TEST_*"]
[tool.hatch.envs.test.scripts]
run = 'pytest -v'
[tool.hatch.env.collectors.dotenv.hatch-test]
env-files = [".env"]
fail-on-missing = true
[[tool.hatch.envs.test.matrix]]
python = ["39", "310", "311"]
[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", "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/*"]

View File

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

View File

@@ -18,7 +18,12 @@ class TestAttrs:
def test_get_current_program_scene_attrs(self):
resp = req_cl.get_current_program_scene()
assert resp.attrs() == ["current_program_scene_name"]
assert resp.attrs() == [
"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()

View File

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

View File

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

View File

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