onyx_online/obsws-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-cli.git synced 2025-06-07 20:20:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

print a more useful sceneitem list table

Browse Source 
--parent flag for sceneitem commands renamed to --group

should an item in a group be passed without the --group option, print a more useful error message.

README updated to reflect change
This commit is contained in:
onyx-and-iris 2025-05-29 14:45:49 +01:00
parent 2127d175c7
commit e637c0456e
2 changed files with 144 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -111,7 +111,7 @@ obsws-cli sceneitem list LIVE
- flags: - flags:
*optional* *optional*
- --parent: Parent group name - --group: Parent group name
- args: <scene_name> <item_name> - args: <scene_name> <item_name>
```console ```console
@ -122,7 +122,7 @@ obsws-cli sceneitem show START "Colour Source"
- flags: - flags:
*optional* *optional*
- --parent: Parent group name - --group: Parent group name
- args: <scene_name> <item_name> - args: <scene_name> <item_name>
```console ```console
@ -133,29 +133,29 @@ obsws-cli sceneitem hide START "Colour Source"
- flags: - flags:
*optional* *optional*
- --parent: Parent group name - --group: Parent group name
- args: <scene_name> <item_name> - args: <scene_name> <item_name>
```console ```console
obsws-cli sceneitem toggle --parent=test_group START "Colour Source 3" obsws-cli sceneitem toggle --group=test_group START "Colour Source 3"
``` ```
- visible: Check if an item in a scene is visible. - visible: Check if an item in a scene is visible.
- flags: - flags:
*optional* *optional*
- --parent: Parent group name - --group: Parent group name
- args: <scene_name> <item_name> - args: <scene_name> <item_name>
```console ```console
obsws-cli sceneitem visible --parent=test_group START "Colour Source 4" obsws-cli sceneitem visible --group=test_group START "Colour Source 4"
``` ```
- transform: Set the transform of an item in a scene. - transform: Set the transform of an item in a scene.
- flags: - flags:
*optional* *optional*
- --parent: Parent group name. - --group: Parent group name.
- --alignment: Alignment of the item in the scene - --alignment: Alignment of the item in the scene
- --bounds-alignment: Bounds alignment of the item in the scene - --bounds-alignment: Bounds alignment of the item in the scene

180
obsws_cli/sceneitem.py
View File

@ -3,6 +3,7 @@
from collections.abc import Callable from collections.abc import Callable
from typing import Annotated, Optional from typing import Annotated, Optional
import obsws_python as obsws
import typer import typer
from rich.console import Console from rich.console import Console
from rich.table import Table from rich.table import Table
@ -36,17 +37,59 @@ def list(
raise typer.Exit(1) raise typer.Exit(1)
resp = ctx.obj.get_scene_item_list(scene_name) resp = ctx.obj.get_scene_item_list(scene_name)
items = [item.get('sourceName') for item in resp.scene_items] items = sorted(
(
(
item.get('sceneItemId'),
item.get('sourceName'),
item.get('isGroup'),
item.get('sceneItemEnabled'),
)
for item in resp.scene_items
),
key=lambda x: x[0], # Sort by sceneItemId
)
if not items: if not items:
out_console.print(f"No items found in scene '{scene_name}'.") out_console.print(f"No items found in scene '{scene_name}'.")
return return
table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2)) table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
table.add_column('Item Name', justify='left', style='cyan') for column in ('Item ID', 'Item Name', 'In Group', 'Enabled'):
table.add_column(
column, justify='left' if column == 'Item Name' else 'center', style='cyan'
)
for item in items: for item_id, item_name, is_group, is_enabled in items:
table.add_row(item) if is_group:
resp = ctx.obj.get_group_scene_item_list(item_name)
group_items = sorted(
(
(
gi.get('sceneItemId'),
gi.get('sourceName'),
gi.get('sceneItemEnabled'),
)
for gi in resp.scene_items
),
key=lambda x: x[0], # Sort by sceneItemId
)
for group_item_id, group_item_name, group_item_enabled in group_items:
table.add_row(
str(group_item_id),
group_item_name,
item_name,
':white_heavy_check_mark:'
if is_enabled and group_item_enabled
else ':x:',
)
else:
table.add_row(
str(item_id),
item_name,
'',
':white_heavy_check_mark:' if is_enabled else ':x:',
)
out_console.print(table) out_console.print(table)
@ -60,16 +103,16 @@ def _validate_scene_name_and_item_name(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Optional[str] = None, group: Optional[str] = None,
): ):
if not validate.scene_in_scenes(ctx, scene_name): if not validate.scene_in_scenes(ctx, scene_name):
err_console.print(f"Scene '{scene_name}' not found.") err_console.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1) raise typer.Exit(1)
if parent: if group:
if not validate.item_in_scene_item_list(ctx, scene_name, parent): if not validate.item_in_scene_item_list(ctx, scene_name, group):
err_console.print( err_console.print(
f"Parent group '{parent}' not found in scene '{scene_name}'." f"Parent group '{group}' not found in scene '{scene_name}'."
) )
raise typer.Exit(1) raise typer.Exit(1)
else: else:
@ -79,26 +122,38 @@ def _validate_scene_name_and_item_name(
) )
raise typer.Exit(1) raise typer.Exit(1)
return func(ctx, scene_name, item_name, parent) return func(ctx, scene_name, item_name, group)
return wrapper return wrapper
def _get_scene_name_and_item_id( def _get_scene_name_and_item_id(
ctx: typer.Context, scene_name: str, item_name: str, parent: Optional[str] = None ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
): ):
if parent: """Get the scene name and item ID for the given scene and item name."""
resp = ctx.obj.get_group_scene_item_list(parent) if group:
resp = ctx.obj.get_group_scene_item_list(group)
for item in resp.scene_items: for item in resp.scene_items:
if item.get('sourceName') == item_name: if item.get('sourceName') == item_name:
scene_name = parent scene_name = group
scene_item_id = item.get('sceneItemId') scene_item_id = item.get('sceneItemId')
break break
else: else:
err_console.print(f"Item '{item_name}' not found in group '{parent}'.") err_console.print(f"Item '{item_name}' not found in group '{group}'.")
raise typer.Exit(1) raise typer.Exit(1)
else: else:
resp = ctx.obj.get_scene_item_id(scene_name, item_name) try:
resp = ctx.obj.get_scene_item_id(scene_name, item_name)
except obsws.error.OBSSDKRequestError as e:
if e.code == 600:
err_console.print(
f"Item '{item_name}' not found in scene '{scene_name}'. Is the item in a group? "
'If so use the --group option to specify the parent group. '
'See `obsws-cli sceneitem list` for a list of items in the scene.'
)
raise typer.Exit(1)
else:
raise
scene_item_id = resp.scene_item_id scene_item_id = resp.scene_item_id
return scene_name, scene_item_id return scene_name, scene_item_id
@ -110,11 +165,11 @@ def show(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Annotated[Optional[str], typer.Option(help='Parent group name')] = None, group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
): ):
"""Show an item in a scene.""" """Show an item in a scene."""
scene_name, scene_item_id = _get_scene_name_and_item_id( scene_name, scene_item_id = _get_scene_name_and_item_id(
ctx, scene_name, item_name, parent ctx, scene_name, item_name, group
) )
ctx.obj.set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
@ -123,7 +178,16 @@ def show(
enabled=True, enabled=True,
) )
out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been shown.") if group:
out_console.print(
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
)
else:
# If not in a parent group, just show the scene name
# This is to avoid confusion with the parent group name
# which is not the same as the scene name
# and is not needed in this case
out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been shown.")
@_validate_scene_name_and_item_name @_validate_scene_name_and_item_name
@ -132,11 +196,11 @@ def hide(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Annotated[Optional[str], typer.Option(help='Parent group name')] = None, group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
): ):
"""Hide an item in a scene.""" """Hide an item in a scene."""
scene_name, scene_item_id = _get_scene_name_and_item_id( scene_name, scene_item_id = _get_scene_name_and_item_id(
ctx, scene_name, item_name, parent ctx, scene_name, item_name, group
) )
ctx.obj.set_scene_item_enabled( ctx.obj.set_scene_item_enabled(
@ -145,7 +209,18 @@ def hide(
enabled=False, enabled=False,
) )
out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been hidden.") if group:
out_console.print(
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
)
else:
# If not in a parent group, just show the scene name
# This is to avoid confusion with the parent group name
# which is not the same as the scene name
# and is not needed in this case
out_console.print(
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
)
@_validate_scene_name_and_item_name @_validate_scene_name_and_item_name
@ -154,17 +229,17 @@ def toggle(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Annotated[Optional[str], typer.Option(help='Parent group name')] = None, group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
): ):
"""Toggle an item in a scene.""" """Toggle an item in a scene."""
if not validate.scene_in_scenes(ctx, scene_name): if not validate.scene_in_scenes(ctx, scene_name):
err_console.print(f"Scene '{scene_name}' not found.") err_console.print(f"Scene '{scene_name}' not found.")
raise typer.Exit(1) raise typer.Exit(1)
if parent: if group:
if not validate.item_in_scene_item_list(ctx, scene_name, parent): if not validate.item_in_scene_item_list(ctx, scene_name, group):
err_console.print( err_console.print(
f"Parent group '{parent}' not found in scene '{scene_name}'." f"Parent group '{group}' not found in scene '{scene_name}'."
) )
raise typer.Exit(1) raise typer.Exit(1)
else: else:
@ -173,7 +248,7 @@ def toggle(
raise typer.Exit(1) raise typer.Exit(1)
scene_name, scene_item_id = _get_scene_name_and_item_id( scene_name, scene_item_id = _get_scene_name_and_item_id(
ctx, scene_name, item_name, parent ctx, scene_name, item_name, group
) )
enabled = ctx.obj.get_scene_item_enabled( enabled = ctx.obj.get_scene_item_enabled(
@ -188,9 +263,28 @@ def toggle(
enabled=new_state, enabled=new_state,
) )
out_console.print( if group:
f"Item '{item_name}' in scene '{scene_name}' has been {'shown' if new_state else 'hidden'}." if new_state:
) out_console.print(
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
)
else:
out_console.print(
f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
)
else:
# If not in a parent group, just show the scene name
# This is to avoid confusion with the parent group name
# which is not the same as the scene name
# and is not needed in this case
if new_state:
out_console.print(
f"Item '{item_name}' in scene '{scene_name}' has been shown."
)
else:
out_console.print(
f"Item '{item_name}' in scene '{scene_name}' has been hidden."
)
@_validate_scene_name_and_item_name @_validate_scene_name_and_item_name
@ -199,13 +293,13 @@ def visible(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Annotated[Optional[str], typer.Option(help='Parent group name')] = None, group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
): ):
"""Check if an item in a scene is visible.""" """Check if an item in a scene is visible."""
if parent: if group:
if not validate.item_in_scene_item_list(ctx, scene_name, parent): if not validate.item_in_scene_item_list(ctx, scene_name, group):
err_console.print( err_console.print(
f"Parent group '{parent}' not found in scene '{scene_name}'." f"Parent group '{group}' not found in scene '{scene_name}'."
) )
raise typer.Exit(1) raise typer.Exit(1)
else: else:
@ -215,7 +309,7 @@ def visible(
old_scene_name = scene_name old_scene_name = scene_name
scene_name, scene_item_id = _get_scene_name_and_item_id( scene_name, scene_item_id = _get_scene_name_and_item_id(
ctx, scene_name, item_name, parent ctx, scene_name, item_name, group
) )
enabled = ctx.obj.get_scene_item_enabled( enabled = ctx.obj.get_scene_item_enabled(
@ -223,9 +317,9 @@ def visible(
item_id=int(scene_item_id), item_id=int(scene_item_id),
) )
if parent: if group:
out_console.print( out_console.print(
f"Item '{item_name}' in group '{parent}' in scene '{old_scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}." f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name
@ -243,7 +337,7 @@ def transform(
ctx: typer.Context, ctx: typer.Context,
scene_name: str, scene_name: str,
item_name: str, item_name: str,
parent: Annotated[Optional[str], typer.Option(help='Parent group name')] = None, group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
alignment: Annotated[ alignment: Annotated[
Optional[int], typer.Option(help='Alignment of the item in the scene') Optional[int], typer.Option(help='Alignment of the item in the scene')
] = None, ] = None,
@ -291,10 +385,10 @@ def transform(
] = None, ] = None,
): ):
"""Set the transform of an item in a scene.""" """Set the transform of an item in a scene."""
if parent: if group:
if not validate.item_in_scene_item_list(ctx, scene_name, parent): if not validate.item_in_scene_item_list(ctx, scene_name, group):
err_console.print( err_console.print(
f"Parent group '{parent}' not found in scene '{scene_name}'." f"Parent group '{group}' not found in scene '{scene_name}'."
) )
raise typer.Exit(1) raise typer.Exit(1)
else: else:
@ -304,7 +398,7 @@ def transform(
old_scene_name = scene_name old_scene_name = scene_name
scene_name, scene_item_id = _get_scene_name_and_item_id( scene_name, scene_item_id = _get_scene_name_and_item_id(
ctx, scene_name, item_name, parent ctx, scene_name, item_name, group
) )
transform = {} transform = {}
@ -349,9 +443,9 @@ def transform(
transform=transform, transform=transform,
) )
if parent: if group:
out_console.print( out_console.print(
f"Item '{item_name}' in group '{parent}' in scene '{old_scene_name}' has been transformed." f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' has been transformed."
) )
else: else:
# If not in a parent group, just show the scene name # If not in a parent group, just show the scene name