wexample-cli 1.1.0__tar.gz → 1.3.0__tar.gz

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wexample-cli
-Version: 1.1.0
+Version: 1.3.0
 Summary: Reusable CLI primitives — command decorators, options, middlewares, and the enriched command runner — extracted from wex-core so any kernel built on wexample-app can opt in without depending on the full wex framework.
 Author-Email: weeger <contact@wexample.com>
 License: MIT
@@ -10,9 +10,9 @@ Classifier: Operating System :: OS Independent
 Project-URL: homepage, https://github.com/wexample/python-cli
 Requires-Python: >=3.10
 Requires-Dist: attrs>=23.1.0
-Requires-Dist: wexample-app>=18.0.0
-Requires-Dist: wexample-helpers>=16.0.0
-Requires-Dist: wexample-prompt>=13.1.0
+Requires-Dist: wexample-app>=18.2.0
+Requires-Dist: wexample-helpers>=17.0.0
+Requires-Dist: wexample-prompt>=13.3.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
@@ -20,7 +20,7 @@ Description-Content-Type: text/markdown
 
 # cli
 
-Version: 1.1.0
+Version: 1.3.0
 
 Reusable CLI primitives — command decorators, options, middlewares, and the enriched command runner — extracted from wex-core so any kernel built on wexample-app can opt in without depending on the full wex framework.
 
@@ -100,9 +100,9 @@ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the comp
 ## Dependencies
 
 - attrs: >=23.1.0
-- wexample-app: >=18.0.0
-- wexample-helpers: >=16.0.0
-- wexample-prompt: >=13.1.0
+- wexample-app: >=18.2.0
+- wexample-helpers: >=17.0.0
+- wexample-prompt: >=13.3.0
 
 ## Versioning & Compatibility Policy
 

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/README.md

@@ -1,6 +1,6 @@
 # cli
 
-Version: 1.1.0
+Version: 1.3.0
 
 Reusable CLI primitives — command decorators, options, middlewares, and the enriched command runner — extracted from wex-core so any kernel built on wexample-app can opt in without depending on the full wex framework.
 
@@ -80,9 +80,9 @@ Visit the [Wexample Suite documentation](https://docs.wexample.com) for the comp
 ## Dependencies
 
 - attrs: >=23.1.0
-- wexample-app: >=18.0.0
-- wexample-helpers: >=16.0.0
-- wexample-prompt: >=13.1.0
+- wexample-app: >=18.2.0
+- wexample-helpers: >=17.0.0
+- wexample-prompt: >=13.3.0
 
 ## Versioning & Compatibility Policy
 

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-cli"
-version = "1.1.0"
+version = "1.3.0"
 description = "Reusable CLI primitives — command decorators, options, middlewares, and the enriched command runner — extracted from wex-core so any kernel built on wexample-app can opt in without depending on the full wex framework."
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -19,9 +19,9 @@ classifiers = [
 ]
 dependencies = [
     "attrs>=23.1.0",
-    "wexample-app>=18.0.0",
-    "wexample-helpers>=16.0.0",
-    "wexample-prompt>=13.1.0",
+    "wexample-app>=18.2.0",
+    "wexample-helpers>=17.0.0",
+    "wexample-prompt>=13.3.0",
 ]
 
 [project.readme]

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/command/extended_command.py

@@ -38,9 +38,9 @@ class ExtendedCommand(Command):
         middlewares_attributes = self.command_wrapper.middlewares_attributes
         middlewares_registry = self.kernel.get_registry("middlewares")
 
-        for name in middlewares_attributes:
+        for name, attributes in middlewares_attributes.items():
             middleware_class = middlewares_registry.get_class(name)
-            middleware = middleware_class(**middlewares_attributes[name])
+            middleware = middleware_class(**attributes)
             self.command_wrapper.set_middleware(middleware)
 
         # Universal --help / -h handling — render the command's options instead
@@ -85,32 +85,33 @@ class ExtendedCommand(Command):
 
         # Process all declared options
         for option in self.command_wrapper.options:
+            name = option.name
             value = None
 
             # If the option is in parsed args, use that value
-            if option.name in parsed_args:
-                value = parsed_args[option.name]
+            if name in parsed_args:
+                value = parsed_args[name]
             # Otherwise, use the default value if available
             elif option.default is not None:
                 value = option.default
             # If the option is required but not provided, raise an error
             elif option.required:
-                raise CommandOptionMissingException(option_name=option.name)
+                raise CommandOptionMissingException(option_name=name)
 
             # Validate the value if validators are defined and value is not None
             if value is not None and option.validators:
+                from wexample_cli.exception.command_option_validation_exception import (
+                    CommandOptionValidationException,
+                )
+
                 # For multiple values, validate each item individually
                 values_to_validate = value if isinstance(value, list) else [value]
 
                 for val in values_to_validate:
                     for validator in option.validators:
                         if not validator.validate(val):
-                            from wexample_cli.exception.command_option_validation_exception import (
-                                CommandOptionValidationException,
-                            )
-
                             raise CommandOptionValidationException(
-                                option_name=option.name,
+                                option_name=name,
                                 value=val,
                                 error_message=validator.get_error_message(val),
                             )
@@ -121,7 +122,7 @@ class ExtendedCommand(Command):
 
             # Assign the validated value
             if value is not None:
-                option.value = function_kwargs[option.name] = value
+                option.value = function_kwargs[name] = value
 
         # `--` passthrough: if the user supplied extra args after `--`, the
         # parser put them in parsed_args["__extra_args__"]. Forward them as
@@ -158,10 +159,11 @@ class ExtendedCommand(Command):
             MIDDLEWARE_OPTION_VALUE_OPTIONAL,
         )
 
-        if len(self.command_wrapper.middlewares) > 0:
+        middlewares = self.command_wrapper.middlewares
+        if middlewares:
             output = MultipleResponse(kernel=self.kernel)
 
-            for middleware in self.command_wrapper.middlewares:
+            for middleware in middlewares:
                 show_progress = (
                     middleware.show_progress == MIDDLEWARE_OPTION_VALUE_ALLWAYS
                     or (
@@ -286,9 +288,6 @@ class ExtendedCommand(Command):
         from wexample_app.helpers.response import response_normalize
         from wexample_app.response.abstract_response import AbstractResponse
 
-        # Create a list to store all tasks
-        tasks = []
-
         # Create an executor for running CPU-bound functions in a thread pool
         executor = ThreadPoolExecutor(max_workers=min(32, len(execution_contexts)))
 
@@ -308,7 +307,7 @@ class ExtendedCommand(Command):
             function_to_execute = execution_context.function or self.function
 
             # Run the function in a thread pool to avoid blocking the event loop
-            loop = asyncio.get_event_loop()
+            loop = asyncio.get_running_loop()
             result = await loop.run_in_executor(
                 executor,
                 lambda: function_to_execute(**execution_context.function_kwargs),
@@ -320,9 +319,10 @@ class ExtendedCommand(Command):
             return response_normalize(kernel=self.kernel, response=result)
 
         # Create a task for each pass
-        for execution_context in execution_contexts:
-            task = asyncio.create_task(execute_single_pass(execution_context))
-            tasks.append(task)
+        tasks = [
+            asyncio.create_task(execute_single_pass(execution_context))
+            for execution_context in execution_contexts
+        ]
 
         # Wait for all tasks to complete
         responses = await asyncio.gather(*tasks)

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/common/command_method_wrapper.py

@@ -114,9 +114,9 @@ class CommandMethodWrapper(BaseClass):
 
     def set_middleware(self, middleware: AbstractMiddleware) -> None:
         self.middlewares.append(middleware)
-
-        for option in middleware.normalized_options:
-            self.set_option(option)
+        # extend is a single C-level call; avoids N Python method-dispatch
+        # round-trips that self.set_option() would incur per option.
+        self.options.extend(middleware.normalized_options)
 
     def set_option(self, option: Option) -> None:
         self.options.append(option)

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/context/execution_context.py

@@ -64,15 +64,17 @@ class ExecutionContext(
         return self._current_progress
 
     def finish_progress(self, **kwargs) -> ProgressHandle:
-        self._current_progress.finish()
-
-        self._current_progress = self._current_progress.parent
-        self._current_progress.update(**kwargs)
-        return self._current_progress
+        progress = self._current_progress
+        progress.finish()
+        parent = progress.parent
+        parent.update(**kwargs)
+        self._current_progress = parent
+        return parent
 
     def get_or_create_progress(self, **kwargs) -> ProgressHandle:
         if self._current_progress is None:
-            self._current_progress = self.io.progress(
-                **kwargs, context=self.io.create_context()
+            io = self.io
+            self._current_progress = io.progress(
+                **kwargs, context=io.create_context()
             ).get_handle()
         return self._current_progress

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/decorator/as_sudo.py

@@ -7,8 +7,9 @@ if TYPE_CHECKING:
 
 
 def as_sudo() -> CommandMethodWrapper:
-    def decorator(wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
-        wrapper.sudo = True
-        return wrapper
+    return _sudo_decorator
 
-    return decorator
+
+def _sudo_decorator(wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
+    wrapper.sudo = True
+    return wrapper

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/decorator/middleware.py

@@ -2,10 +2,11 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from wexample_cli.common.command_method_wrapper import CommandMethodWrapper
+
 if TYPE_CHECKING:
     from wexample_helpers.const.types import AnyCallable
 
-    from wexample_cli.common.command_method_wrapper import CommandMethodWrapper
     from wexample_cli.middleware.abstract_middleware import AbstractMiddleware
 
 
@@ -16,8 +17,6 @@ def middleware(
 ) -> AnyCallable:
     def decorator(command_wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
         # Type safety check
-        from wexample_cli.common.command_method_wrapper import CommandMethodWrapper
-
         if not isinstance(command_wrapper, CommandMethodWrapper):
             raise TypeError(
                 f"Invalid middleware usage: @middleware must decorate a {CommandMethodWrapper.__name__} "

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/decorator/option_stop_on_failure.py

@@ -11,9 +11,9 @@ OPTION_NAME_STOP_ON_FAILURE: str = "stop_on_failure"
 
 
 def option_stop_on_failure() -> AnyCallable:
-    def decorator(command_wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
-        from wexample_app.command.option import Option
+    from wexample_app.command.option import Option
 
+    def decorator(command_wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
         command_wrapper.set_option(
             Option(
                 name=OPTION_NAME_STOP_ON_FAILURE,

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/decorator/screenable.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import time
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
@@ -55,7 +56,7 @@ def screenable(interval: float = 1.0, height: int = 30) -> AnyCallable:
         )
 
         command_wrapper.register_pipeline_wrapper(
-            _build_screen_wrapper(default_interval=float(interval), height=int(height))
+            _build_screen_wrapper(default_interval=interval, height=height)
         )
 
         return command_wrapper
@@ -73,31 +74,26 @@ def _build_screen_wrapper(default_interval: float, height: int) -> AnyCallable:
     ) -> Any:
         # Always strip screen kwargs so they cannot leak to the user function
         # or to inner pipeline wrappers, whether or not --screen was passed.
-        enabled = bool(function_kwargs.pop(OPTION_NAME_SCREEN, False))
+        enabled = function_kwargs.pop(OPTION_NAME_SCREEN, False)
         interval_override = function_kwargs.pop(OPTION_NAME_SCREEN_INTERVAL, None)
 
         if not enabled:
             return next_dispatch(function_kwargs)
 
-        import time
-
         from wexample_app.response.null_response import NullResponse
 
-        interval = (
-            float(interval_override)
-            if interval_override is not None
-            else default_interval
-        )
+        interval = interval_override if interval_override is not None else default_interval
         kernel_io = request.kernel.io
         # Skip the inter-frame sleep on the very first frame so the user sees
         # output immediately instead of waiting `interval` seconds before the
         # first render.
-        is_first_frame = [True]
+        is_first_frame = True
 
         def _frame(response) -> None:
-            if not is_first_frame[0]:
+            nonlocal is_first_frame
+            if not is_first_frame:
                 time.sleep(interval)
-            is_first_frame[0] = False
+            is_first_frame = False
 
             response.clear()
             saved_output = kernel_io.output

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/decorator/webhook.py

@@ -19,9 +19,9 @@ def webhook() -> type[CommandMethodWrapper]:
         @command(type=COMMAND_TYPE_ADDON)
         def my__group__command(context): ...
     """
+    return _webhook_decorator  # type: ignore[return-value]
 
-    def decorator(wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
-        wrapper.webhook = True
-        return wrapper
 
-    return decorator  # type: ignore[return-value]
+def _webhook_decorator(wrapper: CommandMethodWrapper) -> CommandMethodWrapper:
+    wrapper.webhook = True
+    return wrapper

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/helpers/extra_args.py

@@ -27,11 +27,11 @@ def resolve_shell_command(
       shell, which is the safer default. Use the legacy `--command "..."`
       form if you intentionally want remote expansion.
     """
-    if extra_args and command:
-        context.io.warning(
-            "Both --command and `-- <args>` were given; using `-- <args>`."
-        )
     if extra_args:
+        if command:
+            context.io.warning(
+                "Both --command and `-- <args>` were given; using `-- <args>`."
+            )
         return shlex.join(extra_args)
     if command:
         return command

{wexample_cli-1.1.0 → wexample_cli-1.3.0}/src/wexample_cli/middleware/abstract_middleware.py

@@ -72,17 +72,17 @@ class AbstractMiddleware(
                 'Option "stop_on_failure" will be ignored due to parallelization'
             )
 
-        if self.parallel == MIDDLEWARE_OPTION_VALUE_OPTIONAL:
-            command_wrapper.set_option(
-                Option(
-                    name="parallel",
-                    short_name="pll",
-                    type=bool,
-                    description="Execute async when possible",
-                    default=False,
-                    is_flag=True,
+            if self.parallel == MIDDLEWARE_OPTION_VALUE_OPTIONAL:
+                command_wrapper.set_option(
+                    Option(
+                        name="parallel",
+                        short_name="pll",
+                        type=bool,
+                        description="Execute async when possible",
+                        default=False,
+                        is_flag=True,
+                    )
                 )
-            )
 
         if self.show_progress == MIDDLEWARE_OPTION_VALUE_OPTIONAL:
             command_wrapper.set_option(
@@ -133,10 +133,9 @@ class AbstractMiddleware(
 
     def get_option_by_name(self, name: str) -> Option | None:
         """Get an option by its name from the normalized options."""
-        for option in self.normalized_options:
-            if option.name == name:
-                return option
-        return None
+        return next(
+            (opt for opt in self.normalized_options if opt.name == name), None
+        )
 
     def validate_options(
         self,

wexample_cli-1.3.0/tests/helpers/test_extra_args.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import types
+
+
+def test_resolve_shell_command_joins_extra_args_with_quoting() -> None:
+    from wexample_cli.helpers.extra_args import resolve_shell_command
+
+    result = resolve_shell_command(
+        context=None, command=None, extra_args=["echo", "hi there"]
+    )
+    assert result == "echo 'hi there'"
+
+
+def test_resolve_shell_command_returns_none_when_nothing_given() -> None:
+    from wexample_cli.helpers.extra_args import resolve_shell_command
+
+    result = resolve_shell_command(context=None, command=None, extra_args=None)
+    assert result is None
+
+
+def test_resolve_shell_command_uses_command_when_no_extra_args() -> None:
+    from wexample_cli.helpers.extra_args import resolve_shell_command
+
+    result = resolve_shell_command(context=None, command="ls -la", extra_args=None)
+    assert result == "ls -la"
+
+
+def test_resolve_shell_command_warns_when_both_given() -> None:
+    from wexample_prompt.common.io_manager import IoManager
+
+    from wexample_cli.helpers.extra_args import resolve_shell_command
+
+    context = types.SimpleNamespace(io=IoManager())
+    result = resolve_shell_command(
+        context=context, command="legacy", extra_args=["run"]
+    )
+    assert result == "run"