third_party/python/frozenlist/PKG-INFO

   1 Metadata-Version: 2.1
   2 Name: frozenlist
   3 Version: 1.1.1
   4 Summary: A list-like structure which implements collections.abc.MutableSequence
   5 Home-page: https://github.com/aio-libs/frozenlist
   6 Author: Nikolay Kim
   7 Author-email: fafhrd91@gmail.com
   8 Maintainer: Martijn Pieters <mj@zopatista.com>
   9 Maintainer-email: aio-libs@googlegroups.com
  10 License: Apache 2
  11 Project-URL: Chat: Gitter, https://gitter.im/aio-libs/Lobby
  12 Project-URL: CI: Github Actions, https://github.com/aio-libs/frozenlist/actions
  13 Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/frozenlist
  14 Project-URL: Docs: RTD, https://frozenlist.readthedocs.io
  15 Project-URL: GitHub: issues, https://github.com/aio-libs/frozenlist/issues
  16 Project-URL: GitHub: repo, https://github.com/aio-libs/frozenlist
  17 Description: ==========
  18         frozenlist
  19         ==========
  20
  21         .. image:: https://github.com/aio-libs/frozenlist/workflows/CI/badge.svg
  22            :target: https://github.com/aio-libs/frozenlist/actions
  23            :alt: GitHub status for master branch
  24
  25         .. image:: https://codecov.io/gh/aio-libs/frozenlist/branch/master/graph/badge.svg
  26            :target: https://codecov.io/gh/aio-libs/frozenlist
  27            :alt: codecov.io status for master branch
  28
  29         .. image:: https://badge.fury.io/py/frozenlist.svg
  30            :target: https://pypi.org/project/frozenlist
  31            :alt: Latest PyPI package version
  32
  33         .. image:: https://readthedocs.org/projects/frozenlist/badge/?version=latest
  34            :target: https://frozenlist.readthedocs.io/
  35            :alt: Latest Read The Docs
  36
  37         .. image:: https://img.shields.io/discourse/topics?server=https%3A%2F%2Faio-libs.discourse.group%2F
  38            :target: https://aio-libs.discourse.group/
  39            :alt: Discourse group for io-libs
  40
  41         .. image:: https://badges.gitter.im/Join%20Chat.svg
  42            :target: https://gitter.im/aio-libs/Lobby
  43            :alt: Chat on Gitter
  44
  45         Introduction
  46         ============
  47
  48         ``frozenlist.FrozenList`` is a list-like structure which implements
  49         ``collections.abc.MutableSequence``. The list is *mutable* until ``FrozenList.freeze``
  50         is called, after which list modifications raise ``RuntimeError``:
  51
  52
  53         >>> from frozenlist import FrozenList
  54         >>> fl = FrozenList([17, 42])
  55         >>> fl.append('spam')
  56         >>> fl.append('Vikings')
  57         >>> fl
  58         <FrozenList(frozen=False, [17, 42, 'spam', 'Vikings'])>
  59         >>> fl.freeze()
  60         >>> fl
  61         <FrozenList(frozen=True, [17, 42, 'spam', 'Vikings'])>
  62         >>> fl.frozen
  63         True
  64         >>> fl.append("Monty")
  65         Traceback (most recent call last):
  66           File "<stdin>", line 1, in <module>
  67           File "frozenlist/_frozenlist.pyx", line 97, in frozenlist._frozenlist.FrozenList.append
  68             self._check_frozen()
  69           File "frozenlist/_frozenlist.pyx", line 19, in frozenlist._frozenlist.FrozenList._check_frozen
  70             raise RuntimeError("Cannot modify frozen list.")
  71         RuntimeError: Cannot modify frozen list.
  72
  73
  74         FrozenList is also hashable, but only when frozen. Otherwise it also throws a RuntimeError:
  75
  76
  77         >>> fl = FrozenList([17, 42, 'spam'])
  78         >>> hash(fl)
  79         Traceback (most recent call last):
  80           File "<stdin>", line 1, in <module>
  81           File "frozenlist/_frozenlist.pyx", line 111, in frozenlist._frozenlist.FrozenList.__hash__
  82             raise RuntimeError("Cannot hash unfrozen list.")
  83         RuntimeError: Cannot hash unfrozen list.
  84         >>> fl.freeze()
  85         >>> hash(fl)
  86         3713081631934410656
  87         >>> dictionary = {fl: 'Vikings'} # frozen fl can be a dict key
  88         >>> dictionary
  89         {<FrozenList(frozen=True, [1, 2])>: 'Vikings'}
  90
  91
  92         Installation
  93         ------------
  94
  95         ::
  96
  97            $ pip install frozenlist
  98
  99         The library requires Python 3.6 or newer.
 100
 101
 102         Documentation
 103         =============
 104
 105         https://frozenlist.readthedocs.io/
 106
 107         Communication channels
 108         ======================
 109
 110         *aio-libs discourse group*: https://aio-libs.discourse.group
 111
 112         Feel free to post your questions and ideas here.
 113
 114         *gitter chat* https://gitter.im/aio-libs/Lobby
 115
 116         Requirements
 117         ============
 118
 119         - Python >= 3.6
 120
 121         License
 122         =======
 123
 124         ``frozenlist`` is offered under the Apache 2 license.
 125
 126         Source code
 127         ===========
 128
 129         The project is hosted on GitHub_
 130
 131         Please file an issue in the `bug tracker
 132         <https://github.com/aio-libs/frozenlist/issues>`_ if you have found a bug
 133         or have some suggestions to improve the library.
 134
 135         .. _GitHub: https://github.com/aio-libs/frozenlist
 136
 137         =========
 138         Changelog
 139         =========
 140
 141         ..
 142             You should *NOT* be adding new change log entries to this file, this
 143             file is managed by towncrier. You *may* edit previous change logs to
 144             fix problems like typo corrections or such.
 145             To add a new change log entry, please see
 146             https://pip.pypa.io/en/latest/development/contributing/#news-entries
 147             we named the news folder "changes".
 148
 149             WARNING: Don't drop the next directive!
 150
 151         .. towncrier release notes start
 152
 153         1.1.1 (2020-11-14)
 154         ==================
 155
 156         Bugfixes
 157         --------
 158
 159         - Provide x86 Windows wheels.
 160           `#169 <https://github.com/aio-libs/frozenlist/issues/169>`_
 161
 162
 163         ----
 164
 165
 166         1.1.0 (2020-10-13)
 167         ==================
 168
 169         Features
 170         --------
 171
 172         - Add support for hashing of a frozen list.
 173           `#136 <https://github.com/aio-libs/frozenlist/issues/136>`_
 174
 175         - Support Python 3.8 and 3.9.
 176
 177         - Provide wheels for ``aarch64``, ``i686``, ``ppc64le``, ``s390x`` architectures on
 178           Linux as well as ``x86_64``.
 179
 180
 181         ----
 182
 183
 184         1.0.0 (2019-11-09)
 185         ==================
 186
 187         Deprecations and Removals
 188         -------------------------
 189
 190         - Dropped support for Python 3.5; only 3.6, 3.7 and 3.8 are supported going forward.
 191           `#24 <https://github.com/aio-libs/frozenlist/issues/24>`_
 192 Platform: UNKNOWN
 193 Classifier: License :: OSI Approved :: Apache Software License
 194 Classifier: Intended Audience :: Developers
 195 Classifier: Programming Language :: Python
 196 Classifier: Programming Language :: Python :: 3
 197 Classifier: Programming Language :: Python :: 3.6
 198 Classifier: Programming Language :: Python :: 3.7
 199 Classifier: Programming Language :: Python :: 3.8
 200 Classifier: Programming Language :: Python :: 3.9
 201 Classifier: Development Status :: 5 - Production/Stable
 202 Classifier: Operating System :: POSIX
 203 Classifier: Operating System :: MacOS :: MacOS X
 204 Classifier: Operating System :: Microsoft :: Windows
 205 Requires-Python: >=3.6
 206 Description-Content-Type: text/x-rst