Immutable Collections

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for edgedb-ci from gravatar.com edgedb-ci Avatar for Elvis.Pranskevichus from gravatar.com Elvis.Pranskevichus Avatar for magicstack-ci from gravatar.com magicstack-ci Avatar for yselivanov from gravatar.com yselivanov

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License, Version 2.0)
  • Author: MagicStack Inc
  • Tags collections, immutable, hamt
  • Requires: Python >=3.8.0
  • Provides-Extra: test
Classifiers

Project description

https://github.com/MagicStack/immutables/workflows/Tests/badge.svg?branch=master https://img.shields.io/pypi/v/immutables.svg

An immutable mapping type for Python.

The underlying datastructure is a Hash Array Mapped Trie (HAMT) used in Clojure, Scala, Haskell, and other functional languages. This implementation is used in CPython 3.7 in the contextvars module (see PEP 550 and PEP 567 for more details).

Immutable mappings based on HAMT have O(log N) performance for both set() and get() operations, which is essentially O(1) for relatively small mappings.

Below is a visualization of a simple get/set benchmark comparing HAMT to an immutable mapping implemented with a Python dict copy-on-write approach (the benchmark code is available here):

bench.png

Installation

immutables requires Python 3.6+ and is available on PyPI:

$ pip install immutables

API

immutables.Map is an unordered immutable mapping. Map objects are hashable, comparable, and pickleable.

The Map object implements the collections.abc.Mapping ABC so working with it is very similar to working with Python dicts:

import immutables

map = immutables.Map(a=1, b=2)

print(map['a'])
# will print '1'

print(map.get('z', 100))
# will print '100'

print('z' in map)
# will print 'False'

Since Maps are immutable, there is a special API for mutations that allow apply changes to the Map object and create new (derived) Maps:

map2 = map.set('a', 10)
print(map, map2)
# will print:
#   <immutables.Map({'a': 1, 'b': 2})>
#   <immutables.Map({'a': 10, 'b': 2})>

map3 = map2.delete('b')
print(map, map2, map3)
# will print:
#   <immutables.Map({'a': 1, 'b': 2})>
#   <immutables.Map({'a': 10, 'b': 2})>
#   <immutables.Map({'a': 10})>

Maps also implement APIs for bulk updates: MapMutation objects:

map_mutation = map.mutate()
map_mutation['a'] = 100
del map_mutation['b']
map_mutation.set('y', 'y')

map2 = map_mutation.finish()

print(map, map2)
# will print:
#   <immutables.Map({'a': 1, 'b': 2})>
#   <immutables.Map({'a': 100, 'y': 'y'})>

MapMutation objects are context managers. Here’s the above example rewritten in a more idiomatic way:

with map.mutate() as mm:
    mm['a'] = 100
    del mm['b']
    mm.set('y', 'y')
    map2 = mm.finish()

print(map, map2)
# will print:
#   <immutables.Map({'a': 1, 'b': 2})>
#   <immutables.Map({'a': 100, 'y': 'y'})>

Further development

  • An immutable version of Python set type with efficient add() and discard() operations.

License

Apache 2.0

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for edgedb-ci from gravatar.com edgedb-ci Avatar for Elvis.Pranskevichus from gravatar.com Elvis.Pranskevichus Avatar for magicstack-ci from gravatar.com magicstack-ci Avatar for yselivanov from gravatar.com yselivanov

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License, Version 2.0)
  • Author: MagicStack Inc
  • Tags collections, immutable, hamt
  • Requires: Python >=3.8.0
  • Provides-Extra: test
Classifiers

Release history Release notifications | RSS feed

This version

0.21

0.20

0.19

0.18

0.17

0.16

0.15

0.14

0.13

0.12

0.11

0.10

0.9

0.8

0.7

0.6

0.5

0.4

0.3

0.2

0.1

Download files

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

Source Distribution

immutables-0.21.tar.gz (89.0 kB view hashes)

Uploaded Source

Built Distributions

immutables-0.21-cp313-cp313-win_amd64.whl (35.1 kB view hashes)

Uploaded CPython 3.13 Windows x86-64

immutables-0.21-cp313-cp313-win32.whl (31.0 kB view hashes)

Uploaded CPython 3.13 Windows x86

immutables-0.21-cp313-cp313-musllinux_1_2_x86_64.whl (101.8 kB view hashes)

Uploaded CPython 3.13 musllinux: musl 1.2+ x86-64

immutables-0.21-cp313-cp313-musllinux_1_2_aarch64.whl (100.0 kB view hashes)

Uploaded CPython 3.13 musllinux: musl 1.2+ ARM64

immutables-0.21-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (104.3 kB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (104.9 kB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp313-cp313-macosx_11_0_arm64.whl (31.6 kB view hashes)

Uploaded CPython 3.13 macOS 11.0+ ARM64

immutables-0.21-cp313-cp313-macosx_10_13_x86_64.whl (31.9 kB view hashes)

Uploaded CPython 3.13 macOS 10.13+ x86-64

immutables-0.21-cp312-cp312-win_amd64.whl (35.1 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

immutables-0.21-cp312-cp312-win32.whl (31.0 kB view hashes)

Uploaded CPython 3.12 Windows x86

immutables-0.21-cp312-cp312-musllinux_1_2_x86_64.whl (101.7 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.2+ x86-64

immutables-0.21-cp312-cp312-musllinux_1_2_aarch64.whl (99.7 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.2+ ARM64

immutables-0.21-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (104.3 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (104.9 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp312-cp312-macosx_11_0_arm64.whl (31.5 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

immutables-0.21-cp312-cp312-macosx_10_13_x86_64.whl (31.9 kB view hashes)

Uploaded CPython 3.12 macOS 10.13+ x86-64

immutables-0.21-cp311-cp311-win_amd64.whl (34.4 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

immutables-0.21-cp311-cp311-win32.whl (30.5 kB view hashes)

Uploaded CPython 3.11 Windows x86

immutables-0.21-cp311-cp311-musllinux_1_2_x86_64.whl (97.9 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.2+ x86-64

immutables-0.21-cp311-cp311-musllinux_1_2_aarch64.whl (97.5 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.2+ ARM64

immutables-0.21-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (99.3 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (99.5 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp311-cp311-macosx_11_0_arm64.whl (31.1 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

immutables-0.21-cp311-cp311-macosx_10_9_x86_64.whl (31.2 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

immutables-0.21-cp310-cp310-win_amd64.whl (33.8 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

immutables-0.21-cp310-cp310-win32.whl (30.5 kB view hashes)

Uploaded CPython 3.10 Windows x86

immutables-0.21-cp310-cp310-musllinux_1_2_x86_64.whl (95.3 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.2+ x86-64

immutables-0.21-cp310-cp310-musllinux_1_2_aarch64.whl (95.2 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.2+ ARM64

immutables-0.21-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (96.5 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (96.8 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp310-cp310-macosx_11_0_arm64.whl (31.1 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

immutables-0.21-cp310-cp310-macosx_10_9_x86_64.whl (31.2 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

immutables-0.21-cp39-cp39-win_amd64.whl (33.9 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

immutables-0.21-cp39-cp39-win32.whl (30.5 kB view hashes)

Uploaded CPython 3.9 Windows x86

immutables-0.21-cp39-cp39-musllinux_1_2_x86_64.whl (94.8 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.2+ x86-64

immutables-0.21-cp39-cp39-musllinux_1_2_aarch64.whl (94.8 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.2+ ARM64

immutables-0.21-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (96.0 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (96.2 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp39-cp39-macosx_11_0_arm64.whl (31.0 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

immutables-0.21-cp39-cp39-macosx_10_9_x86_64.whl (31.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

immutables-0.21-cp38-cp38-win_amd64.whl (33.9 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

immutables-0.21-cp38-cp38-win32.whl (30.6 kB view hashes)

Uploaded CPython 3.8 Windows x86

immutables-0.21-cp38-cp38-musllinux_1_2_x86_64.whl (97.9 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.2+ x86-64

immutables-0.21-cp38-cp38-musllinux_1_2_aarch64.whl (98.4 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.2+ ARM64

immutables-0.21-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (100.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

immutables-0.21-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (100.5 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

immutables-0.21-cp38-cp38-macosx_11_0_arm64.whl (31.1 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

immutables-0.21-cp38-cp38-macosx_10_9_x86_64.whl (31.3 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

Supported by

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