dynamically load commands from obsws_cli.commands

no changes to files other than imports

patch bump

obsws_cli/__about__.py

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

obsws_cli/alias.py

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

obsws_cli/app.py

@@ -2,6 +2,7 @@
 
 import importlib
 import logging
+import pkgutil
 from typing import Annotated
 
 import obsws_python as obsws
@@ -9,32 +10,15 @@ import typer
 
 from obsws_cli.__about__ import __version__ as version
 
-from . import config, console, styles
+from . import commands, config, console, styles
 from .alias import 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):

obsws_cli/commands/filter.py

@@ -7,8 +7,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/group.py

@@ -6,9 +6,9 @@ import typer
 from rich.table import Table
 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)
 
@@ -31,7 +31,7 @@ def list_(
     ] = None,
 ):
     """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
 
     resp = ctx.obj['obsws'].get_scene_item_list(scene_name)

obsws_cli/commands/hotkey.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/input.py

@@ -7,8 +7,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/media.py

@@ -4,8 +4,8 @@ from typing import Annotated, Optional
 
 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)
 
@@ -24,7 +24,9 @@ def cursor(
     timecode: Annotated[
         Optional[str],
         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,
 ):

obsws_cli/commands/profile.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/projector.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/record.py

@@ -5,8 +5,8 @@ from typing import Annotated, Optional
 
 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)
 

obsws_cli/commands/replaybuffer.py

@@ -2,8 +2,8 @@
 
 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)
 

obsws_cli/commands/scene.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 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)
 
@@ -70,14 +70,14 @@ def list_(
 def current(
     ctx: typer.Context,
     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,
 ):
     """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:
         resp = ctx.obj['obsws'].get_current_preview_scene()
         console.out.print(
@@ -103,14 +103,13 @@ def switch(
     ],
     preview: Annotated[
         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,
 ):
     """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:
         ctx.obj['obsws'].set_current_preview_scene(scene_name)
         console.out.print(

obsws_cli/commands/scenecollection.py

@@ -5,8 +5,8 @@ from typing import Annotated
 import typer
 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)
 

obsws_cli/commands/sceneitem.py

@@ -5,8 +5,8 @@ from typing import Annotated, Optional
 import typer
 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)
 
@@ -30,7 +30,7 @@ def list_(
     uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
 ):
     """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
 
     resp = ctx.obj['obsws'].get_scene_item_list(scene_name)

obsws_cli/commands/screenshot.py

@@ -6,8 +6,8 @@ from typing import Annotated
 import obsws_python as obsws
 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)
 

obsws_cli/commands/settings.py

@@ -6,8 +6,8 @@ import typer
 from rich.table import Table
 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)
 

obsws_cli/commands/stream.py

@@ -2,8 +2,8 @@
 
 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)
 

obsws_cli/commands/studiomode.py

@@ -2,8 +2,8 @@
 
 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)
 

obsws_cli/commands/text.py

@@ -4,8 +4,8 @@ from typing import Annotated, Optional
 
 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)
 

obsws_cli/commands/virtualcam.py

@@ -2,8 +2,8 @@
 
 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)
 

obsws_cli/validate.py

@@ -1,5 +1,7 @@
 """module containing validation functions."""
 
+from typing import Optional
+
 import typer
 
 from . import console
@@ -8,7 +10,7 @@ from . import console
 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."""
     resp = ctx.obj['obsws'].get_input_list()
     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
 
 
-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."""
     resp = ctx.obj['obsws'].get_input_list()
     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
 
 
-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."""
+    if scene_name is None:
+        return
+
     resp = ctx.obj['obsws'].get_scene_list()
     if not any(scene.get('sceneName') == scene_name for scene in resp.scenes):
         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
 
 
-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()
-    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(
@@ -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.')
         raise typer.Exit(1)
     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