Source code
Revision control
Copy as Markdown
Other Tools
Metadata-Version: 2.1
Name: frozenlist
Version: 1.1.1
Summary: A list-like structure which implements collections.abc.MutableSequence
Author: Nikolay Kim
Author-email: fafhrd91@gmail.com
Maintainer: Martijn Pieters <mj@zopatista.com>
Maintainer-email: aio-libs@googlegroups.com
License: Apache 2
Description: ==========
frozenlist
==========
:alt: GitHub status for master branch
:alt: codecov.io status for master branch
:alt: Latest PyPI package version
:alt: Latest Read The Docs
:alt: Discourse group for io-libs
:alt: 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
=============
Communication channels
======================
Feel free to post your questions and ideas here.
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
or have some suggestions to improve the library.
=========
Changelog
=========
..
You should *NOT* be adding new change log entries to this file, this
file is managed by towncrier. You *may* edit previous change logs to
fix problems like typo corrections or such.
To add a new change log entry, please see
we named the news folder "changes".
WARNING: Don't drop the next directive!
.. towncrier release notes start
1.1.1 (2020-11-14)
==================
Bugfixes
--------
- Provide x86 Windows wheels.
----
1.1.0 (2020-10-13)
==================
Features
--------
- Add support for hashing of a frozen list.
- Support Python 3.8 and 3.9.
- Provide wheels for ``aarch64``, ``i686``, ``ppc64le``, ``s390x`` architectures on
Linux as well as ``x86_64``.
----
1.0.0 (2019-11-09)
==================
Deprecations and Removals
-------------------------
- Dropped support for Python 3.5; only 3.6, 3.7 and 3.8 are supported going forward.
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.6
Description-Content-Type: text/x-rst