Skip to main content

Cross-runtime compatibility polyfills for CircuitPython, MicroPython, and CPython — functools.partial and more.

Project description

chumicro-compat

Standard library features that CircuitPython and MicroPython are missing.

Import from chumicro_compat instead of the stdlib and your code works everywhere. On CPython it re-exports the real C implementations (zero overhead); on microcontrollers it provides lightweight pure-Python versions.

Installation

CircuitPython (circup)

circup uses bundles to find third-party packages — register the ChuMicro bundle once, then install by name:

circup bundle-add ChuMicro/ChuMicro-Bundle
circup install chumicro-compat

MicroPython (mip)

mpremote mip install github:ChuMicro/ChuMicro-Bundle/chumicro_compat

CPython (pip)

pip install chumicro-compat
Experimental (pre-release) versions and channel switching

Pre-release builds are published automatically when a library version is bumped. Do not register both bundles simultaneously — circup may pick either version for a given package.

# CircuitPython — switch to experimental
circup bundle-remove ChuMicro/ChuMicro-Bundle              # skip if never added
circup bundle-add ChuMicro/ChuMicro-Bundle-Experimental
circup install chumicro-compat

# MicroPython
mpremote mip install github:ChuMicro/ChuMicro-Bundle-Experimental/chumicro_compat

# CPython
pip install chumicro-compat-experimental

Quick example

from chumicro_compat.functools import partial

def set_led(pin: int, brightness: int) -> None:
    """Set an LED pin to a brightness level."""
    print(f"pin {pin}{brightness}%")

# Freeze the pin, vary the brightness later.
set_status_led = partial(set_led, 13)
set_status_led(50)   # pin 13 → 50%
set_status_led(100)  # pin 13 → 100%

What's included

functools

Symbol Description
partial(func, *args, **keywords) Freeze positional and keyword arguments to a callable
partial.func The original wrapped callable
partial.args Frozen positional arguments (tuple)
partial.keywords Frozen keyword arguments (dict)

Platform support

Runtime Implementation
CPython Re-exports the C-implemented functools.partial directly
MicroPython Pure-Python polyfill with __slots__
CircuitPython Pure-Python polyfill with __slots__

The public API (.func, .args, .keywords, __call__, __repr__) is identical across all runtimes.

Examples

Example What it shows
partial_basic.py Freeze one argument to a function
partial_keyword_override.py Freeze keyword args, override at call time
partial_callback.py Wire a callback with frozen context (embedded pattern)

Docs

📖 Stable docs · Experimental docs

Browse on GitHub:

Find this library

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chumicro_compat_experimental-0.1.16.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chumicro_compat_experimental-0.1.16-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file chumicro_compat_experimental-0.1.16.tar.gz.

File metadata

File hashes

Hashes for chumicro_compat_experimental-0.1.16.tar.gz
Algorithm Hash digest
SHA256 71c2e4c6f44423758b1a53f75a9942564faf4b01d735ef90eb12a6d86f787c17
MD5 20c018e1ad220c9f0b31afa01f1a953e
BLAKE2b-256 86fef0ea72a04a79d84f7ef075124858551167d9e091e080fedc5543ebe46ea2

See more details on using hashes here.

Provenance

The following attestation bundles were made for chumicro_compat_experimental-0.1.16.tar.gz:

Publisher: release.yml on ChuMicro/ChuMicro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chumicro_compat_experimental-0.1.16-py3-none-any.whl.

File metadata

File hashes

Hashes for chumicro_compat_experimental-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 856ccd35fa8162e2f1f7cd2c8247e721d4920e1a362011f9400bbaa1d7ca9585
MD5 b8ddc215634415df56510847ad9f9611
BLAKE2b-256 603fe62d7834492da75a1e68b68aa6d9a1f2826dd762b76d1e1598f63e8a5fd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for chumicro_compat_experimental-0.1.16-py3-none-any.whl:

Publisher: release.yml on ChuMicro/ChuMicro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page