{"author":null,"author_email":"MagicStack Inc ","bugtrack_url":null,"classifiers":["Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Topic :: Software Development :: Libraries"],"description":"immutables\n==========\n\n.. image:: https://github.com/MagicStack/immutables/workflows/Tests/badge.svg?branch=master\n :target: https://github.com/MagicStack/immutables/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush\n\n.. image:: https://img.shields.io/pypi/v/immutables.svg\n :target: https://pypi.python.org/pypi/immutables\n\nAn immutable mapping type for Python.\n\nThe underlying datastructure is a Hash Array Mapped Trie (HAMT)\nused in Clojure, Scala, Haskell, and other functional languages.\nThis implementation is used in CPython 3.7 in the ``contextvars``\nmodule (see `PEP 550 `_ and\n`PEP 567 `_ for more details).\n\nImmutable mappings based on HAMT have O(log N) performance for both\n``set()`` and ``get()`` operations, which is essentially O(1) for\nrelatively small mappings.\n\nBelow is a visualization of a simple get/set benchmark comparing\nHAMT to an immutable mapping implemented with a Python dict\ncopy-on-write approach (the benchmark code is available\n`here `_):\n\n.. image:: bench.png\n\n\nInstallation\n------------\n\n``immutables`` requires Python 3.6+ and is available on PyPI::\n\n $ pip install immutables\n\n\nAPI\n---\n\n``immutables.Map`` is an unordered immutable mapping. ``Map`` objects\nare hashable, comparable, and pickleable.\n\nThe ``Map`` object implements the ``collections.abc.Mapping`` ABC\nso working with it is very similar to working with Python dicts:\n\n.. code-block:: python\n\n import immutables\n\n map = immutables.Map(a=1, b=2)\n\n print(map['a'])\n # will print '1'\n\n print(map.get('z', 100))\n # will print '100'\n\n print('z' in map)\n # will print 'False'\n\nSince Maps are immutable, there is a special API for mutations that\nallow apply changes to the Map object and create new (derived) Maps:\n\n.. code-block:: python\n\n map2 = map.set('a', 10)\n print(map, map2)\n # will print:\n # \n # \n\n map3 = map2.delete('b')\n print(map, map2, map3)\n # will print:\n # \n # \n # \n\nMaps also implement APIs for bulk updates: ``MapMutation`` objects:\n\n.. code-block:: python\n\n map_mutation = map.mutate()\n map_mutation['a'] = 100\n del map_mutation['b']\n map_mutation.set('y', 'y')\n\n map2 = map_mutation.finish()\n\n print(map, map2)\n # will print:\n # \n # \n\n``MapMutation`` objects are context managers. Here's the above example\nrewritten in a more idiomatic way:\n\n.. code-block:: python\n\n with map.mutate() as mm:\n mm['a'] = 100\n del mm['b']\n mm.set('y', 'y')\n map2 = mm.finish()\n\n print(map, map2)\n # will print:\n # \n # \n\n\nFurther development\n-------------------\n\n* An immutable version of Python ``set`` type with efficient\n ``add()`` and ``discard()`` operations.\n\n\nLicense\n-------\n\nApache 2.0\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"collections, immutable, hamt","license":"Apache License, Version 2.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"immutables","package_url":"https://pypi.org/project/immutables/","platform":null,"project_url":"https://pypi.org/project/immutables/","project_urls":{"github":"https://github.com/MagicStack/immutables"},"provides_extra":["test"],"release_url":"https://pypi.org/project/immutables/0.21/","requires_dist":["flake8~=5.0; extra == \"test\"","pycodestyle~=2.9; extra == \"test\"","mypy~=1.4; extra == \"test\"","pytest~=7.4; extra == \"test\""],"requires_python":">=3.8.0","summary":"Immutable Collections","version":"0.21","yanked":false,"yanked_reason":null}

Dependencies of immutables (4).
Dependency	Optional
flake8	true
mypy	true
pycodestyle	true
pytest	true

Package search

immutables

project_urls

Dependencies

All package metadata

Releases