Skip to main content

A list-like structure which implements collections.abc.MutableSequence

Project description

GitHub status for master branch codecov.io status for master branch Latest PyPI package version Latest Read The Docs Discourse group for io-libs Chat on Gitter

Introduction

frozenlist.FrozenList is a list-like structure which implements collections.abc.MutableSequence. The list is mutable until FrozenList.freeze is called, after which list modifications raise RuntimeError:

>>> from frozenlist import FrozenList
>>> fl = FrozenList([17, 42])
>>> fl.append('spam')
>>> fl.append('Vikings')
>>> fl
<FrozenList(frozen=False, [17, 42, 'spam', 'Vikings'])>
>>> fl.freeze()
>>> fl
<FrozenList(frozen=True, [17, 42, 'spam', 'Vikings'])>
>>> fl.frozen
True
>>> fl.append("Monty")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "frozenlist/_frozenlist.pyx", line 97, in frozenlist._frozenlist.FrozenList.append
    self._check_frozen()
  File "frozenlist/_frozenlist.pyx", line 19, in frozenlist._frozenlist.FrozenList._check_frozen
    raise RuntimeError("Cannot modify frozen list.")
RuntimeError: Cannot modify frozen list.

FrozenList is also hashable, but only when frozen. Otherwise it also throws a RuntimeError:

>>> fl = FrozenList([17, 42, 'spam'])
>>> hash(fl)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "frozenlist/_frozenlist.pyx", line 111, in frozenlist._frozenlist.FrozenList.__hash__
    raise RuntimeError("Cannot hash unfrozen list.")
RuntimeError: Cannot hash unfrozen list.
>>> fl.freeze()
>>> hash(fl)
3713081631934410656
>>> dictionary = {fl: 'Vikings'} # frozen fl can be a dict key
>>> dictionary
{<FrozenList(frozen=True, [1, 2])>: 'Vikings'}

Installation

$ pip install frozenlist

The library requires Python 3.6 or newer.

Documentation

https://frozenlist.readthedocs.io/

Communication channels

aio-libs discourse group: https://aio-libs.discourse.group

Feel free to post your questions and ideas here.

gitter chat https://gitter.im/aio-libs/Lobby

Requirements

  • Python >= 3.6

License

frozenlist is offered under the Apache 2 license.

Source code

The project is hosted on GitHub

Please file an issue in the bug tracker if you have found a bug or have some suggestions to improve the library.

Download files

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

Source Distribution

frozenlist-1.3.3.tar.gz (66.6 kB view hashes)

Uploaded source

Built Distributions

frozenlist-1.3.3-cp311-cp311-win_amd64.whl (32.6 kB view hashes)

Uploaded cp311

frozenlist-1.3.3-cp311-cp311-win32.whl (30.4 kB view hashes)

Uploaded cp311

frozenlist-1.3.3-cp310-cp310-win_amd64.whl (33.3 kB view hashes)

Uploaded cp310

frozenlist-1.3.3-cp310-cp310-win32.whl (30.6 kB view hashes)

Uploaded cp310

frozenlist-1.3.3-cp39-cp39-win_amd64.whl (34.2 kB view hashes)

Uploaded cp39

frozenlist-1.3.3-cp39-cp39-win32.whl (31.2 kB view hashes)

Uploaded cp39

frozenlist-1.3.3-cp38-cp38-win_amd64.whl (34.2 kB view hashes)

Uploaded cp38

frozenlist-1.3.3-cp38-cp38-win32.whl (31.3 kB view hashes)

Uploaded cp38

frozenlist-1.3.3-cp37-cp37m-win_amd64.whl (34.1 kB view hashes)

Uploaded cp37

frozenlist-1.3.3-cp37-cp37m-win32.whl (31.1 kB view hashes)

Uploaded cp37

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page