Iteration Utilities

0.13.0 · active · verified Wed Apr 15

iteration_utilities is a general-purpose collection of tools for functional programming based on Python's iterators and generators. It provides a wide array of functions, many inspired by the `itertools` module's recipes and the `toolz` package. Large fractions of its code are implemented in C for optimized performance. The library is under ongoing development, with the current stable version being 0.13.0, and its API may change in future releases.

Warnings

breaking The library is under ongoing development, and its API is subject to change. Functions or their signatures may be altered in future versions.
Fix: Refer to the latest documentation and changelog for each major or minor release.
breaking Support for older Python versions is periodically dropped. Python 3.5 and 3.6 compatibility was removed in version 0.12.0. Ensure your Python environment meets the 'Python >=3.7' requirement.
Fix: Upgrade to Python 3.7 or newer if using versions 0.12.0 or later.
deprecated The top-level `__version__` property was removed. To get the library's version, use `importlib.metadata.version` from the Python standard library.
Fix: Replace `iteration_utilities.__version__` with `importlib.metadata.version('iteration-utilities')`.
gotcha Some functions, notably `groupedby`, may experience slightly reduced performance in Python 3.13 due to changes in optimizations.
Fix: Be aware of potential performance implications if targeting Python 3.13 with performance-critical code utilizing these specific functions.
breaking In version 0.8.0, the `partial` function (if used) began allowing only plain string keyword-names in CPython 3.8. Additionally, private constants (e.g., `EQ_PY2`, `GE_PY3`) were removed from the module namespace.
Fix: Adjust usage of `partial` with keyword arguments and remove references to previously available private constants. Refer to the 0.8.0 changelog.

Install

pip install iteration-utilities Install stable version

Imports

Iterable
```
from iteration_utilities import Iterable
```
A convenience class for chaining iteration_utilities functions.
deepflatten
```
from iteration_utilities import deepflatten
```
Many functions are imported directly from the top-level package.

Quickstart

Demonstrates basic usage of the `Iterable` class for chaining methods and direct imports of utility functions like `duplicates` and `all_distinct`.

from iteration_utilities import Iterable, duplicates, all_distinct

# Example 1: Chaining operations with Iterable
data = [1, 2, 2, 3, 4, 4, 5, 5, 5]
processed_data = Iterable(data).filter(lambda x: x % 2 == 0).unique_everseen().as_list()
print(f"Processed even unique data: {processed_data}")

# Example 2: Using a standalone function like duplicates
duplicate_items = list(duplicates(data))
print(f"Duplicate items: {duplicate_items}")

# Example 3: Using all_distinct
is_all_distinct = all_distinct([1, 2, 3, 4])
is_not_distinct = all_distinct([1, 2, 2, 3])
print(f"[1, 2, 3, 4] all distinct? {is_all_distinct}")
print(f"[1, 2, 2, 3] all distinct? {is_not_distinct}")

view raw JSON →