mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2025-06-07 20:20:32 +01:00
validate preview mode enabled to clean up stack traces
This commit is contained in:
parent
2175fb8788
commit
e64b9311d4
@ -2,11 +2,10 @@
|
|||||||
|
|
||||||
from typing import Annotated
|
from typing import Annotated
|
||||||
|
|
||||||
import obsws_python as obsws
|
|
||||||
import typer
|
import typer
|
||||||
|
|
||||||
|
from . import validate
|
||||||
from .alias import AliasGroup
|
from .alias import AliasGroup
|
||||||
from .errors import ObswsCliBadParameter, ObswsCliError
|
|
||||||
|
|
||||||
app = typer.Typer(cls=AliasGroup)
|
app = typer.Typer(cls=AliasGroup)
|
||||||
|
|
||||||
@ -24,6 +23,12 @@ def list(ctx: typer.Context):
|
|||||||
typer.echo('\n'.join(scenes))
|
typer.echo('\n'.join(scenes))
|
||||||
|
|
||||||
|
|
||||||
|
def _studio_mode_enabled(ctx: typer.Context) -> bool:
|
||||||
|
"""Check if studio mode is enabled."""
|
||||||
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
|
return resp.studio_mode_enabled
|
||||||
|
|
||||||
|
|
||||||
@app.command('current | get')
|
@app.command('current | get')
|
||||||
def current(
|
def current(
|
||||||
ctx: typer.Context,
|
ctx: typer.Context,
|
||||||
@ -32,20 +37,16 @@ def current(
|
|||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""Get the current program scene or preview scene."""
|
"""Get the current program scene or preview scene."""
|
||||||
try:
|
if preview and not _studio_mode_enabled(ctx):
|
||||||
|
typer.echo('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()
|
||||||
typer.echo(resp.current_preview_scene_name)
|
typer.echo(resp.current_preview_scene_name)
|
||||||
else:
|
else:
|
||||||
resp = ctx.obj['obsws'].get_current_program_scene()
|
resp = ctx.obj['obsws'].get_current_program_scene()
|
||||||
typer.echo(resp.current_program_scene_name)
|
typer.echo(resp.current_program_scene_name)
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
|
||||||
match e.code:
|
|
||||||
case 506:
|
|
||||||
raise ObswsCliError(
|
|
||||||
'Not in studio mode, cannot get preview scene.'
|
|
||||||
) from e
|
|
||||||
raise
|
|
||||||
|
|
||||||
|
|
||||||
@app.command('switch | set')
|
@app.command('switch | set')
|
||||||
@ -58,17 +59,18 @@ def switch(
|
|||||||
] = False,
|
] = False,
|
||||||
):
|
):
|
||||||
"""Switch to a scene."""
|
"""Switch to a scene."""
|
||||||
try:
|
if preview and not _studio_mode_enabled(ctx):
|
||||||
|
typer.echo('Studio mode is not enabled, cannot set the preview scene.')
|
||||||
|
raise typer.Exit(1)
|
||||||
|
|
||||||
|
if not validate.scene_in_scenes(ctx, scene_name):
|
||||||
|
typer.echo(
|
||||||
|
f"Scene '{scene_name}' not found.",
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
|
raise typer.Exit(code=1)
|
||||||
|
|
||||||
if preview:
|
if preview:
|
||||||
ctx.obj['obsws'].set_current_preview_scene(scene_name)
|
ctx.obj['obsws'].set_current_preview_scene(scene_name)
|
||||||
else:
|
else:
|
||||||
ctx.obj['obsws'].set_current_program_scene(scene_name)
|
ctx.obj['obsws'].set_current_program_scene(scene_name)
|
||||||
except obsws.error.OBSSDKRequestError as e:
|
|
||||||
match e.code:
|
|
||||||
case 506:
|
|
||||||
raise ObswsCliError(
|
|
||||||
'Not in studio mode, cannot set preview scene.'
|
|
||||||
) from e
|
|
||||||
case 600:
|
|
||||||
raise ObswsCliBadParameter(f"Scene '{scene_name}' not found.") from e
|
|
||||||
raise
|
|
||||||
|
21
obsws_cli/validate.py
Normal file
21
obsws_cli/validate.py
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
"""module containing functions to validate input parameters."""
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
|
||||||
|
def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
|
||||||
|
"""Check if an input is in the input list."""
|
||||||
|
inputs = ctx.obj['obsws'].get_input_list().inputs
|
||||||
|
return any(input_.get('inputName') == input_name for input_ in inputs)
|
||||||
|
|
||||||
|
|
||||||
|
def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
|
||||||
|
"""Check if a scene exists in the list of scenes."""
|
||||||
|
resp = ctx.obj['obsws'].get_scene_list()
|
||||||
|
return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
|
||||||
|
|
||||||
|
|
||||||
|
def studio_mode_enabled(ctx: typer.Context) -> bool:
|
||||||
|
"""Check if studio mode is enabled."""
|
||||||
|
resp = ctx.obj['obsws'].get_studio_mode_enabled()
|
||||||
|
return resp.studio_mode_enabled
|
Loading…
x
Reference in New Issue
Block a user