/
sqlite.py
336 lines (267 loc) · 11.6 KB
/
sqlite.py
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
"""
.. image::
../_static/sqlite.png
`SQLite <https://www.sqlite.org/>`_ is a fast and lightweight SQL database engine that stores data
either in memory or in a single file on disk.
Despite its simplicity, SQLite is a powerful tool. For example, it's the primary storage system for
a number of common applications including Dropbox, Firefox, and Chrome. It's well suited for
caching, and requires no extra configuration or dependencies, which is why it's the default backend
for requests-cache.
Cache Files
^^^^^^^^^^^
* See :ref:`files` for general info on specifying cache paths
* If you specify a name without an extension, the default extension ``.sqlite`` will be used
In-Memory Caching
~~~~~~~~~~~~~~~~~
SQLite also supports `in-memory databases <https://www.sqlite.org/inmemorydb.html>`_.
You can enable this (in "shared" memory mode) with the ``use_memory`` option:
>>> session = CachedSession('http_cache', use_memory=True)
Or specify a memory URI with additional options:
>>> session = CachedSession(':file:memdb1?mode=memory')
Or just ``:memory:``, if you are only using the cache from a single thread:
>>> session = CachedSession(':memory:')
Performance
^^^^^^^^^^^
When working with average-sized HTTP responses (< 1MB) and using a modern SSD for file storage, you
can expect speeds of around:
* Write: 2-8ms
* Read: 0.2-0.6ms
Of course, this will vary based on hardware specs, response size, and other factors.
Concurrency
^^^^^^^^^^^
SQLite supports concurrent access, so it is safe to use from a multi-threaded and/or multi-process
application. It supports unlimited concurrent reads. Writes, however, are queued and run in serial,
so if you need to make large volumes of concurrent requests, you may want to consider a different
backend that's specifically made for that kind of workload, like :py:class:`.RedisCache`.
Connection Options
^^^^^^^^^^^^^^^^^^
The SQLite backend accepts any keyword arguments for :py:func:`sqlite3.connect`. These can be passed
via :py:class:`.CachedSession`:
>>> session = CachedSession('http_cache', timeout=30)
Or via :py:class:`.SQLiteCache`:
>>> backend = SQLiteCache('http_cache', timeout=30)
>>> session = CachedSession(backend=backend)
API Reference
^^^^^^^^^^^^^
.. automodsumm:: requests_cache.backends.sqlite
:classes-only:
:nosignatures:
"""
import sqlite3
import threading
from contextlib import contextmanager
from logging import getLogger
from os import unlink
from os.path import isfile
from pathlib import Path
from tempfile import gettempdir
from typing import Collection, Iterable, Iterator, List, Tuple, Type, Union
from appdirs import user_cache_dir
from . import BaseCache, BaseStorage, get_valid_kwargs
MEMORY_URI = 'file::memory:?cache=shared'
SQLITE_MAX_VARIABLE_NUMBER = 999
AnyPath = Union[Path, str]
logger = getLogger(__name__)
class SQLiteCache(BaseCache):
"""SQLite cache backend.
Args:
db_path: Database file path
use_cache_dir: Store datebase in a user cache directory (e.g., `~/.cache/http_cache.sqlite`)
use_temp: Store database in a temp directory (e.g., ``/tmp/http_cache.sqlite``)
use_memory: Store database in memory instead of in a file
fast_save: Significantly increases cache write performance, but with the possibility of data
loss. See `pragma: synchronous <http://www.sqlite.org/pragma.html#pragma_synchronous>`_
for details.
kwargs: Additional keyword arguments for :py:func:`sqlite3.connect`
"""
def __init__(self, db_path: AnyPath = 'http_cache', **kwargs):
super().__init__(**kwargs)
self.responses = SQLitePickleDict(db_path, table_name='responses', **kwargs)
self.redirects = SQLiteDict(db_path, table_name='redirects', **kwargs)
@property
def db_path(self) -> AnyPath:
return self.responses.db_path
def bulk_delete(self, keys):
"""Remove multiple responses and their associated redirects from the cache, with additional cleanup"""
self.responses.bulk_delete(keys=keys)
self.responses.vacuum()
self.redirects.bulk_delete(keys=keys)
self.redirects.bulk_delete(values=keys)
self.redirects.vacuum()
def clear(self):
"""Clear the cache. If this fails due to a corrupted cache or other I/O error, this will
attempt to delete the cache file and re-initialize.
"""
try:
super().clear()
except Exception:
logger.exception('Failed to clear cache')
if isfile(self.responses.db_path):
unlink(self.responses.db_path)
self.responses.init_db()
self.redirects.init_db()
class SQLiteDict(BaseStorage):
"""A dictionary-like interface for SQLite"""
def __init__(
self,
db_path,
table_name='http_cache',
fast_save=False,
use_cache_dir: bool = False,
use_memory: bool = False,
use_temp: bool = False,
**kwargs,
):
super().__init__(**kwargs)
self.connection_kwargs = get_valid_kwargs(sqlite_template, kwargs)
self.db_path = _get_sqlite_cache_path(db_path, use_cache_dir, use_temp, use_memory)
self.fast_save = fast_save
self.table_name = table_name
self._lock = threading.RLock()
self._can_commit = True
self._local_context = threading.local()
self.init_db()
def init_db(self):
"""Initialize the database, if it hasn't already been"""
self.close()
with self._lock, self.connection() as con:
con.execute(f'CREATE TABLE IF NOT EXISTS {self.table_name} (key PRIMARY KEY, value)')
@contextmanager
def connection(self, commit=False) -> Iterator[sqlite3.Connection]:
"""Get a thread-local database connection"""
if not getattr(self._local_context, 'con', None):
logger.debug(f'Opening connection to {self.db_path}:{self.table_name}')
self._local_context.con = sqlite3.connect(self.db_path, **self.connection_kwargs)
if self.fast_save:
self._local_context.con.execute('PRAGMA synchronous = 0;')
yield self._local_context.con
if commit and self._can_commit:
self._local_context.con.commit()
def close(self):
"""Close any active connections"""
if getattr(self._local_context, 'con', None):
self._local_context.con.close()
self._local_context.con = None
@contextmanager
def bulk_commit(self):
"""Context manager used to speed up insertion of a large number of records
Example:
>>> d1 = SQLiteDict('test')
>>> with d1.bulk_commit():
... for i in range(1000):
... d1[i] = i * 2
"""
self._can_commit = False
try:
yield
if hasattr(self._local_context, 'con'):
self._local_context.con.commit()
finally:
self._can_commit = True
def __del__(self):
self.close()
def __delitem__(self, key):
with self.connection(commit=True) as con:
cur = con.execute(f'DELETE FROM {self.table_name} WHERE key=?', (key,))
if not cur.rowcount:
raise KeyError
def __getitem__(self, key):
with self.connection() as con:
row = con.execute(f'SELECT value FROM {self.table_name} WHERE key=?', (key,)).fetchone()
# raise error after the with block, otherwise the connection will be locked
if not row:
raise KeyError
return row[0]
def __setitem__(self, key, value):
with self.connection(commit=True) as con:
con.execute(
f'INSERT OR REPLACE INTO {self.table_name} (key,value) VALUES (?,?)',
(key, value),
)
def __iter__(self):
with self.connection() as con:
for row in con.execute(f'SELECT key FROM {self.table_name}'):
yield row[0]
def __len__(self):
with self.connection() as con:
return con.execute(f'SELECT COUNT(key) FROM {self.table_name}').fetchone()[0]
def bulk_delete(self, keys=None, values=None):
"""Delete multiple keys from the cache, without raising errors for any missing keys.
Also supports deleting by value.
"""
if not keys and not values:
return
column = 'key' if keys else 'value'
with self.connection(commit=True) as con:
# Split into small enough chunks for SQLite to handle
for chunk in chunkify(keys or values):
marks, args = _format_sequence(chunk)
statement = f'DELETE FROM {self.table_name} WHERE {column} IN ({marks})'
con.execute(statement, args)
def clear(self):
with self.connection(commit=True) as con:
con.execute(f'DROP TABLE IF EXISTS {self.table_name}')
self.init_db()
self.vacuum()
def vacuum(self):
with self.connection(commit=True) as con:
con.execute('VACUUM')
class SQLitePickleDict(SQLiteDict):
"""Same as :class:`SQLiteDict`, but serializes values before saving"""
def __setitem__(self, key, value):
serialized_value = self.serializer.dumps(value)
if isinstance(serialized_value, bytes):
serialized_value = sqlite3.Binary(serialized_value)
super().__setitem__(key, serialized_value)
def __getitem__(self, key):
return self.serializer.loads(super().__getitem__(key))
def chunkify(iterable: Iterable, max_size=SQLITE_MAX_VARIABLE_NUMBER) -> Iterator[List]:
"""Split an iterable into chunks of a max size"""
iterable = list(iterable)
for index in range(0, len(iterable), max_size):
yield iterable[index : index + max_size]
def _format_sequence(values: Collection) -> Tuple[str, List]:
"""Get SQL parameter marks for a sequence-based query, and ensure value is a sequence"""
if not isinstance(values, Iterable):
values = [values]
return ','.join(['?'] * len(values)), list(values)
def _get_sqlite_cache_path(
db_path: AnyPath, use_cache_dir: bool, use_temp: bool, use_memory: bool = False
) -> AnyPath:
"""Get a resolved path for a SQLite database file (or memory URI("""
# Use an in-memory database, if specified
db_path = str(db_path)
if use_memory:
return MEMORY_URI
elif ':memory:' in db_path or 'mode=memory' in db_path:
return db_path
# Add file extension if not specified
if not Path(db_path).suffix:
db_path += '.sqlite'
return get_cache_path(db_path, use_cache_dir, use_temp)
def get_cache_path(db_path: AnyPath, use_cache_dir: bool = False, use_temp: bool = False) -> Path:
"""Get a resolved cache path"""
db_path = Path(db_path)
# Save to platform-specific temp or user cache directory, if specified
if use_cache_dir and not db_path.is_absolute():
db_path = Path(user_cache_dir()) / db_path
elif use_temp and not db_path.is_absolute():
db_path = Path(gettempdir()) / db_path
# Expand relative and user paths (~/*), and make sure parent dirs exist
db_path = db_path.absolute().expanduser()
db_path.parent.mkdir(parents=True, exist_ok=True)
return db_path
def sqlite_template(
timeout: float = 5.0,
detect_types: int = 0,
isolation_level: str = None,
check_same_thread: bool = True,
factory: Type = None,
cached_statements: int = 100,
uri: bool = False,
):
"""Template function to get an accurate signature for the builtin :py:func:`sqlite3.connect`"""
# Aliases for backwards-compatibility
DbCache = SQLiteCache
DbDict = SQLiteDict
DbPickeDict = SQLitePickleDict