listcrunch

library1.0.1pypypi✓ verified 85d ago

listcrunch is a Python utility library (current version 1.0.1) that provides a simple, human-readable way to compress redundant sequential data within lists into a string format, and to decompress it back. It is a stable, focused library with no active new feature development since its last release in 2020.

serialization data

pip install listcrunch

github ↗package ↗

INSTALL

IMPORT

SIG · LISTCRUNCH

listcrunch

serializationpythonv1.0.1

Install

1.5s avg

Import

—

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.000s · 17.8MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 1.5s · import 0.000s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

crunch

✓ from listcrunch import crunch

uncrunch

✓ from listcrunch import uncrunch

This quickstart demonstrates how to use the `crunch` function to compress a list of sequential, redundant data into a human-readable string format, and then use the `uncrunch` function to restore the original list. The output format `VALUE:START-END;...` indicates that 'VALUE' appears from 'START' index to 'END' index (inclusive) in the original list.

from listcrunch import crunch, uncrunch # Example data data = [1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 3, 3, 3, 1] # Compress the data compressed_string = crunch(data) print(f"Original: {data}") print(f"Compressed: {compressed_string}") # Expected output: Original: [1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 3, 3, 3, 1] # Expected output: Compressed: 1:0-8;2:9-10;3:11-13;1:14 # Uncompress the data decompressed_list = uncrunch(compressed_string) print(f"Decompressed: {decompressed_list}") # Expected output: Decompressed: [1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 3, 3, 3, 1] # Verify round trip assert data == decompressed_list

Debug

Known issues

gotchaThe `crunch` function is designed for lists of hashable items where sequential redundancy is meaningful. Providing non-list iterables or complex, unhashable objects might lead to unexpected behavior or errors (e.g., `TypeError` for unhashable types if the internal mechanism attempts hashing).

fix

Ensure input to `crunch` is a list of hashable elements where sequential compression makes sense. For lists of unhashable objects, you might need to process them into a hashable representation first.

affects: All versions

gotchaWhile the compressed string format (e.g., `1:0-8;2:9`) is human-readable, directly parsing this string format in your application logic, rather than using the `uncrunch` function, can lead to brittle code. Future (though unlikely) changes to the internal string representation could break such custom parsers.

fix

Always use the `uncrunch` function for decompression to ensure forward compatibility and robust parsing of the compressed format.

affects: All versions

gotchaThe library was last updated and tested against Python 3.7.6. While it is `py3-none-any` (Python 3 compatible), very old Python 3 versions (e.g., <3.6) or potential future major Python releases might introduce subtle incompatibilities. No known issues currently exist.

fix

If encountering unexpected behavior with very old or new Python versions, test within a Python 3.7+ environment. Report any compatibility issues to the library's GitHub repository.

affects: <1.0.1

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'listcrunch'

The `listcrunch` library has not been installed in your current Python environment.

fix

Run `pip install listcrunch` in your terminal to install the library.

TypeError: 'str' object is not callable (when calling crunch or uncrunch)

This usually happens if you've accidentally defined a local variable named `crunch` or `uncrunch` that overwrites the imported function, or if you tried `import listcrunch` and then called `listcrunch.crunch()` directly, which is incorrect as `crunch` is directly imported from the module.

fix

Ensure you are importing the functions correctly using `from listcrunch import crunch, uncrunch` and that no other variables in your scope share these names.

ValueError: Invalid compressed string format (when calling uncrunch)

The string provided to the `uncrunch` function does not conform to the expected `VALUE:START-END;...` format generated by `listcrunch`.

fix

Verify that the string passed to `uncrunch` was either originally produced by the `crunch` function or meticulously follows its specified format.

Upgrade

Version history

1.0.1latest on PyPI · released Jun 15, 2020

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/MuckRock/listcrunch ↗

packagehttps://pypi.org/project/listcrunch/ ↗