sqlite

Summary

SQLiteBackend([cache_name, use_temp, fast_save])	Async cache backend for SQLite (requires aiosqlite)
SQLiteCache(filename[, table_name, ...])	An async interface for caching objects in a SQLite database.
SQLitePickleCache(filename[, table_name, ...])	Same as SqliteCache, but pickles values before saving

Module Contents

class SQLiteBackend(cache_name='aiohttp-cache', use_temp=False, fast_save=False, **kwargs)

Bases: aiohttp_client_cache.backends.base.CacheBackend

Async cache backend for SQLite (requires aiosqlite)

The path to the database file will be <cache_name> (or <cache_name>.sqlite if no file extension is specified)

Parameters

• cache_name (str) – Database filename

• use_temp (bool) –

• fast_save (bool) –

• expire_after (Union[None, int, float, str, datetime.datetime, datetime.timedelta]) –

• urls_expire_after (Optional[Dict[str, Union[None, int, float, str, datetime.datetime, datetime.timedelta]]]) –

• allowed_codes (Tuple[int, ...]) –

• allowed_methods (Tuple[str, ...]) –

• include_headers (bool) –

• ignored_params (Optional[Iterable[str]]) –

• cache_control (bool) –

• filter_fn (Union[Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], bool], Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], Awaitable[bool]]]) –

• secret_key (Optional[Union[Iterable, str, bytes]]) –

• salt (Union[str, bytes]) –

• timeout (float) –

• detect_types (int) –

• isolation_level (Optional[str]) –

• check_same_thread (bool) –

• factory (Optional[Type]) –

• cached_statements (int) –

• uri (bool) –

use_temp: Store database in a temp directory (e.g., /tmp/http_cache.sqlite).

Note: if cache_name is an absolute path, this option will be ignored.

fast_save: Increas cache write performance, but with the possibility of data loss. See

pragma: synchronous for details.

__init__(cache_name='aiohttp-cache', use_temp=False, fast_save=False, **kwargs)

Parameters

• cache_name (str) – Cache prefix or namespace, depending on backend

• expire_after (Union[None, int, float, str, datetime.datetime, datetime.timedelta]) – Time after which a cache entry will be expired; see Cache Expiration for possible formats

• urls_expire_after (Optional[Dict[str, Union[None, int, float, str, datetime.datetime, datetime.timedelta]]]) – Expiration times to apply for different URL patterns

• allowed_codes (Tuple[int, ...]) – Only cache responses with these status codes

• allowed_methods (Tuple[str, ...]) – Only cache requests with these HTTP methods

• include_headers (bool) – Cache requests with different headers separately

• ignored_params (Optional[Iterable[str]]) – Request parameters to be excluded from the cache key

• cache_control (bool) – Use Cache-Control response headers

• filter_fn (Union[Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], bool], Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], Awaitable[bool]]]) – function that takes a aiohttp.ClientResponse object and returns a boolean indicating whether or not that response should be cached. Will be applied to both new and previously cached responses

• secret_key (Optional[Union[Iterable, str, bytes]]) – Optional secret key used to sign cache items for added security

• salt (Union[str, bytes]) – Optional salt used to sign cache items

• serializer – Custom serializer that provides loads and dumps methods

• timeout (float) – Specifies how long the connection should wait for the lock to go away until raising an exception.

• detect_types (int) – Can be set to any combination of PARSE_DECLTYPES and PARSE_COLNAMES to turn type detection on for custom types.

• isolation_level (Optional[str]) – Transaction isolation level. Use None for autocommit mode, or one of: “DEFERRED”, “IMMEDIATE”, “EXCLUSIVE”

• check_same_thread (bool) – If True, only the creating thread may use the connection. If False, the returned connection may be shared across multiple threads.

• factory (Optional[Type]) – Custom subclass of sqlite3.Connection used to create connections

• cached_statements (int) – The number of statements that are cached internally for the connection

• uri (bool) – Interpret database path as a URI, to allow specifying additional options

• use_temp (bool) –

• fast_save (bool) –

• kwargs (Any) –

Parameters

• use_temp (bool) –

• fast_save (bool) –

• kwargs (Any) –

• cache_name (str) –

• expire_after (Union[None, int, float, str, datetime.datetime, datetime.timedelta]) –

• urls_expire_after (Optional[Dict[str, Union[None, int, float, str, datetime.datetime, datetime.timedelta]]]) –

• allowed_codes (Tuple[int, ...]) –

• allowed_methods (Tuple[str, ...]) –

• include_headers (bool) –

• ignored_params (Optional[Iterable[str]]) –

• cache_control (bool) –

• filter_fn (Union[Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], bool], Callable[[Union[aiohttp.ClientResponse, aiohttp_client_cache.response.CachedResponse]], Awaitable[bool]]]) –

• secret_key (Optional[Union[Iterable, str, bytes]]) –

• salt (Union[str, bytes]) –

• timeout (float) –

• detect_types (int) –

• isolation_level (Optional[str]) –

• check_same_thread (bool) –

• factory (Optional[Type]) –

• cached_statements (int) –

• uri (bool) –

class SQLiteCache(filename, table_name='aiohttp-cache', use_temp=False, fast_save=False, **kwargs)

Bases: aiohttp_client_cache.backends.base.BaseCache

An async interface for caching objects in a SQLite database.

Example

>>> # Store data in two tables under the 'testdb' database
>>> d1 = SQLiteCache('testdb', 'table1')
>>> d2 = SQLiteCache('testdb', 'table2')

Parameters

• filename (str) – Database filename

• table_name (str) – Table name

• use_temp (bool) – Store database in a temp directory (e.g., /tmp/http_cache.sqlite). Note: if cache_name is an absolute path, this option will be ignored.

• kwargs (Any) – Additional keyword arguments for sqlite3.connect()

• fast_save (bool) –

_abc_impl = <_abc_data object>

async _init_db()

Initialize the database, if it hasn’t already been

bulk_commit()

Contextmanager to more efficiently write a large number of records at once

Example

>>> cache = SQLiteCache('test')
>>> async with cache.bulk_commit():
...     for i in range(1000):
...         await cache.write(f'key_{i}', str(i))

async bulk_delete(keys)

Delete item(s) from the cache. Does not raise an error if the item is missing.

Parameters

keys (set) –

async clear()

Delete all items from the cache

async close()

Close any open connections

async contains(key)

Check if a key is stored in the cache

Parameters

key (str) –

Return type

bool

async delete(key)

Delete an item from the cache. Does not raise an error if the item is missing.

Parameters

key (str) –

get_connection(commit=False)

Parameters

commit (bool) –

Return type

AsyncIterator[Connection]

async keys()

Get all keys stored in the cache

Return type

AsyncIterable[str]

async read(key)

Read an item from the cache. Returns None if the item is missing.

Parameters

key (str) –

Return type

Union[CachedResponse, bytes, str, None]

async size()

Get the number of items in the cache

Return type

int

async values()

Get all values stored in the cache

Return type

AsyncIterable[Union[CachedResponse, bytes, str, None]]

async write(key, item)

Write an item to the cache

Parameters

• key (str) –

• item (Union[CachedResponse, bytes, str, None, memoryview]) –

class SQLitePickleCache(filename, table_name='aiohttp-cache', use_temp=False, fast_save=False, **kwargs)

Bases: aiohttp_client_cache.backends.sqlite.SQLiteCache

Same as SqliteCache, but pickles values before saving

Parameters

• filename (str) –

• table_name (str) –

• use_temp (bool) –

• fast_save (bool) –

• kwargs (Any) –

_abc_impl = <_abc_data object>

_connection: Optional[aiosqlite.core.Connection]

async read(key)

Read an item from the cache. Returns None if the item is missing.

Parameters

key (str) –

Return type

Union[CachedResponse, bytes, str, None]

async values()

Get all values stored in the cache

Return type

AsyncIterable[Union[CachedResponse, bytes, str, None]]

async write(key, item)

Write an item to the cache

_get_cache_filename(filename, use_temp)

Get resolved path for database file

Parameters

• filename (Union[Path, str]) –

• use_temp (bool) –

Return type

str