click-extended 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

click_extended/errors.py

@@ -3,7 +3,8 @@
 # pylint: disable=too-many-arguments
 # pylint: disable=too-many-positional-arguments
 
-import typing as t
+import inspect
+from typing import IO, Any
 
 import click
 from click import ClickException
@@ -17,6 +18,7 @@ class ClickExtendedError(Exception):
     """Base exception for exceptions defined in the `click_extended` library."""
 
 
+# Catchable errors
 class CatchableError(ClickExtendedError):
     """Base exception for exceptions raised inside a child node.
 
@@ -34,6 +36,72 @@ class CatchableError(ClickExtendedError):
         super().__init__(message)
 
 
+class ChildNodeProcessError(CatchableError):
+    """
+    Base class for exceptions which must be raised inside
+    the `process()` method of a `ChildNode`.
+    """
+
+    def __init__(self, message: str, **kwargs: str) -> None:
+        """
+        Initialize a new `ChildNodeProcessError` instance.
+
+        Args:
+            message (str):
+                The error message. If child_name is found, it will be
+                prefixed automatically. Subclasses can access child_name
+                via self.child_name to format custom messages.
+
+        Raises:
+            RuntimeError:
+                If raised outside a ChildNode context.
+        """
+        self.child_name: str | None = None
+        frame = inspect.currentframe()
+
+        if frame:
+            current_frame = frame.f_back
+            depth = 0
+            max_depth = 10
+
+            while current_frame and depth < max_depth:
+                caller_locals = current_frame.f_locals
+                if "self" in caller_locals:
+                    self_obj = caller_locals["self"]
+                    if hasattr(self_obj, "name") and hasattr(
+                        self_obj, "process"
+                    ):
+                        self.child_name = self_obj.name
+                        break
+                current_frame = current_frame.f_back
+                depth += 1
+
+        if not self.child_name:
+            raise RuntimeError(
+                f"{self.__class__.__name__} must be raised from within a "
+                f"ChildNode.process() method. The exception was raised outside "
+                f"a valid ChildNode context."
+            )
+
+        formatted_message = message.format(name=self.child_name, **kwargs)
+        super().__init__(formatted_message)
+
+
+class UnhandledValueError(ChildNodeProcessError):
+    """Exception raised when a value in the `process()` method is unexpected."""
+
+    def __init__(self, value: Any) -> None:
+        """
+        Initialize a new `UnhandledValueError` instance.
+
+        Args:
+            value (Any):
+                The unexpected value.
+        """
+        message = "Received unexpected value for '{name}' of type '{type}'"
+        super().__init__(message, type=type(value).__name__)
+
+
 class ValidationError(CatchableError):
     """Exception raised when validation fails in a child node."""
 
@@ -42,6 +110,13 @@ class TransformError(CatchableError):
     """Exception raised when transformation fails in a child node."""
 
 
+class UnknownError(ChildNodeProcessError):
+    """
+    Exception raised when an unexpected error occurs or parts of code
+    which is unhandled.
+    """
+
+
 class ParameterError(ClickException):
     """Exception raised when parameter validation or transformation fails.
 
@@ -78,7 +153,7 @@ class ParameterError(ClickException):
             return f"({self.param_hint}): {self.message}"
         return self.message
 
-    def show(self, file: t.IO[t.Any] | None = None) -> None:
+    def show(self, file: IO[Any] | None = None) -> None:
         """Display the error with usage information (like Click does)."""
         if file is None:
             file = get_text_stderr()
@@ -102,6 +177,7 @@ class ParameterError(ClickException):
         echo(f"Error {self.format_message()}", file=file, color=color)
 
 
+# Node errors
 class NoParentError(ClickExtendedError):
     """Exception raised when no `ParentNode` has been defined."""
 

{click_extended-0.2.1.dist-info → click_extended-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 0.2.1
+Version: 0.3.0
 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-0.3.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+click_extended/__init__.py,sha256=wBUV7-CmgDBKSnDj3_MbYCjHv2zAaATQ795Y9Xs-0NE,858
+click_extended/errors.py,sha256=ITtVGZ1GosrrGnUbUuJQueoJqFCtJvj83dKJrQqkCmU,10500
+click_extended/types.py,sha256=tiz-toTYABwFTsxUMIDRhPiq3H_V3nhrAcV8VGEKyzA,786
+click_extended-0.3.0.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
+click_extended-0.3.0.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
+click_extended-0.3.0.dist-info/METADATA,sha256=8cIZt72pTFI9IRW-0nO30gwXrSBg_cRrgTmJj0Oba2g,8295
+click_extended-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+click_extended-0.3.0.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
+click_extended-0.3.0.dist-info/RECORD,,

click_extended-0.2.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-click_extended/__init__.py,sha256=wBUV7-CmgDBKSnDj3_MbYCjHv2zAaATQ795Y9Xs-0NE,858
-click_extended/errors.py,sha256=IQ98vY90enamFr8yHFL6OUeV42tuAYy6NKVYXUsZRhY,8067
-click_extended/types.py,sha256=tiz-toTYABwFTsxUMIDRhPiq3H_V3nhrAcV8VGEKyzA,786
-click_extended-0.2.1.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
-click_extended-0.2.1.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
-click_extended-0.2.1.dist-info/METADATA,sha256=QEedx4AD1rO28TRyfEkoMSeACt3PHwEYVGiLvaP0lPk,8295
-click_extended-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-click_extended-0.2.1.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
-click_extended-0.2.1.dist-info/RECORD,,