crosszip 0.1.0

Apply a given function to all combinations of elements from multiple iterables

crosszip

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:

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:

# 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:

# 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.

---

Acknowledgements

Hex sticker font is Rubik, and the image is taken from icon made by Freepik and available at flaticon.com.