5 Commits

7 changed files with 106 additions and 76 deletions

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.0' __version__ = '0.24.1'

View File

@@ -26,6 +26,7 @@ def list_(
typer.Argument( typer.Argument(
show_default='The current scene', show_default='The current scene',
help='Scene name to list groups for', help='Scene name to list groups for',
callback=validate.scene_in_scenes,
), ),
] = None, ] = None,
): ):
@@ -33,10 +34,6 @@ def list_(
if not scene_name: if not scene_name:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
groups = [ groups = [
(item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled')) (item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
@@ -92,17 +89,18 @@ def show(
ctx: typer.Context, ctx: typer.Context,
scene_name: Annotated[ scene_name: Annotated[
str, str,
typer.Argument(..., show_default=False, help='Scene name the group is in'), typer.Argument(
...,
show_default=False,
help='Scene name the group is in',
callback=validate.scene_in_scenes,
),
], ],
group_name: Annotated[ group_name: Annotated[
str, typer.Argument(..., show_default=False, help='Group name to show') str, typer.Argument(..., show_default=False, help='Group name to show')
], ],
): ):
"""Show a group in a scene.""" """Show a group in a scene."""
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
@@ -123,17 +121,19 @@ def show(
def hide( def hide(
ctx: typer.Context, ctx: typer.Context,
scene_name: Annotated[ scene_name: Annotated[
str, typer.Argument(..., show_default=False, help='Scene name the group is in') str,
typer.Argument(
...,
show_default=False,
help='Scene name the group is in',
callback=validate.scene_in_scenes,
),
], ],
group_name: Annotated[ group_name: Annotated[
str, typer.Argument(..., show_default=False, help='Group name to hide') str, typer.Argument(..., show_default=False, help='Group name to hide')
], ],
): ):
"""Hide a group in a scene.""" """Hide a group in a scene."""
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
@@ -154,17 +154,19 @@ def hide(
def toggle( def toggle(
ctx: typer.Context, ctx: typer.Context,
scene_name: Annotated[ scene_name: Annotated[
str, typer.Argument(..., show_default=False, help='Scene name the group is in') str,
typer.Argument(
...,
show_default=False,
help='Scene name the group is in',
callback=validate.scene_in_scenes,
),
], ],
group_name: Annotated[ group_name: Annotated[
str, typer.Argument(..., show_default=False, help='Group name to toggle') str, typer.Argument(..., show_default=False, help='Group name to toggle')
], ],
): ):
"""Toggle a group in a scene.""" """Toggle a group in a scene."""
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(
@@ -189,17 +191,19 @@ def toggle(
def status( def status(
ctx: typer.Context, ctx: typer.Context,
scene_name: Annotated[ scene_name: Annotated[
str, typer.Argument(..., show_default=False, help='Scene name the group is in') str,
typer.Argument(
...,
show_default=False,
help='Scene name the group is in',
callback=validate.scene_in_scenes,
),
], ],
group_name: Annotated[ group_name: Annotated[
str, typer.Argument(..., show_default=False, help='Group name to check status') str, typer.Argument(..., show_default=False, help='Group name to check status')
], ],
): ):
"""Get the status of a group in a scene.""" """Get the status of a group in a scene."""
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
if (group := _get_group(group_name, resp)) is None: if (group := _get_group(group_name, resp)) is None:
console.err.print( console.err.print(

View File

@@ -62,15 +62,14 @@ def switch(
profile_name: Annotated[ profile_name: Annotated[
str, str,
typer.Argument( typer.Argument(
..., show_default=False, help='Name of the profile to switch to' ...,
show_default=False,
help='Name of the profile to switch to',
callback=validate.profile_exists,
), ),
], ],
): ):
"""Switch to a profile.""" """Switch to a profile."""
if not validate.profile_exists(ctx, profile_name):
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj['obsws'].get_profile_list()
if resp.current_profile_name == profile_name: if resp.current_profile_name == profile_name:
console.err.print( console.err.print(
@@ -87,14 +86,15 @@ def create(
ctx: typer.Context, ctx: typer.Context,
profile_name: Annotated[ profile_name: Annotated[
str, str,
typer.Argument(..., show_default=False, help='Name of the profile to create.'), typer.Argument(
...,
show_default=False,
help='Name of the profile to create.',
callback=validate.profile_not_exists,
),
], ],
): ):
"""Create a new profile.""" """Create a new profile."""
if validate.profile_exists(ctx, profile_name):
console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
raise typer.Exit(1)
ctx.obj['obsws'].create_profile(profile_name) ctx.obj['obsws'].create_profile(profile_name)
console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.') console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
@@ -104,13 +104,14 @@ def remove(
ctx: typer.Context, ctx: typer.Context,
profile_name: Annotated[ profile_name: Annotated[
str, str,
typer.Argument(..., show_default=False, help='Name of the profile to remove.'), typer.Argument(
...,
show_default=False,
help='Name of the profile to remove.',
callback=validate.profile_exists,
),
], ],
): ):
"""Remove a profile.""" """Remove a profile."""
if not validate.profile_exists(ctx, profile_name):
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
raise typer.Exit(1)
ctx.obj['obsws'].remove_profile(profile_name) ctx.obj['obsws'].remove_profile(profile_name)
console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.') console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')

View File

@@ -94,7 +94,12 @@ def current(
def switch( def switch(
ctx: typer.Context, ctx: typer.Context,
scene_name: Annotated[ scene_name: Annotated[
str, typer.Argument(..., help='Name of the scene to switch to') str,
typer.Argument(
...,
help='Name of the scene to switch to',
callback=validate.scene_in_scenes,
),
], ],
preview: Annotated[ preview: Annotated[
bool, bool,
@@ -106,10 +111,6 @@ def switch(
console.err.print('Studio mode is not enabled, cannot set the preview scene.') console.err.print('Studio mode is not enabled, cannot set the preview scene.')
raise typer.Exit(1) raise typer.Exit(1)
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
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

@@ -53,16 +53,15 @@ def current(ctx: typer.Context):
def switch( def switch(
ctx: typer.Context, ctx: typer.Context,
scene_collection_name: Annotated[ scene_collection_name: Annotated[
str, typer.Argument(..., help='Name of the scene collection to switch to') str,
typer.Argument(
...,
help='Name of the scene collection to switch to',
callback=validate.scene_collection_in_scene_collections,
),
], ],
): ):
"""Switch to a scene collection.""" """Switch to a scene collection."""
if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
console.err.print(
f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
)
raise typer.Exit(1)
current_scene_collection = ( current_scene_collection = (
ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
) )
@@ -82,16 +81,15 @@ def switch(
def create( def create(
ctx: typer.Context, ctx: typer.Context,
scene_collection_name: Annotated[ scene_collection_name: Annotated[
str, typer.Argument(..., help='Name of the scene collection to create') str,
typer.Argument(
...,
help='Name of the scene collection to create',
callback=validate.scene_collection_not_in_scene_collections,
),
], ],
): ):
"""Create a new scene collection.""" """Create a new scene collection."""
if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
console.err.print(
f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
)
raise typer.Exit(1)
ctx.obj['obsws'].create_scene_collection(scene_collection_name) ctx.obj['obsws'].create_scene_collection(scene_collection_name)
console.out.print( console.out.print(
f'Created scene collection {console.highlight(ctx, scene_collection_name)}.' f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'

View File

@@ -24,6 +24,7 @@ def list_(
typer.Argument( typer.Argument(
show_default='The current scene', show_default='The current scene',
help='Scene name to list items for', help='Scene name to list items for',
callback=validate.scene_in_scenes,
), ),
] = None, ] = None,
uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False, uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
@@ -32,10 +33,6 @@ def list_(
if not scene_name: if not scene_name:
scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
if not validate.scene_in_scenes(ctx, scene_name):
console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
raise typer.Exit(1)
resp = ctx.obj['obsws'].get_scene_item_list(scene_name) resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
items = sorted( items = sorted(
( (

View File

@@ -26,10 +26,13 @@ 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) -> bool: def scene_in_scenes(ctx: typer.Context, scene_name: str) -> str:
"""Check if a scene exists in the list of scenes.""" """Check if a scene exists in the list of scenes."""
resp = ctx.obj['obsws'].get_scene_list() resp = ctx.obj['obsws'].get_scene_list()
return 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.')
raise typer.Exit(1)
return scene_name
def studio_mode_enabled(ctx: typer.Context) -> bool: def studio_mode_enabled(ctx: typer.Context) -> bool:
@@ -40,12 +43,32 @@ def studio_mode_enabled(ctx: typer.Context) -> bool:
def scene_collection_in_scene_collections( def scene_collection_in_scene_collections(
ctx: typer.Context, scene_collection_name: str ctx: typer.Context, scene_collection_name: str
) -> bool: ) -> str:
"""Check if a scene collection exists.""" """Ensure a scene collection exists in the list of scene collections."""
resp = ctx.obj['obsws'].get_scene_collection_list() resp = ctx.obj['obsws'].get_scene_collection_list()
return any( if not any(
collection == scene_collection_name for collection in resp.scene_collections collection == scene_collection_name for collection in resp.scene_collections
):
console.err.print(
f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
) )
raise typer.Exit(1)
return scene_collection_name
def scene_collection_not_in_scene_collections(
ctx: typer.Context, scene_collection_name: str
) -> str:
"""Ensure a scene collection does not already exist in the list of scene collections."""
resp = ctx.obj['obsws'].get_scene_collection_list()
if any(
collection == scene_collection_name for collection in resp.scene_collections
):
console.err.print(
f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
)
raise typer.Exit(1)
return scene_collection_name
def item_in_scene_item_list( def item_in_scene_item_list(
@@ -56,16 +79,22 @@ def item_in_scene_item_list(
return any(item.get('sourceName') == item_name for item in resp.scene_items) return any(item.get('sourceName') == item_name for item in resp.scene_items)
def profile_exists(ctx: typer.Context, profile_name: str) -> bool: def profile_exists(ctx: typer.Context, profile_name: str) -> str:
"""Check if a profile exists.""" """Ensure a profile exists."""
resp = ctx.obj['obsws'].get_profile_list() resp = ctx.obj['obsws'].get_profile_list()
return any(profile == profile_name for profile in resp.profiles) if not any(profile == profile_name for profile in resp.profiles):
console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
raise typer.Exit(1)
return profile_name
def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool: def profile_not_exists(ctx: typer.Context, profile_name: str) -> str:
"""Check if a monitor exists.""" """Ensure a profile does not exist."""
resp = ctx.obj['obsws'].get_monitor_list() resp = ctx.obj['obsws'].get_profile_list()
return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors) if any(profile == profile_name for profile in resp.profiles):
console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
raise typer.Exit(1)
return profile_name
def kind_in_input_kinds(ctx: typer.Context, input_kind: str) -> str: def kind_in_input_kinds(ctx: typer.Context, input_kind: str) -> str: