| 1 |
Metadata-Version: 2.1 |
| 2 |
Name: propcache |
| 3 |
Version: 0.2.0 |
| 4 |
Summary: Accelerated property cache |
| 5 |
Home-page: https://github.com/aio-libs/propcache |
| 6 |
Author: Andrew Svetlov |
| 7 |
Author-email: [email protected] |
| 8 |
Maintainer: aiohttp team <[email protected]> |
| 9 |
Maintainer-email: [email protected] |
| 10 |
License: Apache-2.0 |
| 11 |
Project-URL: Chat: Matrix, https://matrix.to/#/#aio-libs:matrix.org |
| 12 |
Project-URL: Chat: Matrix Space, https://matrix.to/#/#aio-libs-space:matrix.org |
| 13 |
Project-URL: CI: GitHub Workflows, https://github.com/aio-libs/propcache/actions?query=branch:master |
| 14 |
Project-URL: Code of Conduct, https://github.com/aio-libs/.github/blob/master/CODE_OF_CONDUCT.md |
| 15 |
Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/propcache |
| 16 |
Project-URL: Docs: Changelog, https://propcache.readthedocs.io/en/latest/changes/ |
| 17 |
Project-URL: Docs: RTD, https://propcache.readthedocs.io |
| 18 |
Project-URL: GitHub: issues, https://github.com/aio-libs/propcache/issues |
| 19 |
Project-URL: GitHub: repo, https://github.com/aio-libs/propcache |
| 20 |
Keywords: cython,cext,propcache |
| 21 |
Classifier: Development Status :: 5 - Production/Stable |
| 22 |
Classifier: Intended Audience :: Developers |
| 23 |
Classifier: License :: OSI Approved :: Apache Software License |
| 24 |
Classifier: Programming Language :: Cython |
| 25 |
Classifier: Programming Language :: Python |
| 26 |
Classifier: Programming Language :: Python :: 3 |
| 27 |
Classifier: Programming Language :: Python :: 3.8 |
| 28 |
Classifier: Programming Language :: Python :: 3.9 |
| 29 |
Classifier: Programming Language :: Python :: 3.10 |
| 30 |
Classifier: Programming Language :: Python :: 3.11 |
| 31 |
Classifier: Programming Language :: Python :: 3.12 |
| 32 |
Classifier: Programming Language :: Python :: 3.13 |
| 33 |
Classifier: Topic :: Internet :: WWW/HTTP |
| 34 |
Classifier: Topic :: Software Development :: Libraries :: Python Modules |
| 35 |
Requires-Python: >=3.8 |
| 36 |
Description-Content-Type: text/x-rst |
| 37 |
License-File: LICENSE |
| 38 |
License-File: NOTICE |
| 39 |
|
| 40 |
propcache |
| 41 |
========= |
| 42 |
|
| 43 |
The module provides a fast implementation of cached properties for Python 3.8+. |
| 44 |
|
| 45 |
.. image:: https://github.com/aio-libs/propcache/actions/workflows/ci-cd.yml/badge.svg |
| 46 |
:target: https://github.com/aio-libs/propcache/actions?query=workflow%3ACI |
| 47 |
:align: right |
| 48 |
|
| 49 |
.. image:: https://codecov.io/gh/aio-libs/propcache/branch/master/graph/badge.svg |
| 50 |
:target: https://codecov.io/gh/aio-libs/propcache |
| 51 |
|
| 52 |
.. image:: https://badge.fury.io/py/propcache.svg |
| 53 |
:target: https://badge.fury.io/py/propcache |
| 54 |
|
| 55 |
|
| 56 |
.. image:: https://readthedocs.org/projects/propcache/badge/?version=latest |
| 57 |
:target: https://propcache.readthedocs.io |
| 58 |
|
| 59 |
|
| 60 |
.. image:: https://img.shields.io/pypi/pyversions/propcache.svg |
| 61 |
:target: https://pypi.python.org/pypi/propcache |
| 62 |
|
| 63 |
.. 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 |
| 64 |
:target: https://matrix.to/#/%23aio-libs:matrix.org |
| 65 |
:alt: Matrix Room — #aio-libs:matrix.org |
| 66 |
|
| 67 |
.. 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 |
| 68 |
:target: https://matrix.to/#/%23aio-libs-space:matrix.org |
| 69 |
:alt: Matrix Space — #aio-libs-space:matrix.org |
| 70 |
|
| 71 |
Introduction |
| 72 |
------------ |
| 73 |
|
| 74 |
The API is designed to be nearly identical to the built-in ``functools.cached_property`` class, |
| 75 |
except for the additional ``under_cached_property`` class which uses ``self._cache`` |
| 76 |
instead of ``self.__dict__`` to store the cached values and prevents ``__set__`` from being called. |
| 77 |
|
| 78 |
For full documentation please read https://propcache.readthedocs.io. |
| 79 |
|
| 80 |
Installation |
| 81 |
------------ |
| 82 |
|
| 83 |
:: |
| 84 |
|
| 85 |
$ pip install propcache |
| 86 |
|
| 87 |
The library is Python 3 only! |
| 88 |
|
| 89 |
PyPI contains binary wheels for Linux, Windows and MacOS. If you want to install |
| 90 |
``propcache`` on another operating system where wheels are not provided, |
| 91 |
the the tarball will be used to compile the library from |
| 92 |
the source code. It requires a C compiler and and Python headers installed. |
| 93 |
|
| 94 |
To skip the compilation you must explicitly opt-in by using a PEP 517 |
| 95 |
configuration setting ``pure-python``, or setting the ``PROPCACHE_NO_EXTENSIONS`` |
| 96 |
environment variable to a non-empty value, e.g.: |
| 97 |
|
| 98 |
.. code-block:: console |
| 99 |
|
| 100 |
$ pip install propcache --config-settings=pure-python=false |
| 101 |
|
| 102 |
Please note that the pure-Python (uncompiled) version is much slower. However, |
| 103 |
PyPy always uses a pure-Python implementation, and, as such, it is unaffected |
| 104 |
by this variable. |
| 105 |
|
| 106 |
|
| 107 |
API documentation |
| 108 |
------------------ |
| 109 |
|
| 110 |
The documentation is located at https://propcache.readthedocs.io. |
| 111 |
|
| 112 |
Source code |
| 113 |
----------- |
| 114 |
|
| 115 |
The project is hosted on GitHub_ |
| 116 |
|
| 117 |
Please file an issue on the `bug tracker |
| 118 |
<https://github.com/aio-libs/propcache/issues>`_ if you have found a bug |
| 119 |
or have some suggestion in order to improve the library. |
| 120 |
|
| 121 |
Discussion list |
| 122 |
--------------- |
| 123 |
|
| 124 |
*aio-libs* google group: https://groups.google.com/forum/#!forum/aio-libs |
| 125 |
|
| 126 |
Feel free to post your questions and ideas here. |
| 127 |
|
| 128 |
|
| 129 |
Authors and License |
| 130 |
------------------- |
| 131 |
|
| 132 |
The ``propcache`` package is derived from ``yarl`` which is written by Andrew Svetlov. |
| 133 |
|
| 134 |
It's *Apache 2* licensed and freely available. |
| 135 |
|
| 136 |
|
| 137 |
.. _GitHub: https://github.com/aio-libs/propcache |
| 138 |
|
| 139 |
========= |
| 140 |
Changelog |
| 141 |
========= |
| 142 |
|
| 143 |
.. |
| 144 |
You should *NOT* be adding new change log entries to this file, this |
| 145 |
file is managed by towncrier. You *may* edit previous change logs to |
| 146 |
fix problems like typo corrections or such. |
| 147 |
To add a new change log entry, please see |
| 148 |
https://pip.pypa.io/en/latest/development/#adding-a-news-entry |
| 149 |
we named the news folder "changes". |
| 150 |
|
| 151 |
WARNING: Don't drop the next directive! |
| 152 |
|
| 153 |
.. towncrier release notes start |
| 154 |
|
| 155 |
0.2.0 |
| 156 |
===== |
| 157 |
|
| 158 |
*(2024-10-07)* |
| 159 |
|
| 160 |
|
| 161 |
Bug fixes |
| 162 |
--------- |
| 163 |
|
| 164 |
- Fixed loading the C-extensions on Python 3.8 -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 165 |
|
| 166 |
*Related issues and pull requests on GitHub:* |
| 167 |
`#26 <https://github.com/aio-libs/propcache/issues/26>`__. |
| 168 |
|
| 169 |
|
| 170 |
Features |
| 171 |
-------- |
| 172 |
|
| 173 |
- Improved typing for the ``propcache.api.under_cached_property`` decorator -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 174 |
|
| 175 |
*Related issues and pull requests on GitHub:* |
| 176 |
`#38 <https://github.com/aio-libs/propcache/issues/38>`__. |
| 177 |
|
| 178 |
|
| 179 |
Improved documentation |
| 180 |
---------------------- |
| 181 |
|
| 182 |
- Added API documentation for the ``propcache.api.cached_property`` and ``propcache.api.under_cached_property`` decorators -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 183 |
|
| 184 |
*Related issues and pull requests on GitHub:* |
| 185 |
`#16 <https://github.com/aio-libs/propcache/issues/16>`__. |
| 186 |
|
| 187 |
|
| 188 |
Packaging updates and notes for downstreams |
| 189 |
------------------------------------------- |
| 190 |
|
| 191 |
- Moved ``propcache.api.under_cached_property`` and ``propcache.api.cached_property`` to `propcache.api` -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 192 |
|
| 193 |
Both decorators remain importable from the top-level package, however importing from `propcache.api` is now the recommended way to use them. |
| 194 |
|
| 195 |
*Related issues and pull requests on GitHub:* |
| 196 |
`#19 <https://github.com/aio-libs/propcache/issues/19>`__, `#24 <https://github.com/aio-libs/propcache/issues/24>`__, `#32 <https://github.com/aio-libs/propcache/issues/32>`__. |
| 197 |
|
| 198 |
- Converted project to use a src layout -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 199 |
|
| 200 |
*Related issues and pull requests on GitHub:* |
| 201 |
`#22 <https://github.com/aio-libs/propcache/issues/22>`__, `#29 <https://github.com/aio-libs/propcache/issues/29>`__, `#37 <https://github.com/aio-libs/propcache/issues/37>`__. |
| 202 |
|
| 203 |
|
| 204 |
---- |
| 205 |
|
| 206 |
|
| 207 |
0.1.0 |
| 208 |
===== |
| 209 |
|
| 210 |
*(2024-10-03)* |
| 211 |
|
| 212 |
|
| 213 |
Features |
| 214 |
-------- |
| 215 |
|
| 216 |
- Added ``armv7l`` wheels -- by `@bdraco <https://github.com/sponsors/bdraco>`__. |
| 217 |
|
| 218 |
*Related issues and pull requests on GitHub:* |
| 219 |
`#5 <https://github.com/aio-libs/propcache/issues/5>`__. |
| 220 |
|
| 221 |
|
| 222 |
---- |
| 223 |
|
| 224 |
|
| 225 |
0.0.0 |
| 226 |
===== |
| 227 |
|
| 228 |
*(2024-10-02)* |
| 229 |
|
| 230 |
|
| 231 |
- Initial release. |