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

Navigation

Verified details

These details have been verified by PyPI
Owner
organization icon aio-libs
Maintainers
Avatar for Andrew.Svetlov from gravatar.com Andrew.Svetlov Avatar for mj from gravatar.com mj Avatar for webknjaz from gravatar.com webknjaz

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

frozenlist

GitHub status for master branch codecov.io status for master branch frozenlist @ PyPI Read The Docs build status badge Matrix Room — #aio-libs:matrix.org Matrix Space — #aio-libs-space:matrix.org

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.8 or newer.

Documentation

https://frozenlist.aio-libs.org

Communication channels

We have a Matrix Space #aio-libs-space:matrix.org which is also accessible via Gitter.

Requirements

  • Python >= 3.8

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.

Changelog

1.4.1 (2023-12-15)

Packaging updates and notes for downstreams

  • Declared Python 3.12 and PyPy 3.8-3.10 supported officially in the distribution package metadata.

    Related issues and pull requests on GitHub: #553.

  • Replaced the packaging is replaced from an old-fashioned setup.py to an in-tree PEP 517 build backend – by @webknjaz.

    Whenever the end-users or downstream packagers need to build frozenlist from source (a Git checkout or an sdist), they may pass a config_settings flag pure-python. If this flag is not set, a C-extension will be built and included into the distribution.

    Here is how this can be done with pip:

    $ python3 -m pip install . --config-settings=pure-python=

    This will also work with -e | --editable.

    The same can be achieved via pypa/build:

    $ python3 -m build --config-setting=pure-python=

    Adding -w | --wheel can force pypa/build produce a wheel from source directly, as opposed to building an sdist and then building from it.

    Related issues and pull requests on GitHub: #560.

Contributor-facing changes

  • It is now possible to request line tracing in Cython builds using the with-cython-tracing PEP 517 config setting – @webknjaz.

    This can be used in CI and development environment to measure coverage on Cython modules, but is not normally useful to the end-users or downstream packagers.

    Here’s a usage example:

    $ python3 -Im pip install . --config-settings=with-cython-tracing=true

    For editable installs, this setting is on by default. Otherwise, it’s off unless requested explicitly.

    The following produces C-files required for the Cython coverage plugin to map the measurements back to the PYX-files:

    $ python -Im pip install -e .

    Alternatively, the FROZENLIST_CYTHON_TRACING=1 environment variable can be set to do the same as the PEP 517 config setting.

    Related issues and pull requests on GitHub: #560.

  • Coverage collection has been implemented for the Cython modules – by @webknjaz.

    It will also be reported to Codecov from any non-release CI jobs.

    Related issues and pull requests on GitHub: #561.

  • A step-by-step Release Guide guide has been added, describing how to release frozenlist – by @webknjaz.

    This is primarily targeting the maintainers.

    Related issues and pull requests on GitHub: #563.

  • Detailed Contributing Guidelines on authoring the changelog fragments have been published in the documentation – by @webknjaz.

    Related issues and pull requests on GitHub: #564.

1.4.0 (2023-07-12)

The published source distribution package became buildable under Python 3.12.

Bugfixes

  • Removed an unused typing.Tuple import #411

Deprecations and Removals

  • Dropped Python 3.7 support. #413

Misc

1.3.3 (2022-11-08)

  • Fixed CI runs when creating a new release, where new towncrier versions fail when the current version section is already present.

1.3.2 (2022-11-08)

Misc

  • Updated the CI runs to better check for test results and to avoid deprecated syntax. #327

1.3.1 (2022-08-02)

The published source distribution package became buildable under Python 3.11.

1.3.0 (2022-01-18)

Bugfixes

  • Do not install C sources with binary distributions. #250

Deprecations and Removals

  • Dropped Python 3.6 support #274

1.2.0 (2021-10-16)

Features

  • FrozenList now supports being used as a generic type as per PEP 585, e.g. frozen_int_list: FrozenList[int] (requires Python 3.9 or newer). #172

  • Added support for Python 3.10. #227

  • Started shipping platform-specific wheels with the musl tag targeting typical Alpine Linux runtimes. #227

  • Started shipping platform-specific arm64 wheels for Apple Silicon. #227

1.1.1 (2020-11-14)

Bugfixes

  • Provide x86 Windows wheels. #169

1.1.0 (2020-10-13)

Features

  • Add support for hashing of a frozen list. #136

  • 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. #24

Project details

Verified details

These details have been verified by PyPI
Owner
organization icon aio-libs
Maintainers
Avatar for Andrew.Svetlov from gravatar.com Andrew.Svetlov Avatar for mj from gravatar.com mj Avatar for webknjaz from gravatar.com webknjaz

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.5.0

This version

1.4.1

1.4.0

1.3.3

1.3.1

1.3.0

1.3.0a0 pre-release

1.2.0

1.2.0a8 pre-release

1.1.1

1.1.0

1.0.0

1.0.0a0 pre-release

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.4.1.tar.gz (37.8 kB view hashes)

Uploaded Source

Built Distributions

frozenlist-1.4.1-py3-none-any.whl (11.6 kB view hashes)

Uploaded Python 3

frozenlist-1.4.1-cp312-cp312-win_amd64.whl (50.5 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

frozenlist-1.4.1-cp312-cp312-win32.whl (44.1 kB view hashes)

Uploaded CPython 3.12 Windows x86

frozenlist-1.4.1-cp312-cp312-musllinux_1_1_x86_64.whl (282.6 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ x86-64

frozenlist-1.4.1-cp312-cp312-musllinux_1_1_s390x.whl (290.8 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ s390x

frozenlist-1.4.1-cp312-cp312-musllinux_1_1_ppc64le.whl (286.9 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ ppc64le

frozenlist-1.4.1-cp312-cp312-musllinux_1_1_i686.whl (268.1 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ i686

frozenlist-1.4.1-cp312-cp312-musllinux_1_1_aarch64.whl (281.3 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ ARM64

frozenlist-1.4.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl (289.4 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ s390x

frozenlist-1.4.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (286.7 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ppc64le

frozenlist-1.4.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (280.7 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARM64

frozenlist-1.4.1-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (281.5 kB view hashes)

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

frozenlist-1.4.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (265.5 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

frozenlist-1.4.1-cp312-cp312-macosx_11_0_arm64.whl (51.9 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

frozenlist-1.4.1-cp312-cp312-macosx_10_9_x86_64.whl (53.7 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

frozenlist-1.4.1-cp312-cp312-macosx_10_9_universal2.whl (93.9 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ universal2 (ARM64, x86-64)

frozenlist-1.4.1-cp311-cp311-win_amd64.whl (50.5 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

frozenlist-1.4.1-cp311-cp311-win32.whl (44.4 kB view hashes)

Uploaded CPython 3.11 Windows x86

frozenlist-1.4.1-cp311-cp311-musllinux_1_1_x86_64.whl (272.3 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

frozenlist-1.4.1-cp311-cp311-musllinux_1_1_s390x.whl (281.5 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ s390x

frozenlist-1.4.1-cp311-cp311-musllinux_1_1_ppc64le.whl (282.3 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ ppc64le

frozenlist-1.4.1-cp311-cp311-musllinux_1_1_i686.whl (260.9 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ i686

frozenlist-1.4.1-cp311-cp311-musllinux_1_1_aarch64.whl (272.4 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ ARM64

frozenlist-1.4.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl (280.3 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ s390x

frozenlist-1.4.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (284.7 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ppc64le

frozenlist-1.4.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (273.3 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

frozenlist-1.4.1-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (272.3 kB view hashes)

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

frozenlist-1.4.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (258.8 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

frozenlist-1.4.1-cp311-cp311-macosx_11_0_arm64.whl (53.4 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

frozenlist-1.4.1-cp311-cp311-macosx_10_9_x86_64.whl (55.3 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

frozenlist-1.4.1-cp311-cp311-macosx_10_9_universal2.whl (97.1 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ universal2 (ARM64, x86-64)

frozenlist-1.4.1-cp310-cp310-win_amd64.whl (50.4 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

frozenlist-1.4.1-cp310-cp310-win32.whl (44.6 kB view hashes)

Uploaded CPython 3.10 Windows x86

frozenlist-1.4.1-cp310-cp310-musllinux_1_1_x86_64.whl (254.0 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

frozenlist-1.4.1-cp310-cp310-musllinux_1_1_s390x.whl (264.4 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ s390x

frozenlist-1.4.1-cp310-cp310-musllinux_1_1_ppc64le.whl (263.8 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ ppc64le

frozenlist-1.4.1-cp310-cp310-musllinux_1_1_i686.whl (245.9 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ i686

frozenlist-1.4.1-cp310-cp310-musllinux_1_1_aarch64.whl (253.4 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ ARM64

frozenlist-1.4.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl (258.9 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ s390x

frozenlist-1.4.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (262.4 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ppc64le

frozenlist-1.4.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (238.6 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

frozenlist-1.4.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (239.5 kB view hashes)

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

frozenlist-1.4.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (229.4 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

frozenlist-1.4.1-cp310-cp310-macosx_11_0_arm64.whl (52.2 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

frozenlist-1.4.1-cp310-cp310-macosx_10_9_x86_64.whl (53.8 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

frozenlist-1.4.1-cp310-cp310-macosx_10_9_universal2.whl (94.3 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64)

frozenlist-1.4.1-cp39-cp39-win_amd64.whl (50.7 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

frozenlist-1.4.1-cp39-cp39-win32.whl (44.8 kB view hashes)

Uploaded CPython 3.9 Windows x86

frozenlist-1.4.1-cp39-cp39-musllinux_1_1_x86_64.whl (256.7 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ x86-64

frozenlist-1.4.1-cp39-cp39-musllinux_1_1_s390x.whl (266.4 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ s390x

frozenlist-1.4.1-cp39-cp39-musllinux_1_1_ppc64le.whl (266.9 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ ppc64le

frozenlist-1.4.1-cp39-cp39-musllinux_1_1_i686.whl (247.6 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ i686

frozenlist-1.4.1-cp39-cp39-musllinux_1_1_aarch64.whl (255.7 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ ARM64

frozenlist-1.4.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl (261.3 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ s390x

frozenlist-1.4.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (265.6 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ppc64le

frozenlist-1.4.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (239.4 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

frozenlist-1.4.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (240.7 kB view hashes)

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

frozenlist-1.4.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (230.8 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

frozenlist-1.4.1-cp39-cp39-macosx_11_0_arm64.whl (53.7 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

frozenlist-1.4.1-cp39-cp39-macosx_10_9_x86_64.whl (55.2 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

frozenlist-1.4.1-cp39-cp39-macosx_10_9_universal2.whl (97.3 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ universal2 (ARM64, x86-64)

frozenlist-1.4.1-cp38-cp38-win_amd64.whl (50.8 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

frozenlist-1.4.1-cp38-cp38-win32.whl (44.8 kB view hashes)

Uploaded CPython 3.8 Windows x86

frozenlist-1.4.1-cp38-cp38-musllinux_1_1_x86_64.whl (248.0 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ x86-64

frozenlist-1.4.1-cp38-cp38-musllinux_1_1_s390x.whl (255.6 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ s390x

frozenlist-1.4.1-cp38-cp38-musllinux_1_1_ppc64le.whl (257.4 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ ppc64le

frozenlist-1.4.1-cp38-cp38-musllinux_1_1_i686.whl (239.7 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ i686

frozenlist-1.4.1-cp38-cp38-musllinux_1_1_aarch64.whl (246.9 kB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ ARM64

frozenlist-1.4.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl (252.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ s390x

frozenlist-1.4.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (257.0 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ppc64le

frozenlist-1.4.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (239.5 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

frozenlist-1.4.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (240.9 kB view hashes)

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

frozenlist-1.4.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl (231.4 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686 manylinux: glibc 2.5+ i686

frozenlist-1.4.1-cp38-cp38-macosx_11_0_arm64.whl (53.8 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

frozenlist-1.4.1-cp38-cp38-macosx_10_9_x86_64.whl (55.2 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

frozenlist-1.4.1-cp38-cp38-macosx_10_9_universal2.whl (97.4 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ universal2 (ARM64, 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