loongson/pypi/: immutables-0.18 metadata and description

Homepage Simple index

Immutable Collections

author MagicStack Inc
author_email hello@magic.io
classifiers
  • License :: OSI Approved :: Apache Software License
  • Intended Audience :: Developers
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: 3.6
  • Programming Language :: Python :: 3.7
  • Programming Language :: Python :: 3.8
  • Programming Language :: Python :: 3.9
  • Programming Language :: Python :: 3.10
  • Operating System :: POSIX
  • Operating System :: MacOS :: MacOS X
  • Operating System :: Microsoft :: Windows
license Apache License, Version 2.0
platform
  • UNKNOWN
provides
  • immutables
provides_extras test
requires_dist
  • typing-extensions (>=3.7.4.3) ; python_version < "3.8"
  • flake8 (~=3.8.4) ; extra == 'test'
  • pycodestyle (~=2.6.0) ; extra == 'test'
  • mypy (==0.942) ; extra == 'test'
  • pytest (~=6.2.4) ; extra == 'test'
requires_python >=3.6

Because this project isn't in the mirror_whitelist, no releases from root/pypi are included.

File Tox results History
immutables-0.18-cp36-cp36m-linux_loongarch64.whl
Size
116 KB
Type
Python Wheel
Python
3.6
immutables-0.18-cp37-cp37m-linux_loongarch64.whl
Size
112 KB
Type
Python Wheel
Python
3.7
immutables-0.18-cp38-cp38-linux_loongarch64.whl
Size
124 KB
Type
Python Wheel
Python
3.8
  • Replaced 1 time(s)
  • Uploaded to loongson/pypi by loongson 2022-09-07 09:23:27
immutables-0.18.tar.gz
Size
82 KB
Type
Source
  • Replaced 1 time(s)
  • Uploaded to loongson/pypi by loongson 2022-09-07 09:23:32
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