Accelerated property cache

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for bdraco from gravatar.com bdraco

Unverified details

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

Project description

propcache

The module provides a fast implementation of cached properties for Python 3.9+.

https://github.com/aio-libs/propcache/actions/workflows/ci-cd.yml/badge.svg https://codecov.io/gh/aio-libs/propcache/branch/master/graph/badge.svg https://badge.fury.io/py/propcache.svg https://readthedocs.org/projects/propcache/badge/?version=latest https://img.shields.io/pypi/pyversions/propcache.svg Matrix Room — #aio-libs:matrix.org Matrix Space — #aio-libs-space:matrix.org

Introduction

The API is designed to be nearly identical to the built-in functools.cached_property class, except for the additional under_cached_property class which uses self._cache instead of self.__dict__ to store the cached values and prevents __set__ from being called.

For full documentation please read https://propcache.readthedocs.io.

Installation

$ pip install propcache

The library is Python 3 only!

PyPI contains binary wheels for Linux, Windows and MacOS. If you want to install propcache on another operating system where wheels are not provided, the the tarball will be used to compile the library from the source code. It requires a C compiler and and Python headers installed.

To skip the compilation you must explicitly opt-in by using a PEP 517 configuration setting pure-python, or setting the PROPCACHE_NO_EXTENSIONS environment variable to a non-empty value, e.g.:

$ pip install propcache --config-settings=pure-python=false

Please note that the pure-Python (uncompiled) version is much slower. However, PyPy always uses a pure-Python implementation, and, as such, it is unaffected by this variable.

API documentation

The documentation is located at https://propcache.readthedocs.io.

Source code

The project is hosted on GitHub

Please file an issue on the bug tracker if you have found a bug or have some suggestion in order to improve the library.

Discussion list

aio-libs google group: https://groups.google.com/forum/#!forum/aio-libs

Feel free to post your questions and ideas here.

Authors and License

The propcache package is derived from yarl which is written by Andrew Svetlov.

It’s Apache 2 licensed and freely available.

Changelog

0.3.0

(2025-02-20)

Features

  • Implemented support for the free-threaded build of CPython 3.13 – by @lysnikolaou.

    Related issues and pull requests on GitHub: #84.

Packaging updates and notes for downstreams

  • Started building wheels for the free-threaded build of CPython 3.13 – by @lysnikolaou.

    Related issues and pull requests on GitHub: #84.

Contributor-facing changes

  • GitHub Actions CI/CD is now configured to manage caching pip-ecosystem dependencies using re-actors/cache-python-deps – an action by @webknjaz that takes into account ABI stability and the exact version of Python runtime.

    Related issues and pull requests on GitHub: #93.

0.2.1

(2024-12-01)

Bug fixes

  • Stopped implicitly allowing the use of Cython pre-release versions when building the distribution package – by @ajsanchezsanz and @markgreene74.

    Related commits on GitHub: 64df0a6.

  • Fixed wrapped and func not being accessible in the Cython versions of propcache.api.cached_property and propcache.api.under_cached_property decorators – by @bdraco.

    Related issues and pull requests on GitHub: #72.

Removals and backward incompatible breaking changes

  • Removed support for Python 3.8 as it has reached end of life – by @bdraco.

    Related issues and pull requests on GitHub: #57.

Packaging updates and notes for downstreams

  • Stopped implicitly allowing the use of Cython pre-release versions when building the distribution package – by @ajsanchezsanz and @markgreene74.

    Related commits on GitHub: 64df0a6.

0.2.0

(2024-10-07)

Bug fixes

  • Fixed loading the C-extensions on Python 3.8 – by @bdraco.

    Related issues and pull requests on GitHub: #26.

Features

  • Improved typing for the propcache.api.under_cached_property decorator – by @bdraco.

    Related issues and pull requests on GitHub: #38.

Improved documentation

  • Added API documentation for the propcache.api.cached_property and propcache.api.under_cached_property decorators – by @bdraco.

    Related issues and pull requests on GitHub: #16.

Packaging updates and notes for downstreams

  • Moved propcache.api.under_cached_property and propcache.api.cached_property to propcache.api – by @bdraco.

    Both decorators remain importable from the top-level package, however importing from propcache.api is now the recommended way to use them.

    Related issues and pull requests on GitHub: #19, #24, #32.

  • Converted project to use a src layout – by @bdraco.

    Related issues and pull requests on GitHub: #22, #29, #37.

0.1.0

(2024-10-03)

Features

  • Added armv7l wheels – by @bdraco.

    Related issues and pull requests on GitHub: #5.

0.0.0

(2024-10-02)

  • Initial release.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page