crosszip 0.1.0__py3-none-any.whl

crosszip/__init__.py

@@ -0,0 +1 @@
+from .crosszip import crosszip as crosszip

crosszip/crosszip.py

@@ -0,0 +1,75 @@
+import itertools
+from collections.abc import Callable, Iterable
+from typing import Any
+
+
+def crosszip(func: Callable[..., Any], *iterables: Iterable[Any]) -> list[Any]:
+    """Apply a given function to all combinations of elements from multiple iterables.
+
+    This function computes the Cartesian product of the input iterables (i.e., all possible
+    combinations of their elements) and applies the provided function to each combination.
+
+    Args:
+        func (Callable[..., Any]): A function that accepts as many arguments as there are iterables.
+        *iterables (Iterable[Any]): Two or more iterables to generate combinations from. Each iterable
+            should contain elements that are valid inputs for the function `func`.
+
+    Returns:
+        list[Any]: A list of results from applying the function to each combination of elements.
+
+    Raises:
+        TypeError: If any of the provided arguments is not an iterable.
+
+    Example Usage:
+
+        # Example 1: Basic usage with lists
+        >>> def concat(a, b, c):
+        >>>     return f"{a}-{b}-{c}"
+
+        >>> list1 = [1, 2]
+        >>> list2 = ['a', 'b']
+        >>> list3 = [True, False]
+
+        >>> crosszip(concat, list1, list2, list3)
+        ['1-a-True', '1-a-False', '1-b-True', '1-b-False', '2-a-True', '2-a-False', '2-b-True', '2-b-False']
+
+        # Example 2: Using tuples and a mathematical function
+        >>> def add(a, b):
+        >>>     return a + b
+
+        >>> crosszip(add, (1, 2), (10, 20))
+        [11, 21, 12, 22]
+
+        # Example 3: Using sets (order may vary) and a string concatenation function
+        >>> crosszip(concat, {1, 2}, {'x', 'y'}, {'foo', 'bar'})
+        ['1-x-foo', '1-x-bar', '1-y-foo', '1-y-bar', '2-x-foo', '2-x-bar', '2-y-foo', '2-y-bar']
+
+        # Example 4: Using a generator
+        >>> def gen():
+        >>>     yield 1
+        >>>     yield 2
+
+        >>> crosszip(concat, gen(), ['a', 'b'], ['x', 'y'])
+        ['1-a-x', '1-a-y', '1-b-x', '1-b-y', '2-a-x', '2-a-y', '2-b-x', '2-b-y']
+
+    Example with Error Handling:
+
+        # Example 5: Passing a non-iterable argument (raises TypeError)
+        >>> crosszip(concat, [1, 2], 123, ['a', 'b'])
+        TypeError: Expected an iterable, but got int: 123
+
+    Notes:
+        - The function assumes that each iterable contains values compatible with the function `func`.
+        - For large input iterables, the number of combinations grows exponentially, so use with care when working with large datasets.
+
+    """
+    # Ensure all arguments are iterable
+    for iterable in iterables:
+        if not isinstance(iterable, Iterable):
+            raise TypeError(
+                f"Expected an iterable, but got {type(iterable).__name__}: {iterable}",
+            )
+
+    # Apply the function to the Cartesian product of all the iterables
+    combinations = itertools.product(*iterables)
+    return list(itertools.starmap(func, combinations))

crosszip-0.1.0.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.3
+Name: crosszip
+Version: 0.1.0
+Summary: Apply a given function to all combinations of elements from multiple iterables
+Project-URL: Repository, https://github.com/IndrajeetPatil/crosszip
+Project-URL: Changelog, https://github.com/IndrajeetPatil/crosszip/blob/main/CHANGELOG.md
+Author-email: Indrajeet Patil <patilindrajeet.science@gmail.com>
+License: # MIT License
+        
+        Copyright (c) 2024 crosszip authors
+        
+        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.
+Keywords: iterables
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# crosszip <img src="docs/assets/logo.png" align="right" width="240" />
+
+[![PyPI Version](https://img.shields.io/pypi/v/crosszip.svg)](https://pypi.org/project/crosszip/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+`crosszip` is a Python utility that makes it easy to apply a function to all possible combinations of elements from multiple iterables.
+It combines the power of the Cartesian product and functional programming into a single, intuitive tool.
+
+Additionally, `crosszip_parametrize` Pytest plugin is a decorator that simplifies running tests with all possible combinations of parameter values.
+This is particularly useful for testing functions or components across multiple dimensions of input parameters.
+
+---
+
+## Installation
+
+Install `crosszip` via pip:
+
+```bash
+pip install crosszip
+```
+
+Registering the crosszip marker for pytest is simple. Just add the following to your `pytest.ini` file:
+
+```
+[pytest]
+markers =
+    crosszip_parametrize: "mark test function for crosszip parametrization"
+```
+
+---
+
+## Key Features
+
+- **Flexible Input**: Works with any iterables, including lists, tuples, sets, and generators.
+- **pytest Plugin**: Supports parametrization of tests using `crosszip`.
+- **Simple API**: Minimalist, intuitive design for quick integration into your projects.
+
+---
+
+## Usage
+
+Example of using `crosszip`:
+
+```python
+# Label Generation for Machine Learning
+
+from crosszip import crosszip
+
+def create_label(category, subcategory, version):
+    return f"{category}_{subcategory}_v{version}"
+
+categories = ["cat", "dog"]
+subcategories = ["small", "large"]
+versions = ["1.0", "2.0"]
+
+labels = crosszip(create_label, categories, subcategories, versions)
+print(labels)
+# Output: ['cat_small_v1.0', 'cat_small_v2.0', 'cat_large_v1.0', 'cat_large_v2.0', 'dog_small_v1.0', 'dog_small_v2.0', 'dog_large_v1.0', 'dog_large_v2.0']
+```
+
+Example of using `pytest` marker `crosszip_parametrize`:
+
+```python
+# Testing Power Function
+
+import math
+from crosszip_parametrize import crosszip_parametrize
+
+@crosszip_parametrize(
+    "base", [2, 10],
+    "exponent", [-1, 0, 1],
+)
+def test_power_function(base, exponent):
+    result = math.pow(base, exponent)
+    assert result == base ** exponent
+```
+
+For more examples, check out the package documentation at:
+https://indrajeetpatil.github.io/crosszip/
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).
+
+---
+
+## Acknowledgements
+
+Hex sticker font is `Rubik`, and the image is taken from icon made by Freepik and available at flaticon.com.

crosszip-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+crosszip/__init__.py,sha256=mH09JIhqhR3m5dVKQI1UodqG_MATcbtx9zcHwhxC6f0,43
+crosszip/crosszip.py,sha256=IqLYk1G4QzmpzblIwh3apa2DqN0V120k7ZVz9mKzst8,2917
+crosszip/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+crosszip-0.1.0.dist-info/METADATA,sha256=ZAJhipmepliIqqz_61m-LWEoPO8izoo63tBpxheo7tQ,4777
+crosszip-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+crosszip-0.1.0.dist-info/licenses/LICENSE.md,sha256=ke3wuISxJfeZGp8fg3M7EamrT8nXtbiQlPr2j9XUAe4,1075
+crosszip-0.1.0.dist-info/RECORD,,

crosszip-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

crosszip-0.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 crosszip authors
+
+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.