click-extended 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

click_extended/decorators/check/is_hostname.py

@@ -0,0 +1,47 @@
+"""Check if a value is a valid hostname."""
+
+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
+
+HOSTNAME_PATTERN = re.compile(r"(?!-)[A-Z\d-]{1,63}(?<!-)$", re.IGNORECASE)
+
+
+class IsHostname(ChildNode):
+    """Check if a value is a valid hostname."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if len(value) > 255:
+            raise ValueError(f"Value '{value}' is too long to be a hostname.")
+
+        if value[-1] == ".":
+            value = value[:-1]
+
+        if not all(HOSTNAME_PATTERN.match(x) for x in value.split(".")):
+            raise ValueError(f"Value '{value}' is not a valid hostname.")
+
+        return value
+
+
+def is_hostname() -> Decorator:
+    """
+    Check if a value is a valid hostname.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsHostname.as_decorator()

click_extended/decorators/check/is_ipv4.py

@@ -0,0 +1,46 @@
+"""Check if a value is a valid IPv4 address."""
+
+import ipaddress
+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 IsIpv4(ChildNode):
+    """Check if a value is a valid IPv4 address."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        try:
+            ip = ipaddress.ip_address(value)
+            if not isinstance(ip, ipaddress.IPv4Address):
+                raise ValueError(
+                    f"Value '{value}' is not a valid IPv4 address."
+                )
+        except ValueError as e:
+            raise ValueError(
+                f"Value '{value}' is not a valid IPv4 address."
+            ) from e
+        return value
+
+
+def is_ipv4() -> Decorator:
+    """
+    Check if a value is a valid IPv4 address.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsIpv4.as_decorator()

click_extended/decorators/check/is_ipv6.py

@@ -0,0 +1,46 @@
+"""Check if a value is a valid IPv6 address."""
+
+import ipaddress
+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 IsIpv6(ChildNode):
+    """Check if a value is a valid IPv6 address."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        try:
+            ip = ipaddress.ip_address(value)
+            if not isinstance(ip, ipaddress.IPv6Address):
+                raise ValueError(
+                    f"Value '{value}' is not a valid IPv6 address."
+                )
+        except ValueError as e:
+            raise ValueError(
+                f"Value '{value}' is not a valid IPv6 address."
+            ) from e
+        return value
+
+
+def is_ipv6() -> Decorator:
+    """
+    Check if a value is a valid IPv6 address.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsIpv6.as_decorator()

click_extended/decorators/check/is_json.py

@@ -0,0 +1,40 @@
+"""Check if a value is valid JSON."""
+
+import json
+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 IsJson(ChildNode):
+    """Check if a value is valid JSON."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        try:
+            json.loads(value)
+        except json.JSONDecodeError as e:
+            raise ValueError(f"Value '{value}' is not valid JSON.") from e
+        return value
+
+
+def is_json() -> Decorator:
+    """
+    Check if a value is valid JSON.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsJson.as_decorator()

click_extended/decorators/check/is_mac_address.py

@@ -0,0 +1,40 @@
+"""Check if a value is a valid MAC address."""
+
+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
+
+MAC_PATTERN = r"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})|([0-9a-fA-F]{4}\.[0-9a-fA-F]{4}\.[0-9a-fA-F]{4})$"  # pylint: disable=line-too-long
+
+
+class IsMacAddress(ChildNode):
+    """Check if a value is a valid MAC address."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if not re.fullmatch(MAC_PATTERN, value):
+            raise ValueError(f"Value '{value}' is not a valid MAC address.")
+        return value
+
+
+def is_mac_address() -> Decorator:
+    """
+    Check if a value is a valid MAC address.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsMacAddress.as_decorator()

click_extended/decorators/check/is_negative.py

@@ -0,0 +1,37 @@
+"""Check if a value is negative."""
+
+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 IsNegative(ChildNode):
+    """Check if a value is negative."""
+
+    def handle_numeric(
+        self,
+        value: int | float,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if value >= 0:
+            raise ValueError(f"Value '{value}' is not negative.")
+        return value
+
+
+def is_negative() -> Decorator:
+    """
+    Check if a value is negative.
+
+    Type: `ChildNode`
+
+    Supports: `int`, `float`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsNegative.as_decorator()

click_extended/decorators/check/is_non_zero.py

@@ -0,0 +1,37 @@
+"""Check if a value is not zero."""
+
+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 IsNonZero(ChildNode):
+    """Check if a value is not zero."""
+
+    def handle_numeric(
+        self,
+        value: int | float,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if value == 0:
+            raise ValueError(f"Value '{value}' is zero.")
+        return value
+
+
+def is_non_zero() -> Decorator:
+    """
+    Check if a value is not zero.
+
+    Type: `ChildNode`
+
+    Supports: `int`, `float`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsNonZero.as_decorator()

click_extended/decorators/check/is_port.py

@@ -0,0 +1,39 @@
+"""Check if a value is a valid network port."""
+
+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 IsPort(ChildNode):
+    """Check if a value is a valid network port."""
+
+    def handle_int(
+        self,
+        value: int,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if not 1 <= value <= 65535:
+            raise ValueError(
+                f"Value '{value}' is not a valid port number (1-65535)."
+            )
+        return value
+
+
+def is_port() -> Decorator:
+    """
+    Check if a value is a valid network port.
+
+    Type: `ChildNode`
+
+    Supports: `int`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsPort.as_decorator()

click_extended/decorators/check/is_positive.py

@@ -0,0 +1,37 @@
+"""Check if a value is positive."""
+
+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 IsPositive(ChildNode):
+    """Check if a value is positive."""
+
+    def handle_numeric(
+        self,
+        value: int | float,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        if value <= 0:
+            raise ValueError(f"Value '{value}' is not positive.")
+        return value
+
+
+def is_positive() -> Decorator:
+    """
+    Check if a value is positive.
+
+    Type: `ChildNode`
+
+    Supports: `int`, `float`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsPositive.as_decorator()

click_extended/decorators/check/is_url.py

@@ -0,0 +1,75 @@
+"""Check if a value is a valid URL."""
+
+from typing import Any
+from urllib.parse import urlparse
+
+from click_extended.core.nodes.child_node import ChildNode
+from click_extended.core.other.context import Context
+from click_extended.types import Decorator
+from click_extended.utils.humanize import humanize_iterable
+
+
+class IsUrl(ChildNode):
+    """Check if a value is a valid URL."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        schemes = kwargs.get("schemes")
+        require_tld = kwargs.get("require_tld", True)
+
+        try:
+            result = urlparse(value)
+            if not all([result.scheme, result.netloc]):
+                raise ValueError(f"Value '{value}' is not a valid URL.")
+
+            if schemes and result.scheme not in schemes:
+                humanized_schemes = humanize_iterable(
+                    schemes,
+                    wrap="'",
+                    prefix_singular="scheme is",
+                    prefix_plural="shemes are",
+                )
+                raise ValueError(
+                    f"URL scheme '{result.scheme}' is not allowed. "
+                    f"Allowed {humanized_schemes}"
+                )
+
+            if require_tld and "." not in result.netloc:
+                raise ValueError(f"URL '{value}' does not have a valid TLD.")
+
+        except ValueError as e:
+            raise e
+        except Exception as e:
+            raise ValueError(f"Value '{value}' is not a valid URL.") from e
+
+        return value
+
+
+def is_url(
+    schemes: list[str] | None = None,
+    require_tld: bool = True,
+) -> Decorator:
+    """
+    Check if a value is a valid URL.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Args:
+        schemes (list[str] | None, optional):
+            List of allowed URL schemes (e.g., ["http", "https"]).
+            Defaults to `None` (all schemes allowed).
+        require_tld (bool, optional):
+            Whether to require a Top-Level Domain (TLD). Defaults to `True`.
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsUrl.as_decorator(schemes=schemes, require_tld=require_tld)

click_extended/decorators/check/is_uuid.py

@@ -0,0 +1,40 @@
+"""Check if a value is a valid UUID."""
+
+import uuid
+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 IsUuid(ChildNode):
+    """Check if a value is a valid UUID."""
+
+    def handle_str(
+        self,
+        value: str,
+        context: Context,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Any:
+        try:
+            uuid.UUID(value)
+        except ValueError as e:
+            raise ValueError(f"Value '{value}' is not a valid UUID.") from e
+        return value
+
+
+def is_uuid() -> Decorator:
+    """
+    Check if a value is a valid UUID.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Returns:
+        Decorator:
+            The decorated function.
+    """
+    return IsUuid.as_decorator()

click_extended/decorators/check/length.py

@@ -0,0 +1,68 @@
+"""Child decorator to check if a string is within length bounds."""
+
+# pylint: disable=redefined-builtin
+
+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 Length(ChildNode):
+    """Child decorator to check if a string is within length bounds."""
+
+    def handle_str(
+        self, value: str, context: Context, *args: Any, **kwargs: Any
+    ) -> Any:
+        min_len: int | None = kwargs["min"]
+        max_len: int | None = kwargs["max"]
+
+        if min_len is not None and len(value) < min_len:
+            s = "" if min_len == 1 else "s"
+            raise ValueError(
+                f"Value is too short, must be at least {min_len} character{s}."
+            )
+
+        if max_len is not None and len(value) > max_len:
+            s = "" if max_len == 1 else "s"
+            raise ValueError(
+                f"Value is too long, must be at most {max_len} character{s}."
+            )
+
+        return value
+
+
+def length(min: int | None = None, max: int | None = None) -> Decorator:
+    """
+    Check if a string is within length bounds.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Args:
+        min (int | None):
+            Minimum length or `None` for no minimum.
+        max (int | None):
+            Maximum length or `None` for no maximum.
+
+    Returns:
+        Decorator:
+            The decorated function.
+
+    Raises:
+        ValueError:
+            If neither min nor max is specified.
+
+    Examples:
+        ```python
+        @length(min=5, max=20)  # Between 5-20 characters
+        @length(min=5)          # At least 5 characters
+        @length(max=20)         # At most 20 characters
+        ```
+    """
+    if min is None and max is None:
+        raise ValueError("At least one of 'min' or 'max' must be specified")
+
+    return Length.as_decorator(min=min, max=max)

click_extended/decorators/check/not_empty.py

@@ -0,0 +1,49 @@
+"""Child decorator to check if a string is not empty."""
+
+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 NotEmpty(ChildNode):
+    """Child decorator to check if a string is not empty."""
+
+    def handle_str(
+        self, value: str, context: Context, *args: Any, **kwargs: Any
+    ) -> Any:
+        if not value or value.isspace():
+            raise ValueError(
+                "Value cannot be empty or contain only whitespace."
+            )
+
+        return value
+
+
+def not_empty() -> Decorator:
+    """
+    Check if a string is not empty.
+
+    Type: `ChildNode`
+
+    Supports: `str`
+
+    Raises:
+        ValueError:
+            If the value is empty or contains only whitespace.
+
+    Returns:
+        Decorator:
+            The decorator function.
+
+    Examples:
+        ```python
+        @command()
+        @option("name")
+        @not_empty()
+        def greet(name: str) -> None:
+            click.echo(f"Hello, {name}!")
+        ```
+    """
+    return NotEmpty.as_decorator()

click_extended/decorators/check/regex.py

@@ -0,0 +1,47 @@
+"""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)