{"author":null,"author_email":null,"bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Programming Language :: Cython","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy"],"description":"frozenlist\n==========\n\n.. image:: https://github.com/aio-libs/frozenlist/workflows/CI/badge.svg\n :target: https://github.com/aio-libs/frozenlist/actions\n :alt: GitHub status for master branch\n\n.. image:: https://codecov.io/gh/aio-libs/frozenlist/branch/master/graph/badge.svg?flag=pytest\n :target: https://codecov.io/gh/aio-libs/frozenlist?flags[]=pytest\n :alt: codecov.io status for master branch\n\n.. image:: https://img.shields.io/pypi/v/frozenlist.svg?logo=Python&logoColor=white\n :target: https://pypi.org/project/frozenlist\n :alt: frozenlist @ PyPI\n\n.. image:: https://readthedocs.org/projects/frozenlist/badge/?version=latest\n :target: https://frozenlist.aio-libs.org\n :alt: Read The Docs build status badge\n\n.. image:: https://img.shields.io/matrix/aio-libs:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat\n :target: https://matrix.to/#/%23aio-libs:matrix.org\n :alt: Matrix Room — #aio-libs:matrix.org\n\n.. image:: https://img.shields.io/matrix/aio-libs-space:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs-space%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat\n :target: https://matrix.to/#/%23aio-libs-space:matrix.org\n :alt: Matrix Space — #aio-libs-space:matrix.org\n\nIntroduction\n------------\n\n``frozenlist.FrozenList`` is a list-like structure which implements\n``collections.abc.MutableSequence``. The list is *mutable* until ``FrozenList.freeze``\nis called, after which list modifications raise ``RuntimeError``:\n\n\n>>> from frozenlist import FrozenList\n>>> fl = FrozenList([17, 42])\n>>> fl.append('spam')\n>>> fl.append('Vikings')\n>>> fl\n\n>>> fl.freeze()\n>>> fl\n\n>>> fl.frozen\nTrue\n>>> fl.append(\"Monty\")\nTraceback (most recent call last):\n File \"\", line 1, in \n File \"frozenlist/_frozenlist.pyx\", line 97, in frozenlist._frozenlist.FrozenList.append\n self._check_frozen()\n File \"frozenlist/_frozenlist.pyx\", line 19, in frozenlist._frozenlist.FrozenList._check_frozen\n raise RuntimeError(\"Cannot modify frozen list.\")\nRuntimeError: Cannot modify frozen list.\n\n\nFrozenList is also hashable, but only when frozen. Otherwise it also throws a RuntimeError:\n\n\n>>> fl = FrozenList([17, 42, 'spam'])\n>>> hash(fl)\nTraceback (most recent call last):\n File \"\", line 1, in \n File \"frozenlist/_frozenlist.pyx\", line 111, in frozenlist._frozenlist.FrozenList.__hash__\n raise RuntimeError(\"Cannot hash unfrozen list.\")\nRuntimeError: Cannot hash unfrozen list.\n>>> fl.freeze()\n>>> hash(fl)\n3713081631934410656\n>>> dictionary = {fl: 'Vikings'} # frozen fl can be a dict key\n>>> dictionary\n{: 'Vikings'}\n\n\nInstallation\n------------\n\n::\n\n $ pip install frozenlist\n\n\nDocumentation\n-------------\n\nhttps://frozenlist.aio-libs.org\n\nCommunication channels\n----------------------\n\nWe have a *Matrix Space* `#aio-libs-space:matrix.org\n`_ which is\nalso accessible via Gitter.\n\nLicense\n-------\n\n``frozenlist`` is offered under the Apache 2 license.\n\nSource code\n-----------\n\nThe project is hosted on GitHub_\n\nPlease file an issue in the `bug tracker\n`_ if you have found a bug\nor have some suggestions to improve the library.\n\n.. _GitHub: https://github.com/aio-libs/frozenlist\n\n=========\nChangelog\n=========\n\n..\n You should *NOT* be adding new change log entries to this file, this\n file is managed by towncrier. You *may* edit previous change logs to\n fix problems like typo corrections or such.\n To add a new change log entry, please see\n https://pip.pypa.io/en/latest/development/contributing/#news-entries\n we named the news folder \"changes\".\n\n WARNING: Don't drop the next directive!\n\n.. towncrier release notes start\n\nv1.6.0\n======\n\n*(2025-04-17)*\n\n\nBug fixes\n---------\n\n- Stopped implicitly allowing the use of Cython pre-release versions when\n building the distribution package -- by `@ajsanchezsanz `__ and\n `@markgreene74 `__.\n\n *Related commits on GitHub:*\n `41591f2 `__.\n\n\nFeatures\n--------\n\n- Implemented support for the free-threaded build of CPython 3.13 -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#618 `__.\n\n- Started building armv7l wheels -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#642 `__.\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Stopped implicitly allowing the use of Cython pre-release versions when\n building the distribution package -- by `@ajsanchezsanz `__ and\n `@markgreene74 `__.\n\n *Related commits on GitHub:*\n `41591f2 `__.\n\n- Started building wheels for the free-threaded build of CPython 3.13 -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#618 `__.\n\n- The packaging metadata switched to including an SPDX license identifier introduced in `PEP 639 `__ -- by `@cdce8p `__.\n\n *Related issues and pull requests on GitHub:*\n `#639 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- GitHub Actions CI/CD is now configured to manage caching pip-ecosystem\n dependencies using `re-actors/cache-python-deps`_ -- an action by\n `@webknjaz `__ that takes into account ABI stability and the exact\n version of Python runtime.\n\n .. _`re-actors/cache-python-deps`:\n https://github.com/marketplace/actions/cache-python-deps\n\n *Related issues and pull requests on GitHub:*\n `#633 `__.\n\n- Organized dependencies into test and lint dependencies so that no\n unnecessary ones are installed during CI runs -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#636 `__.\n\n\n----\n\n\n1.5.0 (2024-10-22)\n==================\n\nBug fixes\n---------\n\n- An incorrect signature of the ``__class_getitem__`` class method\n has been fixed, adding a missing ``class_item`` argument under\n Python 3.8 and older.\n\n This change also improves the code coverage of this method that\n was previously missing -- by `@webknjaz `__.\n\n\n *Related issues and pull requests on GitHub:*\n `#567 `__, `#571 `__.\n\n\nImproved documentation\n----------------------\n\n- Rendered issue, PR, and commit links now lead to\n ``frozenlist``'s repo instead of ``yarl``'s repo.\n\n\n *Related issues and pull requests on GitHub:*\n `#573 `__.\n\n- On the ``Contributing docs`` page,\n a link to the ``Towncrier philosophy`` has been fixed.\n\n\n *Related issues and pull requests on GitHub:*\n `#574 `__.\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- A name of a temporary building directory now reflects\n that it's related to ``frozenlist``, not ``yarl``.\n\n\n *Related issues and pull requests on GitHub:*\n `#573 `__.\n\n- Declared Python 3.13 supported officially in the distribution package metadata.\n\n\n *Related issues and pull requests on GitHub:*\n `#595 `__.\n\n\n----\n\n\n1.4.1 (2023-12-15)\n==================\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Declared Python 3.12 and PyPy 3.8-3.10 supported officially\n in the distribution package metadata.\n\n\n *Related issues and pull requests on GitHub:*\n `#553 `__.\n\n- Replaced the packaging is replaced from an old-fashioned ``setup.py`` to an\n in-tree `PEP 517 `__ build backend -- by `@webknjaz `__.\n\n Whenever the end-users or downstream packagers need to build ``frozenlist``\n from source (a Git checkout or an sdist), they may pass a ``config_settings``\n flag ``pure-python``. If this flag is not set, a C-extension will be built\n and included into the distribution.\n\n Here is how this can be done with ``pip``:\n\n .. code-block:: console\n\n $ python3 -m pip install . --config-settings=pure-python=\n\n This will also work with ``-e | --editable``.\n\n The same can be achieved via ``pypa/build``:\n\n .. code-block:: console\n\n $ python3 -m build --config-setting=pure-python=\n\n Adding ``-w | --wheel`` can force ``pypa/build`` produce a wheel from source\n directly, as opposed to building an ``sdist`` and then building from it.\n\n\n *Related issues and pull requests on GitHub:*\n `#560 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- It is now possible to request line tracing in Cython builds using the\n ``with-cython-tracing`` `PEP 517 `__ config setting\n -- `@webknjaz `__.\n\n This can be used in CI and development environment to measure coverage\n on Cython modules, but is not normally useful to the end-users or\n downstream packagers.\n\n Here's a usage example:\n\n .. code-block:: console\n\n $ python3 -Im pip install . --config-settings=with-cython-tracing=true\n\n For editable installs, this setting is on by default. Otherwise, it's\n off unless requested explicitly.\n\n The following produces C-files required for the Cython coverage\n plugin to map the measurements back to the PYX-files:\n\n .. code-block:: console\n\n $ python -Im pip install -e .\n\n Alternatively, the ``FROZENLIST_CYTHON_TRACING=1`` environment variable\n can be set to do the same as the `PEP 517 `__ config setting.\n\n\n *Related issues and pull requests on GitHub:*\n `#560 `__.\n\n- Coverage collection has been implemented for the Cython modules\n -- by `@webknjaz `__.\n\n It will also be reported to Codecov from any non-release CI jobs.\n\n\n *Related issues and pull requests on GitHub:*\n `#561 `__.\n\n- A step-by-step ``Release Guide`` guide has\n been added, describing how to release *frozenlist* -- by `@webknjaz `__.\n\n This is primarily targeting the maintainers.\n\n\n *Related issues and pull requests on GitHub:*\n `#563 `__.\n\n- Detailed ``Contributing Guidelines`` on\n authoring the changelog fragments have been published in the\n documentation -- by `@webknjaz `__.\n\n\n *Related issues and pull requests on GitHub:*\n `#564 `__.\n\n\n----\n\n\n1.4.0 (2023-07-12)\n==================\n\nThe published source distribution package became buildable\nunder Python 3.12.\n\n\n----\n\n\nBugfixes\n--------\n\n- Removed an unused ``typing.Tuple`` import\n `#411 `_\n\n\nDeprecations and Removals\n-------------------------\n\n- Dropped Python 3.7 support.\n `#413 `_\n\n\nMisc\n----\n\n- `#410 `_, `#433 `_\n\n\n----\n\n\n1.3.3 (2022-11-08)\n==================\n\n- Fixed CI runs when creating a new release, where new towncrier versions\n fail when the current version section is already present.\n\n\n----\n\n\n1.3.2 (2022-11-08)\n==================\n\nMisc\n----\n\n- Updated the CI runs to better check for test results and to avoid deprecated syntax. `#327 `_\n\n\n----\n\n\n1.3.1 (2022-08-02)\n==================\n\nThe published source distribution package became buildable\nunder Python 3.11.\n\n\n----\n\n\n1.3.0 (2022-01-18)\n==================\n\nBugfixes\n--------\n\n- Do not install C sources with binary distributions.\n `#250 `_\n\n\nDeprecations and Removals\n-------------------------\n\n- Dropped Python 3.6 support\n `#274 `_\n\n\n----\n\n\n1.2.0 (2021-10-16)\n==================\n\nFeatures\n--------\n\n- ``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).\n `#172 `_\n- Added support for Python 3.10.\n `#227 `_\n- Started shipping platform-specific wheels with the ``musl`` tag targeting typical Alpine Linux runtimes.\n `#227 `_\n- Started shipping platform-specific arm64 wheels for Apple Silicon.\n `#227 `_\n\n\n----\n\n\n1.1.1 (2020-11-14)\n==================\n\nBugfixes\n--------\n\n- Provide x86 Windows wheels.\n `#169 `_\n\n\n----\n\n\n1.1.0 (2020-10-13)\n==================\n\nFeatures\n--------\n\n- Add support for hashing of a frozen list.\n `#136 `_\n\n- Support Python 3.8 and 3.9.\n\n- Provide wheels for ``aarch64``, ``i686``, ``ppc64le``, ``s390x`` architectures on\n Linux as well as ``x86_64``.\n\n\n----\n\n\n1.0.0 (2019-11-09)\n==================\n\nDeprecations and Removals\n-------------------------\n\n- Dropped support for Python 3.5; only 3.6, 3.7 and 3.8 are supported going forward.\n `#24 `_\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":"https://github.com/aio-libs/frozenlist","keywords":null,"license":"Apache-2.0","license_expression":null,"license_files":["LICENSE"],"maintainer":"aiohttp team ","maintainer_email":"team@aiohttp.org","name":"frozenlist","package_url":"https://pypi.org/project/frozenlist/","platform":null,"project_url":"https://pypi.org/project/frozenlist/","project_urls":{"CI: Github Actions":"https://github.com/aio-libs/frozenlist/actions","Chat: Matrix":"https://matrix.to/#/#aio-libs:matrix.org","Chat: Matrix Space":"https://matrix.to/#/#aio-libs-space:matrix.org","Code of Conduct":"https://github.com/aio-libs/.github/blob/master/CODE_OF_CONDUCT.md","Coverage: codecov":"https://codecov.io/github/aio-libs/frozenlist","Docs: Changelog":"https://github.com/aio-libs/frozenlist/blob/master/CHANGES.rst#changelog","Docs: RTD":"https://frozenlist.aio-libs.org","GitHub: issues":"https://github.com/aio-libs/frozenlist/issues","GitHub: repo":"https://github.com/aio-libs/frozenlist","Homepage":"https://github.com/aio-libs/frozenlist"},"provides_extra":null,"release_url":"https://pypi.org/project/frozenlist/1.6.0/","requires_dist":null,"requires_python":">=3.9","summary":"A list-like structure which implements collections.abc.MutableSequence","version":"1.6.0","yanked":false,"yanked_reason":null}

Package search

frozenlist

project_urls

Dependencies

All package metadata

Releases