click-compose 2025.10.27__py2.py3-none-any.whl

click_compose/__init__.py

@@ -0,0 +1,82 @@
+"""
+Composable Click callback utilities for building flexible CLI applications.
+"""
+
+from collections.abc import Callable, Sequence
+from typing import TypeVar
+
+import click
+
+T = TypeVar("T")
+U = TypeVar("U")
+
+
+def sequence_validator(
+    *,
+    validator: Callable[[click.Context | None, click.Parameter | None, T], U],
+) -> Callable[
+    [click.Context | None, click.Parameter | None, Sequence[T]], Sequence[U]
+]:
+    """Wrap a single-value validator to apply it to a sequence of values.
+
+    This function takes a Click callback that validates a single value and
+    returns a new callback that applies the same validation to each element
+    in a sequence. The validator can transform the type of each element.
+
+    Args:
+        validator: A Click callback that validates a single value.
+
+    Returns:
+        A Click callback that validates a sequence of values.
+    """
+
+    def callback(
+        ctx: click.Context | None,
+        param: click.Parameter | None,
+        value: Sequence[T],
+    ) -> Sequence[U]:
+        """
+        Apply the validator to each element in the sequence.
+        """
+        return_values: tuple[U, ...] = ()
+        for item in value:
+            returned_value = validator(ctx, param, item)
+            return_values = (*return_values, returned_value)
+        return return_values
+
+    return callback
+
+
+def multi_callback(
+    *,
+    callbacks: Sequence[Callable[..., T]],
+) -> Callable[[click.Context | None, click.Parameter | None, T], T]:
+    """Create a Click-compatible callback that applies multiple callbacks in
+    sequence.
+
+    This function takes a sequence of Click callbacks and returns a new
+    callback that applies each callback in order, threading the value through
+    each one. Each callback can transform the type, allowing for flexible
+    pipelines of transformations and validations.
+
+    Args:
+        callbacks: A sequence of Click callbacks to apply in order.
+
+    Returns:
+        A Click callback that applies all the given callbacks in sequence.
+    """
+
+    def callback(
+        ctx: click.Context | None,
+        param: click.Parameter | None,
+        value: T,
+    ) -> T:
+        """
+        Apply each callback in sequence to the value.
+        """
+        result = value
+        for cb in callbacks:
+            result = cb(ctx, param, result)
+        return result
+
+    return callback

click_compose-2025.10.27.dist-info/METADATA

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: click-compose
+Version: 2025.10.27
+Summary: Composable Click callback utilities for building flexible CLI applications.
+Author-email: Adam Dangoor <adamdangoor@gmail.com>
+License-Expression: MIT
+Project-URL: Source, https://github.com/adamtheturtle/click-compose
+Keywords: callbacks,cli,click,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Provides-Extra: dev
+Requires-Dist: actionlint-py==1.7.8.24; extra == "dev"
+Requires-Dist: check-manifest==0.51; extra == "dev"
+Requires-Dist: deptry==0.23.1; extra == "dev"
+Requires-Dist: doc8==2.0.0; extra == "dev"
+Requires-Dist: docformatter==1.7.7; extra == "dev"
+Requires-Dist: furo==2025.9.25; extra == "dev"
+Requires-Dist: interrogate==1.7.0; extra == "dev"
+Requires-Dist: mypy[faster-cache]==1.18.2; extra == "dev"
+Requires-Dist: mypy-strict-kwargs==2025.4.3; extra == "dev"
+Requires-Dist: packaging>=24.0; extra == "dev"
+Requires-Dist: pre-commit==4.3.0; extra == "dev"
+Requires-Dist: pydocstyle==6.3; extra == "dev"
+Requires-Dist: pygments==2.19.2; extra == "dev"
+Requires-Dist: pylint[spelling]==4.0.2; extra == "dev"
+Requires-Dist: pylint-per-file-ignores==3.1.0; extra == "dev"
+Requires-Dist: pyproject-fmt==2.11.0; extra == "dev"
+Requires-Dist: pyright==1.1.407; extra == "dev"
+Requires-Dist: pyroma==5.0; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: pytest-regressions==2.8.3; extra == "dev"
+Requires-Dist: pyyaml==6.0.3; extra == "dev"
+Requires-Dist: ruff==0.14.2; extra == "dev"
+Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
+Requires-Dist: shfmt-py==3.12.0.2; extra == "dev"
+Requires-Dist: sphinx==8.2.3; extra == "dev"
+Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
+Requires-Dist: sphinx-lint==1.0.0; extra == "dev"
+Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
+Requires-Dist: sphinx-substitution-extensions==2025.10.24; extra == "dev"
+Requires-Dist: sphinxcontrib-spelling==8.0.1; extra == "dev"
+Requires-Dist: vulture==2.14; extra == "dev"
+Requires-Dist: yamlfix==1.19.0; extra == "dev"
+Provides-Extra: release
+Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
+Dynamic: license-file
+
+click-compose
+=============
+
+Composable Click callback utilities for building flexible CLI applications.
+
+.. contents::
+   :local:
+
+Installation
+------------
+
+.. code-block:: shell
+
+   $ pip install click-compose
+
+Or with ``uv``:
+
+.. code-block:: shell
+
+   $ uv add click-compose
+
+Quick Start
+-----------
+
+``click-compose`` provides two main utilities for composing Click callbacks:
+
+multi_callback
+~~~~~~~~~~~~~~
+
+Combine multiple callbacks into a single callback that applies them in sequence:
+
+.. code-block:: python
+
+   import click
+   from click_compose import multi_callback
+
+   def validate_positive(ctx, param, value):
+       if value <= 0:
+           raise click.BadParameter("Must be positive")
+       return value
+
+   def validate_max_100(ctx, param, value):
+       if value > 100:
+           raise click.BadParameter("Must be <= 100")
+       return value
+
+   @click.command()
+   @click.option(
+       "--count",
+       type=int,
+       callback=multi_callback([validate_positive, validate_max_100]),
+   )
+   def cmd(count):
+       click.echo(f"Count: {count}")
+
+sequence_validator
+~~~~~~~~~~~~~~~~~~
+
+Apply a validator to each element in a sequence (useful with ``multiple=True``):
+
+.. code-block:: python
+
+   import click
+   from click_compose import sequence_validator
+
+   def validate_positive(ctx, param, value):
+       if value <= 0:
+           raise click.BadParameter("Must be positive")
+       return value
+
+   @click.command()
+   @click.option(
+       "--numbers",
+       multiple=True,
+       type=int,
+       callback=sequence_validator(validate_positive),
+   )
+   def cmd(numbers):
+       click.echo(f"Sum: {sum(numbers)}")
+
+Documentation
+-------------
+
+See the `full documentation <https://adamtheturtle.github.io/click-compose/>`__.

click_compose-2025.10.27.dist-info/RECORD

@@ -0,0 +1,7 @@
+click_compose/__init__.py,sha256=KBb4qVJmPIhgmvMDynZIBZVwKmf6DxmvpKM6-qHvzTA,2364
+click_compose/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+click_compose-2025.10.27.dist-info/licenses/LICENSE,sha256=N3qm7laipxyuXkWpYllj89AObvPbtWgoABmaKfhQYL4,1069
+click_compose-2025.10.27.dist-info/METADATA,sha256=rYhy-_Qwt7W73276A9O_y5I5HntUJxDcAEnhmHCqGwo,4439
+click_compose-2025.10.27.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+click_compose-2025.10.27.dist-info/top_level.txt,sha256=D6w2GKY-8Qwmbiv3G8DyrtwEjiu-yd7I6n6IpPIUauU,14
+click_compose-2025.10.27.dist-info/RECORD,,

click_compose-2025.10.27.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any
+

click_compose-2025.10.27.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Adam Dangoor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

click_compose-2025.10.27.dist-info/top_level.txt

@@ -0,0 +1 @@
+click_compose