click-extended 1.0.6__tar.gz → 1.0.8__tar.gz

{click_extended-1.0.6/click_extended.egg-info → click_extended-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 1.0.6
+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.8/click_extended/decorators/check/regex.py

@@ -0,0 +1,65 @@
+"""Check if a value matches a regex pattern."""
+
+import re
+from typing import Any, Union
+
+from click_extended.core.nodes.child_node import ChildNode
+from click_extended.core.other.context import Context
+from click_extended.types import Decorator
+
+
+class Regex(ChildNode):
+    """Check if a value matches a regex pattern."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        patterns: tuple[Union[str, re.Pattern[str]], ...] = kwargs["patterns"]
+        flags: int = kwargs.get("flags", 0)
+
+        for pattern in patterns:
+            compiled_pattern: re.Pattern[str]
+            if isinstance(pattern, re.Pattern):
+                compiled_pattern = pattern
+            else:
+                compiled_pattern = re.compile(pattern, flags)
+
+            if compiled_pattern.fullmatch(value):
+                return value
+
+        pattern_strs: list[str] = [
+            p.pattern if isinstance(p, re.Pattern) else p for p in patterns
+        ]
+        raise ValueError(
+            f"Value '{value}' does not match any "
+            + f"of the patterns: {pattern_strs}"
+        )
+
+
+def regex(*patterns: Union[str, re.Pattern[str]], flags: int = 0) -> Decorator:
+    """
+    Check if a value matches a regex pattern.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Args:
+        *patterns (Union[str, Pattern[str]]):
+            The regex patterns to check against. Can be strings or compiled
+            Pattern objects. If strings are provided, they will be compiled
+            with the specified flags.
+        flags (int):
+            Regex flags to use when compiling string patterns (e.g.,
+            re.IGNORECASE, re.MULTILINE). Ignored for pre-compiled patterns.
+            Default is 0 (no flags).
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return Regex.as_decorator(patterns=patterns, flags=flags)

{click_extended-1.0.6 → click_extended-1.0.8}/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-1.0.8/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.6 → click_extended-1.0.8/click_extended.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 1.0.6
+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.6 → click_extended-1.0.8}/click_extended.egg-info/SOURCES.txt

@@ -107,6 +107,7 @@ click_extended/decorators/math/sqrt.py
 click_extended/decorators/math/subtract.py
 click_extended/decorators/math/to_percent.py
 click_extended/decorators/misc/__init__.py
+click_extended/decorators/misc/catch.py
 click_extended/decorators/misc/choice.py
 click_extended/decorators/misc/confirm_if.py
 click_extended/decorators/misc/default.py

{click_extended-1.0.6 → click_extended-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "click_extended"
-version = "1.0.6"
+version = "1.0.8"
 description = "An extension to Click with additional features like automatic async support, aliasing and a modular decorator system."
 authors = [
     { name = "Marcus Fredriksson", email = "marcus@marcusfredriksson.com" },
@@ -85,7 +85,13 @@ ignore = [
     ".mypy_cache",
     "*.egg-info",
 ]
-ignore-paths = ["^tests/.*$", "^docs/.*$", "^\\..*$"]
+ignore-paths = [
+    "^tests/.*$",
+    "^docs/.*$",
+    "^\\..*$",
+    "^click_extended/core/nodes/_root_node\\.py$",
+    "^click_extended/utils/dispatch\\.py$",
+]
 persistent = true
 
 [tool.pylint.messages_control]

click_extended-1.0.6/click_extended/decorators/check/regex.py

@@ -1,47 +0,0 @@
-"""Check if a value matches a regex pattern."""
-
-import re
-from typing import Any
-
-from click_extended.core.nodes.child_node import ChildNode
-from click_extended.core.other.context import Context
-from click_extended.types import Decorator
-
-
-class Regex(ChildNode):
-    """Check if a value matches a regex pattern."""
-
-    def handle_str(
-        self,
-        value: str,
-        context: Context,
-        *args: Any,
-        **kwargs: Any,
-    ) -> Any:
-        patterns = kwargs["patterns"]
-        for pattern in patterns:
-            if re.fullmatch(pattern, value):
-                return value
-
-        raise ValueError(
-            f"Value '{value}' does not match any of the patterns: {patterns}"
-        )
-
-
-def regex(*patterns: str) -> Decorator:
-    """
-    Check if a value matches a regex pattern.
-
-    Type: `ChildNode`
-
-    Supports: `str`
-
-    Args:
-        *patterns (str):
-            The regex patterns to check against.
-
-    Returns:
-        Decorator:
-            The decorated function.
-    """
-    return Regex.as_decorator(patterns=patterns)