click-extended 1.0.7__py3-none-any.whl → 1.0.8__py3-none-any.whl

click_extended/decorators/misc/__init__.py

@@ -1,5 +1,8 @@
 """Initialization file for the `click_extended.decorators.misc` module."""
 
+# pylint: disable=wrong-import-position
+
+from click_extended.decorators.misc.catch import catch
 from click_extended.decorators.misc.choice import choice
 from click_extended.decorators.misc.confirm_if import confirm_if
 from click_extended.decorators.misc.default import default
@@ -8,6 +11,7 @@ from click_extended.decorators.misc.experimental import experimental
 from click_extended.decorators.misc.now import now
 
 __all__ = [
+    "catch",
     "choice",
     "confirm_if",
     "default",

click_extended/decorators/misc/catch.py

@@ -0,0 +1,300 @@
+"""
+Validation node to catch and handle exceptions from command/group functions.
+"""
+
+import asyncio
+import inspect
+from functools import wraps
+from typing import Any, Callable
+from weakref import WeakKeyDictionary
+
+from click_extended.core.nodes.validation_node import ValidationNode
+from click_extended.core.other._tree import Tree
+from click_extended.core.other.context import Context
+from click_extended.types import Decorator
+
+_catch_handlers: WeakKeyDictionary[
+    Callable[..., Any],
+    list[
+        tuple[tuple[type[BaseException], ...], Callable[..., Any] | None, bool]
+    ],
+] = WeakKeyDictionary()
+
+
+class Catch(ValidationNode):
+    """
+    Catch and handle exceptions from command/group functions.
+
+    Wraps the decorated function in a try-except block. When an exception
+    is caught, an optional handler is invoked. Without a handler, exceptions
+    are silently suppressed.
+
+    Handler signatures supported:
+    - `handler()` - No arguments, just execute code
+    - `handler(exception)` - Receive the exception object
+    - `handler(exception, context)` - Receive exception and Context object
+
+    Examples:
+        ```py
+        # Simple error logging
+        @command()
+        @catch(ValueError, handler=lambda: print("Invalid value!"))
+        def cmd():
+            raise ValueError("Bad input")
+        ```
+
+        ```py
+        # Handle exception with details
+        @command()
+        @catch(ValueError, handler=lambda e: print(f"Error: {e}"))
+        def cmd():
+            raise ValueError("Count must be positive")
+        ```
+
+        ```py
+        # Access context information
+        @command()
+        @catch(
+            ValueError,
+            handler=lambda e, ctx: print(f"{ctx.info_name}: {e}"),
+        )
+        def cmd():
+            raise ValueError("Failed!")
+        ```
+    """
+
+    def __init__(
+        self,
+        name: str,
+        process_args: tuple[Any, ...] | None = None,
+        process_kwargs: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        """Initialize Catch validation node with function to wrap."""
+        super().__init__(name, process_args, process_kwargs, **kwargs)
+        self.wrapped_func: Callable[..., Any] | None = None
+
+    def on_finalize(self, context: Context, *args: Any, **kwargs: Any) -> None:
+        """
+        Store exception handler configuration for later use.
+
+        The actual exception catching happens when the function is invoked,
+        which is done by wrapping the function in the decorator.
+
+        Args:
+            context: The execution context
+            *args: Contains exception types tuple at index 0
+            **kwargs: Contains handler, reraise parameters
+        """
+
+
+def catch(
+    *exception_types: type[BaseException],
+    handler: Callable[..., Any] | None = None,
+    reraise: bool = False,
+) -> Decorator:
+    """
+    Catch and handle exceptions from command/group functions.
+
+    Wraps the function in a try-except block. When exceptions occur, an optional
+    handler is invoked. If no exception types are specified, catches Exception.
+
+    Type: `ValidationNode`
+
+    Args:
+        *exception_types: Exception types to catch (defaults to Exception)
+        handler: Optional function with signature `()`, `(exception)`, or
+            `(exception, context)` to handle caught exceptions
+        reraise: If True, re-raise after handling (default: False)
+
+    Returns:
+        Decorator function
+
+    Raises:
+        TypeError: If exception_types contains non-exception classes
+
+    Examples:
+        ```python
+        # Simple notification (no arguments)
+        @command()
+        @catch(ValueError, handler=lambda: print("Error occurred!"))
+        def cmd():
+            raise ValueError("Invalid input")
+        ```
+
+        ```python
+        # Log exception details (exception argument)
+        @command()
+        @catch(ValueError, handler=lambda e: print(f"Error: {e}"))
+        def cmd():
+            raise ValueError("Count must be positive")
+        ```
+
+        ```python
+        # Access context (exception + context arguments)
+        @command()
+        @catch(
+            ValueError,
+            handler=lambda e, ctx: print(f"{ctx.info_name}: {e}"),
+        )
+        def cmd():
+            raise ValueError("Failed!")
+        ```
+
+        ```python
+        # Catch multiple exception types
+        @command()
+        @catch(ValueError, TypeError, handler=lambda e: log_error(e))
+        def cmd():
+            raise ValueError("Something went wrong")
+        ```
+
+        ```python
+        # Silent suppression (no handler)
+        @command()
+        @catch(RuntimeError)
+        def cmd():
+            raise RuntimeError("Silently suppressed")
+        ```
+
+        ```python
+        # Log then re-raise
+        @command()
+        @catch(
+            ValueError,
+            handler=lambda e: print(f"Logging: {e}"),
+            reraise=True,
+        )
+        def cmd():
+            raise ValueError("This will be logged and re-raised")
+        ```
+    """
+    if not exception_types:
+        exception_types = (Exception,)
+
+    for exc_type in exception_types:
+        if not isinstance(exc_type, type) or not issubclass(
+            exc_type, BaseException
+        ):
+            raise TypeError(
+                f"catch() requires exception types, got {exc_type!r}"
+            )
+
+    def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
+        """The actual decorator that wraps the function."""
+
+        instance = Catch(
+            name="catch",
+            process_args=(exception_types,),
+            process_kwargs={"handler": handler, "reraise": reraise},
+        )
+
+        Tree.queue_validation(instance)
+
+        original_func = func
+        while hasattr(original_func, "__wrapped__"):
+            original_func = original_func.__wrapped__  # type: ignore
+
+        if original_func not in _catch_handlers:
+            _catch_handlers[original_func] = []
+        _catch_handlers[original_func].insert(
+            0, (exception_types, handler, reraise)
+        )
+
+        # Only wrap if this is the first @catch (check handlers dict)
+        if len(_catch_handlers[original_func]) > 1:
+            return func
+
+        if asyncio.iscoroutinefunction(func):
+
+            @wraps(func)
+            async def async_wrapper(*call_args: Any, **call_kwargs: Any) -> Any:
+                """Async wrapper that catches exceptions."""
+                try:
+                    return await func(*call_args, **call_kwargs)
+                except BaseException as exc:
+                    for exc_types, hdlr, reraise_flag in _catch_handlers.get(
+                        original_func, []
+                    ):
+                        if isinstance(exc, exc_types):
+                            if hdlr is not None:
+                                if asyncio.iscoroutinefunction(hdlr):
+                                    await _call_handler_async(hdlr, exc)
+                                else:
+                                    _call_handler_sync(hdlr, exc)
+
+                            if reraise_flag:
+                                raise
+
+                            return None
+                    raise
+
+            return async_wrapper
+
+        @wraps(func)
+        def sync_wrapper(*call_args: Any, **call_kwargs: Any) -> Any:
+            """Sync wrapper that catches exceptions."""
+            try:
+                return func(*call_args, **call_kwargs)
+            except BaseException as exc:
+                for exc_types, hdlr, reraise_flag in _catch_handlers.get(
+                    original_func, []
+                ):
+                    if isinstance(exc, exc_types):
+                        if hdlr is not None:
+                            if asyncio.iscoroutinefunction(hdlr):
+                                asyncio.run(_call_handler_async(hdlr, exc))
+                            else:
+                                _call_handler_sync(hdlr, exc)
+
+                        if reraise_flag:
+                            raise
+
+                        return None
+                raise
+
+        return sync_wrapper
+
+    return decorator
+
+
+async def _call_handler_async(
+    handler: Callable[..., Any], exc: BaseException
+) -> Any:
+    """Call async handler with appropriate number of arguments."""
+    sig = inspect.signature(handler)
+    params = list(sig.parameters.values())
+
+    if len(params) == 0:
+        return await handler()
+    if len(params) == 1:
+        return await handler(exc)
+
+    import click
+
+    try:
+        ctx = click.get_current_context()
+        custom_context = ctx.meta.get("click_extended", {}).get("context")
+        return await handler(exc, custom_context)
+    except RuntimeError:
+        return await handler(exc, None)
+
+
+def _call_handler_sync(handler: Callable[..., Any], exc: BaseException) -> Any:
+    """Call sync handler with appropriate number of arguments."""
+    sig = inspect.signature(handler)
+    params = list(sig.parameters.values())
+
+    if len(params) == 0:
+        return handler()
+    if len(params) == 1:
+        return handler(exc)
+
+    import click
+
+    try:
+        ctx = click.get_current_context()
+        custom_context = ctx.meta.get("click_extended", {}).get("context")
+        return handler(exc, custom_context)
+    except RuntimeError:
+        return handler(exc, None)

{click_extended-1.0.7.dist-info → click_extended-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 1.0.7
+Version: 1.0.8
 Summary: An extension to Click with additional features like automatic async support, aliasing and a modular decorator system.
 Author-email: Marcus Fredriksson <marcus@marcusfredriksson.com>
 License: MIT License

{click_extended-1.0.7.dist-info → click_extended-1.0.8.dist-info}/RECORD

@@ -97,7 +97,8 @@ click_extended/decorators/math/rounded.py,sha256=bHYZQbtd5zRCd3BOEnjxTGdFAmQAL5l
 click_extended/decorators/math/sqrt.py,sha256=CWZoQpVw2lbP_LNeg-tWW8fz9VEHTX8eQNPNuDVoTcg,834
 click_extended/decorators/math/subtract.py,sha256=A7TMByTUH3coSEe7iRN9NkHW2mv47kufb1H1adomG4A,806
 click_extended/decorators/math/to_percent.py,sha256=39vY13u7Z-pyob1vCoPBDy10FqJasJTVzHcrpTH6ERQ,1374
-click_extended/decorators/misc/__init__.py,sha256=TDLrR2mZj_oqAcWEqB_C19Hxn8ClrZW2CbuTmJNRblU,553
+click_extended/decorators/misc/__init__.py,sha256=Cl2u81f_dkvHoMoSb82L1KuNVM-3b1lzKHUMAuxhmH0,662
+click_extended/decorators/misc/catch.py,sha256=Ft8CbTlX6OgeNA8re_epKfwK4HyWQ1eUuCbhNqzpNbw,9343
 click_extended/decorators/misc/choice.py,sha256=RTVVjl0YUZ2Ti4j6yoHkUpJ0aqNwcnc3rTfmCVr0y0U,4354
 click_extended/decorators/misc/confirm_if.py,sha256=Rf3HcVVTRqz3sGSiPT02yz65_L351Fzkuw2V6pljlmY,4786
 click_extended/decorators/misc/default.py,sha256=TjZJKmHEqNThzyD6hOjQy2_QgHRenKILnAwfV1V5KAw,2473
@@ -143,9 +144,9 @@ click_extended/utils/naming.py,sha256=kNmzOqidgZZ1dE5aMYrxpWt4VwcLuEiFunpumpfHuZ
 click_extended/utils/process.py,sha256=sU3ZCMjBgjKcDnTRLKPdQ_TAjk0AT7Q8SatagD0JyHA,9729
 click_extended/utils/selection.py,sha256=_OQC88pGPUh29boxmS5ugXEi9jZGqAG180S27PeQaj0,9875
 click_extended/utils/time.py,sha256=H5m5caIEau_1GHkiYgKL_LcTtVdw2TkFVbkqJu7A9rQ,1067
-click_extended-1.0.7.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
-click_extended-1.0.7.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
-click_extended-1.0.7.dist-info/METADATA,sha256=pVmPjkszY_IAx2DP-RM2i2IkhS28n_g6fkFU9itz8y4,10841
-click_extended-1.0.7.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-click_extended-1.0.7.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
-click_extended-1.0.7.dist-info/RECORD,,
+click_extended-1.0.8.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
+click_extended-1.0.8.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
+click_extended-1.0.8.dist-info/METADATA,sha256=j42ol1yFZRyvuaiM_g7_-LVNJHFuMX6BDdcog4EjTC8,10841
+click_extended-1.0.8.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+click_extended-1.0.8.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
+click_extended-1.0.8.dist-info/RECORD,,