Compare commits

...

13 Commits

Author SHA1 Message Date
34067ca61d patch bump 2026-01-25 16:20:03 +00:00
3ca138ef6d add 0.24.6 to CHANGELOG 2026-01-25 16:19:37 +00:00
1b8bc72097 update Environment Variable section in README 2026-01-25 16:19:28 +00:00
3a8d4ef0f0 rename config module to envconfig
envconfig:
- add method for normalising the keys
- add has_key method
- update env var prefix to OBSWS_CLI_

update tests to reflect changes
2026-01-25 16:19:12 +00:00
1fc0bef237 dynamically load commands from obsws_cli.commands
no changes to files other than imports

patch bump
2026-01-24 22:29:33 +00:00
8bec6908e5 move studio mode enabled validation into callback
patch bump
2026-01-24 02:34:45 +00:00
2c03b28fc6 fix type annotations 2026-01-12 21:13:16 +00:00
f1e29e0d4f fix settings position 2026-01-10 14:21:30 +00:00
c7b60ecaf9 patch bump 2026-01-10 14:18:24 +00:00
a05fce26f2 add media and settings aliases on the root typer 2026-01-10 14:18:04 +00:00
5355d29a31 keep it consistent 2026-01-10 14:04:27 +00:00
add9743b00 patch bump 2026-01-10 14:00:20 +00:00
8aa1fb2c09 add validate.timecode_format
add None checks for callbacks with optional values
2026-01-10 13:59:55 +00:00
27 changed files with 278 additions and 181 deletions

View File

@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
# [0.24.6] - 2026-01-26
### Changed
- environment variables should now be prefixed with 'OBSWS_CLI_', see [Environment Variables](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#environment-variables)
# [0.24.0] - 2026-01-09 # [0.24.0] - 2026-01-09
### Added ### Added

View File

@ -62,9 +62,9 @@ Store and load environment variables from:
- `user home directory / .config / obsws-cli / obsws.env` - `user home directory / .config / obsws-cli / obsws.env`
```env ```env
OBS_HOST=localhost OBSWS_CLI_HOST=localhost
OBS_PORT=4455 OBSWS_CLI_PORT=4455
OBS_PASSWORD=<websocket password> OBSWS_CLI_PASSWORD=<websocket password>
``` ```
Flags can be used to override environment variables. Flags can be used to override environment variables.
@ -96,8 +96,8 @@ obsws-cli --style="cyan" --no-border sceneitem list
Or with environment variables: Or with environment variables:
```env ```env
OBS_STYLE=cyan OBSWS_CLI_STYLE=cyan
OBS_STYLE_NO_BORDER=true OBSWS_CLI_STYLE_NO_BORDER=true
``` ```
## Root Typer ## Root Typer

View File

@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online> # SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
# #
# SPDX-License-Identifier: MIT # SPDX-License-Identifier: MIT
__version__ = '0.24.1' __version__ = '0.24.6'

View File

@ -24,6 +24,8 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
cmd_name = 'hotkey' cmd_name = 'hotkey'
case 'i': case 'i':
cmd_name = 'input' cmd_name = 'input'
case 'm':
cmd_name = 'media'
case 'prf': case 'prf':
cmd_name = 'profile' cmd_name = 'profile'
case 'prj': case 'prj':
@ -40,6 +42,8 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
cmd_name = 'sceneitem' cmd_name = 'sceneitem'
case 'ss': case 'ss':
cmd_name = 'screenshot' cmd_name = 'screenshot'
case 'set':
cmd_name = 'settings'
case 'st': case 'st':
cmd_name = 'stream' cmd_name = 'stream'
case 'sm': case 'sm':

View File

@ -2,6 +2,7 @@
import importlib import importlib
import logging import logging
import pkgutil
from typing import Annotated from typing import Annotated
import obsws_python as obsws import obsws_python as obsws
@ -9,32 +10,15 @@ import typer
from obsws_cli.__about__ import __version__ as version from obsws_cli.__about__ import __version__ as version
from . import config, console, styles from . import commands, console, envconfig, styles
from .alias import RootTyperAliasGroup from .alias import RootTyperAliasGroup
app = typer.Typer(cls=RootTyperAliasGroup) app = typer.Typer(cls=RootTyperAliasGroup)
for sub_typer in ( for importer, modname, ispkg in pkgutil.iter_modules(
'filter', commands.__path__, commands.__name__ + '.'
'group',
'hotkey',
'input',
'media',
'profile',
'projector',
'record',
'replaybuffer',
'settings',
'scene',
'scenecollection',
'sceneitem',
'screenshot',
'stream',
'studiomode',
'text',
'virtualcam',
): ):
module = importlib.import_module(f'.{sub_typer}', package=__package__) subtyper = importlib.import_module(modname)
app.add_typer(module.app, name=sub_typer) app.add_typer(subtyper.app, name=modname.split('.')[-1])
def version_callback(value: bool): def version_callback(value: bool):
@ -70,62 +54,62 @@ def main(
typer.Option( typer.Option(
'--host', '--host',
'-H', '-H',
envvar='OBS_HOST', envvar='OBSWS_CLI_HOST',
help='WebSocket host', help='WebSocket host',
show_default='localhost', show_default='localhost',
), ),
] = config.get('host'), ] = envconfig.get('host'),
port: Annotated[ port: Annotated[
int, int,
typer.Option( typer.Option(
'--port', '--port',
'-P', '-P',
envvar='OBS_PORT', envvar='OBSWS_CLI_PORT',
help='WebSocket port', help='WebSocket port',
show_default=4455, show_default=4455,
), ),
] = config.get('port'), ] = envconfig.get('port'),
password: Annotated[ password: Annotated[
str, str,
typer.Option( typer.Option(
'--password', '--password',
'-p', '-p',
envvar='OBS_PASSWORD', envvar='OBSWS_CLI_PASSWORD',
help='WebSocket password', help='WebSocket password',
show_default=False, show_default=False,
), ),
] = config.get('password'), ] = envconfig.get('password'),
timeout: Annotated[ timeout: Annotated[
int, int,
typer.Option( typer.Option(
'--timeout', '--timeout',
'-T', '-T',
envvar='OBS_TIMEOUT', envvar='OBSWS_CLI_TIMEOUT',
help='WebSocket timeout', help='WebSocket timeout',
show_default=5, show_default=5,
), ),
] = config.get('timeout'), ] = envconfig.get('timeout'),
style: Annotated[ style: Annotated[
str, str,
typer.Option( typer.Option(
'--style', '--style',
'-s', '-s',
envvar='OBS_STYLE', envvar='OBSWS_CLI_STYLE',
help='Set the style for the CLI output', help='Set the style for the CLI output',
show_default='disabled', show_default='disabled',
callback=validate_style, callback=validate_style,
), ),
] = config.get('style'), ] = envconfig.get('style'),
no_border: Annotated[ no_border: Annotated[
bool, bool,
typer.Option( typer.Option(
'--no-border', '--no-border',
'-b', '-b',
envvar='OBS_STYLE_NO_BORDER', envvar='OBSWS_CLI_STYLE_NO_BORDER',
help='Disable table border styling in the CLI output', help='Disable table border styling in the CLI output',
show_default=False, show_default=False,
), ),
] = config.get('style_no_border'), ] = envconfig.get('style_no_border'),
version: Annotated[ version: Annotated[
bool, bool,
typer.Option( typer.Option(
@ -142,14 +126,14 @@ def main(
typer.Option( typer.Option(
'--debug', '--debug',
'-d', '-d',
envvar='OBS_DEBUG', envvar='OBSWS_CLI_DEBUG',
is_eager=True, is_eager=True,
help='Enable debug logging', help='Enable debug logging',
show_default=False, show_default=False,
callback=setup_logging, callback=setup_logging,
hidden=True, hidden=True,
), ),
] = config.get('debug'), ] = envconfig.get('debug'),
): ):
"""obsws_cli is a command line interface for the OBS WebSocket API.""" """obsws_cli is a command line interface for the OBS WebSocket API."""
ctx.ensure_object(dict) ctx.ensure_object(dict)

View File

@ -7,8 +7,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util from obsws_cli import console, util
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -6,9 +6,9 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util, validate from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
from .protocols import DataclassProtocol from obsws_cli.protocols import DataclassProtocol
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)
@ -31,7 +31,7 @@ def list_(
] = None, ] = None,
): ):
"""List groups in a scene.""" """List groups in a scene."""
if not scene_name: if scene_name is None:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)

View File

@ -6,8 +6,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -7,8 +7,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util, validate from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -4,8 +4,8 @@ from typing import Annotated, Optional
import typer import typer
from . import console, util from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)
@ -24,7 +24,9 @@ def cursor(
timecode: Annotated[ timecode: Annotated[
Optional[str], Optional[str],
typer.Argument( typer.Argument(
..., help='The timecode to set the cursor to (format: HH:MM:SS).' ...,
help='The timecode to set the cursor to (format: HH:MM:SS).',
callback=validate.timecode_format,
), ),
] = None, ] = None,
): ):

View File

@ -6,8 +6,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util, validate from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -6,8 +6,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -5,8 +5,8 @@ from typing import Annotated, Optional
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -2,8 +2,8 @@
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -6,8 +6,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util, validate from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)
@ -70,14 +70,14 @@ def list_(
def current( def current(
ctx: typer.Context, ctx: typer.Context,
preview: Annotated[ preview: Annotated[
bool, typer.Option(help='Get the preview scene instead of the program scene') bool,
typer.Option(
help='Get the preview scene instead of the program scene',
callback=validate.studio_mode_enabled,
),
] = False, ] = False,
): ):
"""Get the current program scene or preview scene.""" """Get the current program scene or preview scene."""
if preview and not validate.studio_mode_enabled(ctx):
console.err.print('Studio mode is not enabled, cannot get preview scene.')
raise typer.Exit(1)
if preview: if preview:
resp = ctx.obj['obsws'].get_current_preview_scene() resp = ctx.obj['obsws'].get_current_preview_scene()
console.out.print( console.out.print(
@ -103,14 +103,13 @@ def switch(
], ],
preview: Annotated[ preview: Annotated[
bool, bool,
typer.Option(help='Switch to the preview scene instead of the program scene'), typer.Option(
help='Switch to the preview scene instead of the program scene',
callback=validate.studio_mode_enabled,
),
] = False, ] = False,
): ):
"""Switch to a scene.""" """Switch to a scene."""
if preview and not validate.studio_mode_enabled(ctx):
console.err.print('Studio mode is not enabled, cannot set the preview scene.')
raise typer.Exit(1)
if preview: if preview:
ctx.obj['obsws'].set_current_preview_scene(scene_name) ctx.obj['obsws'].set_current_preview_scene(scene_name)
console.out.print( console.out.print(

View File

@ -5,8 +5,8 @@ from typing import Annotated
import typer import typer
from rich.table import Table from rich.table import Table
from . import console, validate from obsws_cli import console, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -5,8 +5,8 @@ from typing import Annotated, Optional
import typer import typer
from rich.table import Table from rich.table import Table
from . import console, util, validate from obsws_cli import console, util, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)
@ -30,7 +30,7 @@ def list_(
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False, uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
): ):
"""List all items in a scene.""" """List all items in a scene."""
if not scene_name: if scene_name is None:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)

View File

@ -6,8 +6,8 @@ from typing import Annotated
import obsws_python as obsws import obsws_python as obsws
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -6,8 +6,8 @@ import typer
from rich.table import Table from rich.table import Table
from rich.text import Text from rich.text import Text
from . import console, util from obsws_cli import console, util
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -2,8 +2,8 @@
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -2,8 +2,8 @@
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -4,8 +4,8 @@ from typing import Annotated, Optional
import typer import typer
from . import console, validate from obsws_cli import console, validate
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -2,8 +2,8 @@
import typer import typer
from . import console from obsws_cli import console
from .alias import SubTyperAliasGroup from obsws_cli.alias import SubTyperAliasGroup
app = typer.Typer(cls=SubTyperAliasGroup) app = typer.Typer(cls=SubTyperAliasGroup)

View File

@ -1,80 +0,0 @@
"""module for settings management for obsws-cli."""
from collections import UserDict
from pathlib import Path
from dotenv import dotenv_values
ConfigValue = str | int
class Config(UserDict):
"""A class to manage config for obsws-cli.
This class extends UserDict to provide a dictionary-like interface for config.
It loads config from environment variables and .env files.
The config values are expected to be in uppercase and should start with 'OBS_'.
Example:
-------
config = Config()
host = config['OBS_HOST']
config['OBS_PORT'] = 4455
"""
PREFIX = 'OBS_'
def __init__(self, *args, **kwargs):
"""Initialize the Settings object."""
kwargs.update(
{
**dotenv_values('.env'),
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
}
)
super().__init__(*args, **kwargs)
def __getitem__(self, key: str) -> ConfigValue:
"""Get a setting value by key."""
key = key.upper()
if not key.startswith(Config.PREFIX):
key = f'{Config.PREFIX}{key}'
return self.data[key]
def __setitem__(self, key: str, value: ConfigValue):
"""Set a setting value by key."""
key = key.upper()
if not key.startswith(Config.PREFIX):
key = f'{Config.PREFIX}{key}'
self.data[key] = value
_config = Config(
OBS_HOST='localhost',
OBS_PORT=4455,
OBS_PASSWORD='',
OBS_TIMEOUT=5,
OBS_DEBUG=False,
OBS_STYLE='disabled',
OBS_STYLE_NO_BORDER=False,
)
def get(key: str) -> ConfigValue:
"""Get a setting value by key.
Args:
----
key (str): The key of the config to retrieve.
Returns:
-------
The value of the config.
Raises:
------
KeyError: If the key does not exist in the config.
"""
return _config[key]

146
obsws_cli/envconfig.py Normal file
View File

@ -0,0 +1,146 @@
"""module for settings management for obsws-cli."""
from collections import UserDict
from pathlib import Path
from typing import Any, Union
from dotenv import dotenv_values
ConfigValue = Union[str, int, bool]
class EnvConfig(UserDict):
"""A class to manage .env config for obsws-cli.
This class extends UserDict to provide a dictionary-like interface for config.
It loads config from .env files in the following priority:
1. Local .env file
2. User config file (~/.config/obsws-cli/obsws.env)
3. Default values
Note, typer handles reading from environment variables automatically. They take precedence
over values set in this class.
The config values are expected to be in uppercase and should start with 'OBSWS_CLI_'.
Example:
-------
config = EnvConfig()
host = config['OBSWS_CLI_HOST']
config['OBSWS_CLI_PORT'] = 4455
# Or with defaults
timeout = config.get('OBSWS_CLI_TIMEOUT', 30)
# Keys will be normalised to uppercase with prefix
debug = config.get('debug', False) # Equivalent to 'OBSWS_CLI_DEBUG'
"""
PREFIX = 'OBSWS_CLI_'
def __init__(self, *args, **kwargs):
"""Initialize the Config object with hierarchical loading."""
kwargs.update(
{
**dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
**dotenv_values('.env'),
}
)
super().__init__(*args, **self._convert_types(kwargs))
def _convert_types(self, config_data: dict[str, Any]) -> dict[str, ConfigValue]:
"""Convert string values to appropriate types."""
converted = {}
for key, value in config_data.items():
if isinstance(value, str):
if value.lower() in ('true', 'false'):
converted[key] = value.lower() == 'true'
elif value.isdigit():
converted[key] = int(value)
else:
converted[key] = value
else:
converted[key] = value
return converted
def __getitem__(self, key: str) -> ConfigValue:
"""Get a setting value by key."""
normalised_key = self._normalise_key(key)
try:
return self.data[normalised_key]
except KeyError as e:
raise KeyError(
f"Config key '{key}' not found. Available keys: {list(self.data.keys())}"
) from e
def __setitem__(self, key: str, value: ConfigValue):
"""Set a setting value by key."""
normalised_key = self._normalise_key(key)
self.data[normalised_key] = value
def _normalise_key(self, key: str) -> str:
"""Normalise a key to uppercase with OBS_ prefix."""
key = key.upper()
if not key.startswith(self.PREFIX):
key = f'{self.PREFIX}{key}'
return key
def get(self, key: str, default=None) -> ConfigValue:
"""Get a config value with optional default.
Args:
----
key (str): The key to retrieve
default: Default value if key is not found
Returns:
-------
The config value or default
"""
normalised_key = self._normalise_key(key)
if not self.has_key(normalised_key):
return default
return self[normalised_key]
def has_key(self, key: str) -> bool:
"""Check if a config key exists.
Args:
----
key (str): The key to check
Returns:
-------
bool: True if key exists, False otherwise
"""
normalised_key = self._normalise_key(key)
return normalised_key in self.data
_envconfig = EnvConfig(
OBSWS_CLI_HOST='localhost',
OBSWS_CLI_PORT=4455,
OBSWS_CLI_PASSWORD='',
OBSWS_CLI_TIMEOUT=5,
OBSWS_CLI_DEBUG=False,
OBSWS_CLI_STYLE='disabled',
OBSWS_CLI_STYLE_NO_BORDER=False,
)
def get(key: str) -> ConfigValue:
"""Get a setting value by key from the global config instance.
Args:
----
key (str): The key of the config to retrieve.
default: Default value if key is not found.
Returns:
-------
The value of the config or default value.
"""
return _envconfig.get(key)

View File

@ -1,5 +1,7 @@
"""module containing validation functions.""" """module containing validation functions."""
from typing import Optional
import typer import typer
from . import console from . import console
@ -8,7 +10,7 @@ from . import console
skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False) skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
def input_in_inputs(ctx: typer.Context, input_name: str) -> bool: def input_in_inputs(ctx: typer.Context, input_name: str) -> str:
"""Ensure the given input exists in the list of inputs.""" """Ensure the given input exists in the list of inputs."""
resp = ctx.obj['obsws'].get_input_list() resp = ctx.obj['obsws'].get_input_list()
if not any(input.get('inputName') == input_name for input in resp.inputs): if not any(input.get('inputName') == input_name for input in resp.inputs):
@ -17,7 +19,7 @@ def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
return input_name return input_name
def input_not_in_inputs(ctx: typer.Context, input_name: str) -> bool: def input_not_in_inputs(ctx: typer.Context, input_name: str) -> str:
"""Ensure an input does not already exist in the list of inputs.""" """Ensure an input does not already exist in the list of inputs."""
resp = ctx.obj['obsws'].get_input_list() resp = ctx.obj['obsws'].get_input_list()
if any(input.get('inputName') == input_name for input in resp.inputs): if any(input.get('inputName') == input_name for input in resp.inputs):
@ -26,8 +28,11 @@ def input_not_in_inputs(ctx: typer.Context, input_name: str) -> bool:
return input_name return input_name
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> str: def scene_in_scenes(ctx: typer.Context, scene_name: Optional[str]) -> str | None:
"""Check if a scene exists in the list of scenes.""" """Check if a scene exists in the list of scenes."""
if scene_name is None:
return
resp = ctx.obj['obsws'].get_scene_list() resp = ctx.obj['obsws'].get_scene_list()
if not any(scene.get('sceneName') == scene_name for scene in resp.scenes): if not any(scene.get('sceneName') == scene_name for scene in resp.scenes):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.') console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
@ -35,10 +40,15 @@ def scene_in_scenes(ctx: typer.Context, scene_name: str) -> str:
return scene_name return scene_name
def studio_mode_enabled(ctx: typer.Context) -> bool: def studio_mode_enabled(ctx: typer.Context, preview: bool) -> bool:
"""Check if studio mode is enabled.""" """Ensure studio mode is enabled if preview option is used."""
resp = ctx.obj['obsws'].get_studio_mode_enabled() resp = ctx.obj['obsws'].get_studio_mode_enabled()
return resp.studio_mode_enabled if preview and not resp.studio_mode_enabled:
console.err.print(
'Studio mode is disabled. This action requires it to be enabled.'
)
raise typer.Exit(1)
return preview
def scene_collection_in_scene_collections( def scene_collection_in_scene_collections(
@ -104,3 +114,29 @@ def kind_in_input_kinds(ctx: typer.Context, input_kind: str) -> str:
console.err.print(f'Input kind [yellow]{input_kind}[/yellow] not found.') console.err.print(f'Input kind [yellow]{input_kind}[/yellow] not found.')
raise typer.Exit(1) raise typer.Exit(1)
return input_kind return input_kind
def timecode_format(ctx: typer.Context, timecode: Optional[str]) -> str | None:
"""Validate that a timecode is in HH:MM:SS or MM:SS format."""
if timecode is None:
return
match timecode.split(':'):
case [mm, ss]:
if not (mm.isdigit() and ss.isdigit()):
console.err.print(
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
)
raise typer.Exit(1)
case [hh, mm, ss]:
if not (hh.isdigit() and mm.isdigit() and ss.isdigit()):
console.err.print(
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
)
raise typer.Exit(1)
case _:
console.err.print(
f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
)
raise typer.Exit(1)
return timecode

View File

@ -21,9 +21,9 @@ def pytest_sessionstart(session):
""" """
# Initialize the OBS WebSocket client # Initialize the OBS WebSocket client
session.obsws = obsws.ReqClient( session.obsws = obsws.ReqClient(
host=os.environ['OBS_HOST'], host=os.environ['OBSWS_CLI_HOST'],
port=os.environ['OBS_PORT'], port=os.environ['OBSWS_CLI_PORT'],
password=os.environ['OBS_PASSWORD'], password=os.environ['OBSWS_CLI_PASSWORD'],
timeout=5, timeout=5,
) )
resp = session.obsws.get_version() resp = session.obsws.get_version()