region-cache 0.3.8
Region-based caching for Python/Flask with Redis
License: MIT license
Keywords: region_cache

============
region_cache
============


.. image:: https://img.shields.io/pypi/v/region_cache.svg
        :target: https://pypi.python.org/pypi/region_cache

.. image:: https://img.shields.io/travis/jheard-tw/region_cache.svg
        :target: https://travis-ci.org/jheard-tw/region_cache

.. image:: https://readthedocs.org/projects/region-cache/badge/?version=latest
        :target: https://region-cache.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


.. image:: https://pyup.io/repos/github/jheard-tw/region_cache/shield.svg
     :target: https://pyup.io/repos/github/jheard-tw/region_cache/
     :alt: Updates



Region-based caching for Python/Flask with Redis


* Free software: MIT license
* Documentation: https://region-cache.readthedocs.io.


Features
--------

Region based Flask caching with Redis.

This module provides high-level nested, region-based caching with Redis. A region is a dot-separated
namespace where cache keys and values live. It is implemented as hashes in redis. Parent-child relationships
are implemented as sets. Timeouts use the EXPIRE command. All work is persisted in redis, and two regions with
the same name on two different processes or even different servers will share the same storage.

Invalidation of caches is "active", not "lazy", so caches are purged immediately upon invalidation, to solve
the problem of one process knowing about a cache invalidation and the other not. Cache writes are aggressively
pipelined and transactional, so if two processes write to the same key at the same time, results will not be
inconsistent.

The cache is written as a Flask extension, so you can use init_app with a valid flask app to initialize it.
Simply set the CACHE_REDIS_URL setting in the config.

Examples:
---------

Using the region as a context manager treats everything in the context manager as a single transaction::


    with region('abc.xyz') as r:
        x in r  # test for presence
        r[x] = 100  # get or KeyError
        x = r[x]  # set
        del r[x]  # remove

Bind to blinker signals, so the cache is purged declaratively::

    region('abc.xyz').invalidate_on(
        blinker.signal('a'),
        blinker.signal('b'),
        blinker.signal('c'),
        blinker.signal('d'),
    )


Nest regions. If you invalidate the parent region, all the children will also be invalidated. This is recursive, so
sub-sub-sub regions will be correctly invalidated as well::


    region('abc').region('xyz')  # subregion
    region('abc').invalidate()  # invalidate abc AND xyz


The default serializers is "pickle", but you can supply any serializer that exposes a loads and dumps, and individual
regions can be configured differently. Children inherit the settings of their parents.

Finally, timeouts are supported, and by default the timeout refreshes itself every time you write to the cache
See the region() function for more detail on how to configure it.

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.3.7 (2021-12-13)
------------------
* Support Python 3.9+

0.1.0 (2018-05-04)
------------------

* First release on PyPI.