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

click_extended/__init__.py

@@ -2,6 +2,7 @@
 
 from click_extended.core.decorators.argument import argument
 from click_extended.core.decorators.command import command
+from click_extended.core.decorators.context import context
 from click_extended.core.decorators.env import env
 from click_extended.core.decorators.group import group
 from click_extended.core.decorators.option import option
@@ -12,6 +13,7 @@ from click_extended.core.decorators.tag import tag
 __all__ = [
     "argument",
     "command",
+    "context",
     "env",
     "group",
     "option",

click_extended/core/decorators/context.py

@@ -0,0 +1,56 @@
+"""`ParentNode` to inject the context into the function."""
+
+# pylint: disable=redefined-builtin
+# pylint: disable=redefined-outer-name
+
+from typing import Any
+
+from click_extended.core.nodes.parent_node import ParentNode
+from click_extended.core.other.context import Context as Ctx
+from click_extended.types import Decorator
+
+
+class Context(ParentNode):
+    """`ParentNode` to inject the context into the function."""
+
+    def load(self, context: Ctx, *args: Any, **kwargs: Any) -> Ctx:
+        return context
+
+
+def context(
+    name: str = "ctx",
+    param: str | None = None,
+    help: str | None = None,
+    tags: str | list[str] | None = None,
+    **kwargs: Any,
+) -> Decorator:
+    """
+    A `ParentNode` to inject the context into the function.
+
+    Type: `ParentNode`
+
+    Args:
+        name (str, optional):
+            Internal node name (must be snake_case). Defaults
+            to "ctx".
+        param (str, optional):
+            The parameter name to inject into the function.
+            If not provided, uses `name` (or derived name).
+        help (str, optional):
+            Help text for this parameter.
+        tags (str | list[str], optional):
+            Tag(s) to associate with this parameter for grouping.
+        **kwargs (Any):
+            Additional keyword arguments.
+
+    Returns:
+        Callable:
+            A decorator function that registers the context parent node.
+    """
+    return Context.as_decorator(
+        name=name,
+        param=param,
+        help=help,
+        tags=tags,
+        **kwargs,
+    )

{click_extended-1.0.1.dist-info → click_extended-1.0.2.dist-info}/METADATA

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

@@ -1,4 +1,4 @@
-click_extended/__init__.py,sha256=wTarCHBxMz59fe0vCTyq8RiN0COooJ892C0N2OuPLLQ,640
+click_extended/__init__.py,sha256=mF6rVnQnG-IiMSo-hX16ZzgSv8F-F3BoAyX5PDx6x90,714
 click_extended/classes.py,sha256=SdwglQ7O5ahjYeVnaM9_hCU14BYZBv8C0ZjWQIo7A_I,837
 click_extended/errors.py,sha256=tkvAXs4oUZ8SFgX37KhYrHAlsxmOGrSFLIezCH9NDQI,13897
 click_extended/types.py,sha256=0YT4QN269H-01RVxDGSpMT_hJm8cTcONonpX4_YxJlg,238
@@ -6,6 +6,7 @@ click_extended/core/__init__.py,sha256=oTJS5M1OAwRQ57aMcWV7v2D2kHjCn8zTOpPEIRpTL
 click_extended/core/decorators/__init__.py,sha256=AxqTVsGJcCG5d60RzffSh4cqA4U_okaMl3hlObqMOy4,656
 click_extended/core/decorators/argument.py,sha256=MzkMkkayR7XeNNtbHstj1PpFnrCD-VCFAE3SnpO7OMY,7201
 click_extended/core/decorators/command.py,sha256=82rwi8PIMGgOagFoNISOQkdEebKxvS9A_RHV80shUzI,2803
+click_extended/core/decorators/context.py,sha256=y_jzARNNdu2JyUhIaUFpCAurztOTsYJTX96HQ2csZs0,1546
 click_extended/core/decorators/env.py,sha256=DgbQsOZ2De-Ur5hxR8hzN3-3T16K3FLsoZHS2EsKK6c,4777
 click_extended/core/decorators/group.py,sha256=_bammCVi_7vsw7YgSUTQuQp6XFUHy7knNcOmyg6DiPc,2859
 click_extended/core/decorators/option.py,sha256=E7NzM7dNtICh9YcAvYPvJkdvuxKDNjCIFl9a8ZyhXWQ,11810
@@ -141,9 +142,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.1.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
-click_extended-1.0.1.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
-click_extended-1.0.1.dist-info/METADATA,sha256=2afilQ2XKHdUMPsZR6_-7Cv1mJW7o8UvKyeYvVS8BbY,10762
-click_extended-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-click_extended-1.0.1.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
-click_extended-1.0.1.dist-info/RECORD,,
+click_extended-1.0.2.dist-info/licenses/AUTHORS.md,sha256=NkShPinjqtnRDQVRyVnfJuOGM56sejauE3WRoYCcbtw,132
+click_extended-1.0.2.dist-info/licenses/LICENSE,sha256=gjO8hzM4mFSBXFikktaXVSgmXGcre91_GPJ-E_yP56E,1075
+click_extended-1.0.2.dist-info/METADATA,sha256=LoKIzHzO5csaGIpPD68v1R800kVlUM7ai_ACXolUxzs,10762
+click_extended-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+click_extended-1.0.2.dist-info/top_level.txt,sha256=2G3bm6tCNv80okRm773jKTk-_z1ElY-seaozZrn_TxA,15
+click_extended-1.0.2.dist-info/RECORD,,