File: api.rst

package info (click to toggle)
python-dogpile.cache 1.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 772 kB
  • sloc: python: 5,462; makefile: 155; sh: 104
file content (93 lines) | stat: -rw-r--r-- 1,587 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
===
API
===


Region
======

.. automodule:: dogpile.cache.region
    :members:
    :show-inheritance:

Backend API
=============

See the section :ref:`creating_backends` for details on how to
register new backends or :ref:`changing_backend_behavior` for details on
how to alter the behavior of existing backends.

.. automodule:: dogpile.cache.api
    :members:
    :show-inheritance:


Backends
==========

.. automodule:: dogpile.cache.backends.memory
    :members:
    :show-inheritance:

.. automodule:: dogpile.cache.backends.memcached
    :members:
    :show-inheritance:

.. automodule:: dogpile.cache.backends.redis
    :members:
    :show-inheritance:

.. automodule:: dogpile.cache.backends.file
    :members:
    :show-inheritance:

.. automodule:: dogpile.cache.proxy
    :members:
    :show-inheritance:

.. automodule:: dogpile.cache.backends.null
    :members:
    :show-inheritance:

Exceptions
==========

.. automodule:: dogpile.cache.exception
    :members:
    :show-inheritance:

Plugins
========

.. automodule:: dogpile.cache.plugins.mako_cache
    :members:
    :show-inheritance:

Utilities
=========

.. currentmodule:: dogpile.cache.util

.. autofunction:: function_key_generator

.. autofunction:: kwarg_function_key_generator

.. autofunction:: sha1_mangle_key

.. autofunction:: length_conditional_mangler

dogpile Core
============

.. autoclass:: dogpile.Lock
    :members:

.. autoclass:: dogpile.NeedRegenerationException
    :members:

.. autoclass:: dogpile.util.ReadWriteMutex
    :members:

.. autoclass:: dogpile.util.NameRegistry
    :members: