Skip to main content

Minimal library that enables partitioning of iterable collections in a concise manner.

PyPI version and link. Read the Docs documentation status. GitHub Actions status. Coveralls test coverage summary.

Purpose

This library provides a function for partitioning iterable data structure instances. When the number of parts is specified explicitly, it is treated as a strict requirement and an exception is raised when it cannot be satisfied. When a length for all parts (or each part) is specified explicitly, a best-effort approach is used: as many parts of the specified length are retrieved as possible, with the possibility that some parts at the end of the partition sequence have a shorter (but still non-zero) length.

Installation and Usage

This library is available as a package on PyPI:

python -m pip install parts

The library can be imported in the usual manner:

import parts
from parts import parts

Examples

Several examples are presented below:

>>> list(parts([1, 2, 3, 4, 5, 6, 7], length=2))
[[1, 2], [3, 4], [5, 6], [7]]

>>> list(parts([1, 2, 3, 4, 5, 6, 7], length=4))
[[1, 2, 3, 4], [5, 6, 7]]

>>> list(parts([1, 2, 3, 4, 5, 6, 7], number=1))
[[1, 2, 3, 4, 5, 6, 7]]

>>> list(parts([1, 2, 3, 4, 5, 6, 7], 5))
[[1], [2], [3], [4, 5], [6, 7]]

>>> list(parts([1, 2, 3, 4, 5, 6], 2, 3))
[[1, 2, 3], [4, 5, 6]]

>>> list(parts([1, 2, 3, 4, 5, 6], number=3, length=2))
[[1, 2], [3, 4], [5, 6]]

>>> list(parts([1, 2, 3, 4, 5, 6, 7], 7, [1, 1, 1, 1, 1, 1, 1]))
[[1], [2], [3], [4], [5], [6], [7]]

>>> list(parts([1, 2, 3, 4, 5, 6], length=[2, 2, 2]))
[[1, 2], [3, 4], [5, 6]]

>>> list(parts([1, 2, 3, 4, 5, 6], length=[1, 2, 3]))
[[1], [2, 3], [4, 5, 6]]

>>> list(parts([1, 2, 3, 4, 5, 6, 7], number=3, length=2))
Traceback (most recent call last):
  ...
ValueError: cannot retrieve 3 parts from object given part length parameter of 2

Development

All installation and development dependencies are fully specified in pyproject.toml. The project.optional-dependencies object is used to specify optional requirements for various development tasks. This makes it possible to specify additional options (such as docs, lint, and so on) when performing installation using pip:

python -m pip install ".[docs,lint]"

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install ".[test]"
python -m pytest

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python src/parts/parts.py -v

Style conventions are enforced using Pylint:

python -m pip install ".[lint]"
python -m pylint src/parts

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

Beginning with version 0.2.0, the version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on PyPI via the GitHub Actions workflow found in .github/workflows/build-publish-sign-release.yml that follows the recommendations found in the Python Packaging User Guide.

Ensure that the correct version number appears in pyproject.toml, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an automation rule that activates and sets as the default all tagged versions.

To publish the package, create and push a tag for the version being published (replacing ?.?.? with the version number):

git tag ?.?.?
git push origin ?.?.?

Metadata

Release files for parts 4.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for parts 4.0.0
File Size Uploaded
parts-4.0.0.tar.gz 9.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for parts 4.0.0
File Interpreter ABI Platform
parts-4.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 17.1 kB

Release files / parts-4.0.0.tar.gz

Download URL parts-4.0.0.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
bb0fdba3e636e0a220287fa17dce2251ba07f2324a79aa1018706fe8a8d98b15
BLAKE2b-256 checksum
How to use checksums
c4e6392a491e4a5cfa953b03c17c0c737dbdd55b32df53454472d4c554ba97ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 16, 2025.

Transparency log

Release files / parts-4.0.0-py3-none-any.whl

Download URL parts-4.0.0-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
58e5dd6c8d5c81e21dbdf16ea3e6d493edabc07771aeea8e60d5da05677706b1
BLAKE2b-256 checksum
How to use checksums
291b35a0e18e5fc77c759b6abc68a27f0b9bbbd796302bcb147a9ecbb4a6305a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 16, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

4.0.0 This release

2 release files

3.0.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.2

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page