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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
.. automodule:: diskcache
.. contents::
:local:
Cache
-----
Read the :ref:`Cache tutorial <tutorial-cache>` for example usage.
.. autoclass:: diskcache.Cache
:members:
:special-members:
:exclude-members: __weakref__
FanoutCache
-----------
Read the :ref:`FanoutCache tutorial <tutorial-fanoutcache>` for example usage.
.. autoclass:: diskcache.FanoutCache
:members:
:special-members:
:exclude-members: __weakref__
DjangoCache
-----------
Read the :ref:`DjangoCache tutorial <tutorial-djangocache>` for example usage.
.. autoclass:: diskcache.DjangoCache
:members:
:special-members:
Deque
-----
.. autoclass:: diskcache.Deque
:members:
:special-members:
:exclude-members: __weakref__
Index
-----
.. autoclass:: diskcache.Index
:members:
:special-members:
:exclude-members: __weakref__
Recipes
-------
.. autoclass:: diskcache.Averager
:members:
.. autoclass:: diskcache.Lock
:members:
.. autoclass:: diskcache.RLock
:members:
.. autoclass:: diskcache.BoundedSemaphore
:members:
.. autodecorator:: diskcache.throttle
.. autodecorator:: diskcache.barrier
.. autodecorator:: diskcache.memoize_stampede
.. _constants:
Constants
---------
Read the :ref:`Settings tutorial <tutorial-settings>` for details.
.. data:: diskcache.DEFAULT_SETTINGS
* `statistics` (int) default 0 - disabled when 0, enabled when 1.
* `tag_index` (int) default 0 - disabled when 0, enabled when 1.
* `eviction_policy` (str) default "least-recently-stored" - any of the keys
in `EVICTION_POLICY` as described below.
* `size_limit` (int, in bytes) default one gigabyte - approximate size limit
of cache.
* `cull_limit` (int) default ten - maximum number of items culled during
`set` or `add` operations.
* `sqlite_auto_vacuum` (int) default 1, "FULL" - SQLite auto vacuum pragma.
* `sqlite_cache_size` (int, in pages) default 8,192 - SQLite cache size
pragma.
* `sqlite_journal_mode` (str) default "wal" - SQLite journal mode pragma.
* `sqlite_mmap_size` (int, in bytes) default 64 megabytes - SQLite mmap size
pragma.
* `sqlite_synchronous` (int) default 1, "NORMAL" - SQLite synchronous
pragma.
* `disk_min_file_size` (int, in bytes) default 32 kilobytes - values with
greater size are stored in files.
* `disk_pickle_protocol` (int) default highest Pickle protocol - the Pickle
protocol to use for data types that are not natively supported.
.. data:: diskcache.EVICTION_POLICY
* `least-recently-stored` (default) - evict least recently stored keys first.
* `least-recently-used` - evict least recently used keys first.
* `least-frequently-used` - evict least frequently used keys first.
* `none` - never evict keys.
Disk
----
Read the :ref:`Disk tutorial <tutorial-disk>` for details.
.. autoclass:: diskcache.Disk
:members:
:special-members:
:exclude-members: __weakref__
JSONDisk
--------
Read the :ref:`Disk tutorial <tutorial-disk>` for details.
.. autoclass:: diskcache.JSONDisk
:members:
:special-members:
:exclude-members: __weakref__
Timeout
-------
.. autoexception:: diskcache.Timeout
|
