fastapi-cache-stable 0.3.0a0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- fastapi_cache/__init__.py +103 -0
- fastapi_cache/backends/__init__.py +28 -0
- fastapi_cache/backends/dynamodb.py +103 -0
- fastapi_cache/backends/inmemory.py +61 -0
- fastapi_cache/backends/memcached.py +22 -0
- fastapi_cache/backends/redis.py +30 -0
- fastapi_cache/coder.py +129 -0
- fastapi_cache/decorator.py +231 -0
- fastapi_cache/key_builder.py +20 -0
- fastapi_cache/py.typed +0 -0
- fastapi_cache/types.py +40 -0
- fastapi_cache_stable-0.3.0a0.dist-info/METADATA +281 -0
- fastapi_cache_stable-0.3.0a0.dist-info/RECORD +16 -0
- fastapi_cache_stable-0.3.0a0.dist-info/WHEEL +4 -0
- fastapi_cache_stable-0.3.0a0.dist-info/licenses/LICENSE +201 -0
- fastapi_cache_stable-0.3.0a0.dist-info/licenses/NOTICE +6 -0
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
from importlib.metadata import version
|
|
2
|
+
from typing import ClassVar, Optional, Type
|
|
3
|
+
|
|
4
|
+
from fastapi_cache.coder import Coder, JsonCoder
|
|
5
|
+
from fastapi_cache.key_builder import default_key_builder
|
|
6
|
+
from fastapi_cache.types import Backend, KeyBuilder
|
|
7
|
+
|
|
8
|
+
__version__ = version("fastapi-cache-stable") # pyright: ignore[reportUnknownVariableType]
|
|
9
|
+
__all__ = [
|
|
10
|
+
"Backend",
|
|
11
|
+
"Coder",
|
|
12
|
+
"FastAPICache",
|
|
13
|
+
"JsonCoder",
|
|
14
|
+
"KeyBuilder",
|
|
15
|
+
"default_key_builder",
|
|
16
|
+
]
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class FastAPICache:
|
|
20
|
+
_backend: ClassVar[Optional[Backend]] = None
|
|
21
|
+
_prefix: ClassVar[Optional[str]] = None
|
|
22
|
+
_expire: ClassVar[Optional[int]] = None
|
|
23
|
+
_init: ClassVar[bool] = False
|
|
24
|
+
_coder: ClassVar[Optional[Type[Coder]]] = None
|
|
25
|
+
_key_builder: ClassVar[Optional[KeyBuilder]] = None
|
|
26
|
+
_cache_status_header: ClassVar[Optional[str]] = None
|
|
27
|
+
_enable: ClassVar[bool] = True
|
|
28
|
+
|
|
29
|
+
@classmethod
|
|
30
|
+
def init(
|
|
31
|
+
cls,
|
|
32
|
+
backend: Backend,
|
|
33
|
+
prefix: str = "",
|
|
34
|
+
expire: Optional[int] = None,
|
|
35
|
+
coder: Type[Coder] = JsonCoder,
|
|
36
|
+
key_builder: KeyBuilder = default_key_builder,
|
|
37
|
+
cache_status_header: str = "X-FastAPI-Cache",
|
|
38
|
+
enable: bool = True,
|
|
39
|
+
) -> None:
|
|
40
|
+
if cls._init:
|
|
41
|
+
return
|
|
42
|
+
cls._init = True
|
|
43
|
+
cls._backend = backend
|
|
44
|
+
cls._prefix = prefix
|
|
45
|
+
cls._expire = expire
|
|
46
|
+
cls._coder = coder
|
|
47
|
+
cls._key_builder = key_builder
|
|
48
|
+
cls._cache_status_header = cache_status_header
|
|
49
|
+
cls._enable = enable
|
|
50
|
+
|
|
51
|
+
@classmethod
|
|
52
|
+
def reset(cls) -> None:
|
|
53
|
+
cls._init = False
|
|
54
|
+
cls._backend = None
|
|
55
|
+
cls._prefix = None
|
|
56
|
+
cls._expire = None
|
|
57
|
+
cls._coder = None
|
|
58
|
+
cls._key_builder = None
|
|
59
|
+
cls._cache_status_header = None
|
|
60
|
+
cls._enable = True
|
|
61
|
+
|
|
62
|
+
@classmethod
|
|
63
|
+
def get_backend(cls) -> Backend:
|
|
64
|
+
assert cls._backend, "You must call init first!" # noqa: S101
|
|
65
|
+
return cls._backend
|
|
66
|
+
|
|
67
|
+
@classmethod
|
|
68
|
+
def get_prefix(cls) -> str:
|
|
69
|
+
assert cls._prefix is not None, "You must call init first!" # noqa: S101
|
|
70
|
+
return cls._prefix
|
|
71
|
+
|
|
72
|
+
@classmethod
|
|
73
|
+
def get_expire(cls) -> Optional[int]:
|
|
74
|
+
return cls._expire
|
|
75
|
+
|
|
76
|
+
@classmethod
|
|
77
|
+
def get_coder(cls) -> Type[Coder]:
|
|
78
|
+
assert cls._coder, "You must call init first!" # noqa: S101
|
|
79
|
+
return cls._coder
|
|
80
|
+
|
|
81
|
+
@classmethod
|
|
82
|
+
def get_key_builder(cls) -> KeyBuilder:
|
|
83
|
+
assert cls._key_builder, "You must call init first!" # noqa: S101
|
|
84
|
+
return cls._key_builder
|
|
85
|
+
|
|
86
|
+
@classmethod
|
|
87
|
+
def get_cache_status_header(cls) -> str:
|
|
88
|
+
assert cls._cache_status_header, "You must call init first!" # noqa: S101
|
|
89
|
+
return cls._cache_status_header
|
|
90
|
+
|
|
91
|
+
@classmethod
|
|
92
|
+
def get_enable(cls) -> bool:
|
|
93
|
+
return cls._enable
|
|
94
|
+
|
|
95
|
+
@classmethod
|
|
96
|
+
async def clear(
|
|
97
|
+
cls, namespace: Optional[str] = None, key: Optional[str] = None
|
|
98
|
+
) -> int:
|
|
99
|
+
assert ( # noqa: S101
|
|
100
|
+
cls._backend and cls._prefix is not None
|
|
101
|
+
), "You must call init first!"
|
|
102
|
+
namespace = cls._prefix + (":" + namespace if namespace else "")
|
|
103
|
+
return await cls._backend.clear(namespace, key)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
from fastapi_cache.backends import inmemory
|
|
2
|
+
from fastapi_cache.types import Backend
|
|
3
|
+
|
|
4
|
+
__all__ = ["Backend", "inmemory"]
|
|
5
|
+
|
|
6
|
+
# import each backend in turn and add to __all__. This syntax
|
|
7
|
+
# is explicitly supported by type checkers, while more dynamic
|
|
8
|
+
# syntax would not be recognised.
|
|
9
|
+
try:
|
|
10
|
+
from fastapi_cache.backends import dynamodb
|
|
11
|
+
except ImportError:
|
|
12
|
+
pass
|
|
13
|
+
else:
|
|
14
|
+
__all__ += ["dynamodb"]
|
|
15
|
+
|
|
16
|
+
try:
|
|
17
|
+
from fastapi_cache.backends import memcached
|
|
18
|
+
except ImportError:
|
|
19
|
+
pass
|
|
20
|
+
else:
|
|
21
|
+
__all__ += ["memcached"]
|
|
22
|
+
|
|
23
|
+
try:
|
|
24
|
+
from fastapi_cache.backends import redis
|
|
25
|
+
except ImportError:
|
|
26
|
+
pass
|
|
27
|
+
else:
|
|
28
|
+
__all__ += ["redis"]
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import datetime
|
|
2
|
+
from typing import TYPE_CHECKING, Optional, Tuple
|
|
3
|
+
|
|
4
|
+
from aiobotocore.client import AioBaseClient
|
|
5
|
+
from aiobotocore.session import AioSession, get_session
|
|
6
|
+
|
|
7
|
+
from fastapi_cache.types import Backend
|
|
8
|
+
|
|
9
|
+
if TYPE_CHECKING:
|
|
10
|
+
from types_aiobotocore_dynamodb import DynamoDBClient
|
|
11
|
+
else:
|
|
12
|
+
DynamoDBClient = AioBaseClient
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class DynamoBackend(Backend):
|
|
16
|
+
"""
|
|
17
|
+
Amazon DynamoDB backend provider
|
|
18
|
+
|
|
19
|
+
This backend requires an existing table within your AWS environment to be passed during
|
|
20
|
+
backend init. If ttl is going to be used, this needs to be manually enabled on the table
|
|
21
|
+
using the `ttl` key. Dynamo will take care of deleting outdated objects, but this is not
|
|
22
|
+
instant so don't be alarmed when they linger around for a bit.
|
|
23
|
+
|
|
24
|
+
As with all AWS clients, credentials will be taken from the environment. Check the AWS SDK
|
|
25
|
+
for more information.
|
|
26
|
+
|
|
27
|
+
Usage:
|
|
28
|
+
>> dynamodb = DynamoBackend(table_name="your-cache", region="eu-west-1")
|
|
29
|
+
>> await dynamodb.init()
|
|
30
|
+
>> FastAPICache.init(dynamodb)
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
client: DynamoDBClient
|
|
34
|
+
session: AioSession
|
|
35
|
+
table_name: str
|
|
36
|
+
region: Optional[str]
|
|
37
|
+
|
|
38
|
+
def __init__(self, table_name: str, region: Optional[str] = None) -> None:
|
|
39
|
+
self.session: AioSession = get_session()
|
|
40
|
+
self.table_name = table_name
|
|
41
|
+
self.region = region
|
|
42
|
+
|
|
43
|
+
async def init(self) -> None:
|
|
44
|
+
self.client = await self.session.create_client( # pyright: ignore[reportUnknownMemberType]
|
|
45
|
+
"dynamodb", region_name=self.region
|
|
46
|
+
).__aenter__()
|
|
47
|
+
|
|
48
|
+
async def close(self) -> None:
|
|
49
|
+
self.client = await self.client.__aexit__(None, None, None)
|
|
50
|
+
|
|
51
|
+
async def get_with_ttl(self, key: str) -> Tuple[int, Optional[bytes]]:
|
|
52
|
+
response = await self.client.get_item(TableName=self.table_name, Key={"key": {"S": key}})
|
|
53
|
+
|
|
54
|
+
if "Item" in response:
|
|
55
|
+
value = response["Item"].get("value", {}).get("B")
|
|
56
|
+
ttl = response["Item"].get("ttl", {}).get("N")
|
|
57
|
+
|
|
58
|
+
if not ttl:
|
|
59
|
+
return -1, value
|
|
60
|
+
|
|
61
|
+
# It's only eventually consistent so we need to check ourselves
|
|
62
|
+
expire = int(ttl) - int(datetime.datetime.now().timestamp())
|
|
63
|
+
if expire > 0:
|
|
64
|
+
return expire, value
|
|
65
|
+
|
|
66
|
+
return 0, None
|
|
67
|
+
|
|
68
|
+
async def get(self, key: str) -> Optional[bytes]:
|
|
69
|
+
response = await self.client.get_item(TableName=self.table_name, Key={"key": {"S": key}})
|
|
70
|
+
if "Item" in response:
|
|
71
|
+
return response["Item"].get("value", {}).get("B")
|
|
72
|
+
return None
|
|
73
|
+
|
|
74
|
+
async def set(self, key: str, value: bytes, expire: Optional[int] = None) -> None:
|
|
75
|
+
ttl = (
|
|
76
|
+
{
|
|
77
|
+
"ttl": {
|
|
78
|
+
"N": str(
|
|
79
|
+
int(
|
|
80
|
+
(
|
|
81
|
+
datetime.datetime.now() + datetime.timedelta(seconds=expire)
|
|
82
|
+
).timestamp()
|
|
83
|
+
)
|
|
84
|
+
)
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
if expire
|
|
88
|
+
else {}
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
await self.client.put_item(
|
|
92
|
+
TableName=self.table_name,
|
|
93
|
+
Item={
|
|
94
|
+
**{
|
|
95
|
+
"key": {"S": key},
|
|
96
|
+
"value": {"B": value},
|
|
97
|
+
},
|
|
98
|
+
**ttl,
|
|
99
|
+
},
|
|
100
|
+
)
|
|
101
|
+
|
|
102
|
+
async def clear(self, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
103
|
+
raise NotImplementedError
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import time
|
|
2
|
+
from asyncio import Lock
|
|
3
|
+
from dataclasses import dataclass
|
|
4
|
+
from typing import Dict, Optional, Tuple
|
|
5
|
+
|
|
6
|
+
from fastapi_cache.types import Backend
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@dataclass
|
|
10
|
+
class Value:
|
|
11
|
+
data: bytes
|
|
12
|
+
ttl_ts: int
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class InMemoryBackend(Backend):
|
|
16
|
+
_store: Dict[str, Value] = {}
|
|
17
|
+
_lock = Lock()
|
|
18
|
+
|
|
19
|
+
@property
|
|
20
|
+
def _now(self) -> int:
|
|
21
|
+
return int(time.time())
|
|
22
|
+
|
|
23
|
+
def _get(self, key: str) -> Optional[Value]:
|
|
24
|
+
v = self._store.get(key)
|
|
25
|
+
if v:
|
|
26
|
+
if v.ttl_ts < self._now:
|
|
27
|
+
del self._store[key]
|
|
28
|
+
else:
|
|
29
|
+
return v
|
|
30
|
+
return None
|
|
31
|
+
|
|
32
|
+
async def get_with_ttl(self, key: str) -> Tuple[int, Optional[bytes]]:
|
|
33
|
+
async with self._lock:
|
|
34
|
+
v = self._get(key)
|
|
35
|
+
if v:
|
|
36
|
+
return v.ttl_ts - self._now, v.data
|
|
37
|
+
return 0, None
|
|
38
|
+
|
|
39
|
+
async def get(self, key: str) -> Optional[bytes]:
|
|
40
|
+
async with self._lock:
|
|
41
|
+
v = self._get(key)
|
|
42
|
+
if v:
|
|
43
|
+
return v.data
|
|
44
|
+
return None
|
|
45
|
+
|
|
46
|
+
async def set(self, key: str, value: bytes, expire: Optional[int] = None) -> None:
|
|
47
|
+
async with self._lock:
|
|
48
|
+
self._store[key] = Value(value, self._now + (expire or 0))
|
|
49
|
+
|
|
50
|
+
async def clear(self, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
51
|
+
count = 0
|
|
52
|
+
if namespace:
|
|
53
|
+
keys = list(self._store.keys())
|
|
54
|
+
for key in keys:
|
|
55
|
+
if key.startswith(namespace):
|
|
56
|
+
del self._store[key]
|
|
57
|
+
count += 1
|
|
58
|
+
elif key:
|
|
59
|
+
del self._store[key]
|
|
60
|
+
count += 1
|
|
61
|
+
return count
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from typing import Optional, Tuple
|
|
2
|
+
|
|
3
|
+
from aiomcache import Client
|
|
4
|
+
|
|
5
|
+
from fastapi_cache.types import Backend
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class MemcachedBackend(Backend):
|
|
9
|
+
def __init__(self, mcache: Client):
|
|
10
|
+
self.mcache = mcache
|
|
11
|
+
|
|
12
|
+
async def get_with_ttl(self, key: str) -> Tuple[int, Optional[bytes]]:
|
|
13
|
+
return 3600, await self.get(key)
|
|
14
|
+
|
|
15
|
+
async def get(self, key: str) -> Optional[bytes]:
|
|
16
|
+
return await self.mcache.get(key.encode())
|
|
17
|
+
|
|
18
|
+
async def set(self, key: str, value: bytes, expire: Optional[int] = None) -> None:
|
|
19
|
+
await self.mcache.set(key.encode(), value, exptime=expire or 0)
|
|
20
|
+
|
|
21
|
+
async def clear(self, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
22
|
+
raise NotImplementedError
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
from typing import Optional, Tuple, Union
|
|
2
|
+
|
|
3
|
+
from redis.asyncio.client import Redis
|
|
4
|
+
from redis.asyncio.cluster import RedisCluster
|
|
5
|
+
|
|
6
|
+
from fastapi_cache.types import Backend
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class RedisBackend(Backend):
|
|
10
|
+
def __init__(self, redis: Union["Redis[bytes]", "RedisCluster[bytes]"]):
|
|
11
|
+
self.redis = redis
|
|
12
|
+
self.is_cluster: bool = isinstance(redis, RedisCluster)
|
|
13
|
+
|
|
14
|
+
async def get_with_ttl(self, key: str) -> Tuple[int, Optional[bytes]]:
|
|
15
|
+
async with self.redis.pipeline(transaction=not self.is_cluster) as pipe:
|
|
16
|
+
return await pipe.ttl(key).get(key).execute() # type: ignore[union-attr,no-any-return]
|
|
17
|
+
|
|
18
|
+
async def get(self, key: str) -> Optional[bytes]:
|
|
19
|
+
return await self.redis.get(key) # type: ignore[union-attr]
|
|
20
|
+
|
|
21
|
+
async def set(self, key: str, value: bytes, expire: Optional[int] = None) -> None:
|
|
22
|
+
await self.redis.set(key, value, ex=expire) # type: ignore[union-attr]
|
|
23
|
+
|
|
24
|
+
async def clear(self, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
25
|
+
if namespace:
|
|
26
|
+
lua = f"for i, name in ipairs(redis.call('KEYS', '{namespace}:*')) do redis.call('DEL', name); end"
|
|
27
|
+
return await self.redis.eval(lua, numkeys=0) # type: ignore[union-attr,no-any-return]
|
|
28
|
+
elif key:
|
|
29
|
+
return await self.redis.delete(key) # type: ignore[union-attr]
|
|
30
|
+
return 0
|
fastapi_cache/coder.py
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import datetime
|
|
2
|
+
import json
|
|
3
|
+
import pickle # nosec:B403
|
|
4
|
+
from decimal import Decimal
|
|
5
|
+
from typing import (
|
|
6
|
+
Any,
|
|
7
|
+
Callable,
|
|
8
|
+
ClassVar,
|
|
9
|
+
Dict,
|
|
10
|
+
Optional,
|
|
11
|
+
TypeVar,
|
|
12
|
+
Union,
|
|
13
|
+
overload,
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
import pendulum
|
|
17
|
+
from fastapi.encoders import jsonable_encoder
|
|
18
|
+
from starlette.responses import JSONResponse
|
|
19
|
+
from starlette.templating import (
|
|
20
|
+
_TemplateResponse as TemplateResponse, # pyright: ignore[reportPrivateUsage]
|
|
21
|
+
)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
class ModelField:
|
|
25
|
+
pass
|
|
26
|
+
|
|
27
|
+
_T = TypeVar("_T", bound=type)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
CONVERTERS: Dict[str, Callable[[str], Any]] = {
|
|
31
|
+
# Pendulum 3.0.0 adds parse to __all__, at which point these ignores can be removed
|
|
32
|
+
"date": lambda x: pendulum.parse(x, exact=True),
|
|
33
|
+
"datetime": lambda x: pendulum.parse(x, exact=True),
|
|
34
|
+
"decimal": Decimal,
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
class JsonEncoder(json.JSONEncoder):
|
|
39
|
+
def default(self, o: Any) -> Any:
|
|
40
|
+
if isinstance(o, datetime.datetime):
|
|
41
|
+
return {"val": str(o), "_spec_type": "datetime"}
|
|
42
|
+
elif isinstance(o, datetime.date):
|
|
43
|
+
return {"val": str(o), "_spec_type": "date"}
|
|
44
|
+
elif isinstance(o, Decimal):
|
|
45
|
+
return {"val": str(o), "_spec_type": "decimal"}
|
|
46
|
+
else:
|
|
47
|
+
return jsonable_encoder(o)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
def object_hook(obj: Any) -> Any:
|
|
51
|
+
_spec_type = obj.get("_spec_type")
|
|
52
|
+
if not _spec_type:
|
|
53
|
+
return obj
|
|
54
|
+
|
|
55
|
+
if _spec_type in CONVERTERS:
|
|
56
|
+
return CONVERTERS[_spec_type](obj["val"])
|
|
57
|
+
else:
|
|
58
|
+
raise TypeError(f"Unknown {_spec_type}")
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
class Coder:
|
|
62
|
+
@classmethod
|
|
63
|
+
def encode(cls, value: Any) -> bytes:
|
|
64
|
+
raise NotImplementedError
|
|
65
|
+
|
|
66
|
+
@classmethod
|
|
67
|
+
def decode(cls, value: bytes) -> Any:
|
|
68
|
+
raise NotImplementedError
|
|
69
|
+
|
|
70
|
+
# (Shared) cache for endpoint return types to Pydantic model fields.
|
|
71
|
+
# Note that subclasses share this cache! If a subclass overrides the
|
|
72
|
+
# decode_as_type method and then stores a different kind of field for a
|
|
73
|
+
# given type, do make sure that the subclass provides its own class
|
|
74
|
+
# attribute for this cache.
|
|
75
|
+
_type_field_cache: ClassVar[Dict[Any, ModelField]] = {}
|
|
76
|
+
|
|
77
|
+
@overload
|
|
78
|
+
@classmethod
|
|
79
|
+
def decode_as_type(cls, value: bytes, *, type_: _T) -> _T:
|
|
80
|
+
...
|
|
81
|
+
|
|
82
|
+
@overload
|
|
83
|
+
@classmethod
|
|
84
|
+
def decode_as_type(cls, value: bytes, *, type_: None) -> Any:
|
|
85
|
+
...
|
|
86
|
+
|
|
87
|
+
@classmethod
|
|
88
|
+
def decode_as_type(cls, value: bytes, *, type_: Optional[_T]) -> Union[_T, Any]:
|
|
89
|
+
"""Decode value to the specific given type
|
|
90
|
+
|
|
91
|
+
The default implementation uses the Pydantic model system to convert the value.
|
|
92
|
+
|
|
93
|
+
"""
|
|
94
|
+
result = cls.decode(value)
|
|
95
|
+
return result
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
class JsonCoder(Coder):
|
|
99
|
+
@classmethod
|
|
100
|
+
def encode(cls, value: Any) -> bytes:
|
|
101
|
+
if isinstance(value, JSONResponse):
|
|
102
|
+
return value.body
|
|
103
|
+
return json.dumps(value, cls=JsonEncoder).encode()
|
|
104
|
+
|
|
105
|
+
@classmethod
|
|
106
|
+
def decode(cls, value: bytes) -> Any:
|
|
107
|
+
# explicitly decode from UTF-8 bytes first, as otherwise
|
|
108
|
+
# json.loads() will first have to detect the correct UTF-
|
|
109
|
+
# encoding used.
|
|
110
|
+
return json.loads(value.decode(), object_hook=object_hook)
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
class PickleCoder(Coder):
|
|
114
|
+
@classmethod
|
|
115
|
+
def encode(cls, value: Any) -> bytes:
|
|
116
|
+
if isinstance(value, TemplateResponse):
|
|
117
|
+
value = value.body
|
|
118
|
+
return pickle.dumps(value)
|
|
119
|
+
|
|
120
|
+
@classmethod
|
|
121
|
+
def decode(cls, value: bytes) -> Any:
|
|
122
|
+
return pickle.loads(value) # noqa: S301
|
|
123
|
+
|
|
124
|
+
@classmethod
|
|
125
|
+
def decode_as_type(cls, value: bytes, *, type_: Optional[_T]) -> Any:
|
|
126
|
+
# Pickle already produces the correct type on decoding, no point
|
|
127
|
+
# in paying an extra performance penalty for pydantic to discover
|
|
128
|
+
# the same.
|
|
129
|
+
return cls.decode(value)
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
import sys
|
|
3
|
+
from functools import wraps
|
|
4
|
+
from inspect import Parameter, Signature, isawaitable, iscoroutinefunction
|
|
5
|
+
from typing import (
|
|
6
|
+
Awaitable,
|
|
7
|
+
Callable,
|
|
8
|
+
List,
|
|
9
|
+
Optional,
|
|
10
|
+
Type,
|
|
11
|
+
TypeVar,
|
|
12
|
+
Union,
|
|
13
|
+
cast,
|
|
14
|
+
)
|
|
15
|
+
|
|
16
|
+
if sys.version_info >= (3, 10):
|
|
17
|
+
from typing import ParamSpec
|
|
18
|
+
else:
|
|
19
|
+
from typing_extensions import ParamSpec
|
|
20
|
+
|
|
21
|
+
from fastapi.concurrency import run_in_threadpool
|
|
22
|
+
from fastapi.dependencies.utils import (
|
|
23
|
+
get_typed_return_annotation,
|
|
24
|
+
get_typed_signature,
|
|
25
|
+
)
|
|
26
|
+
from starlette.requests import Request
|
|
27
|
+
from starlette.responses import Response
|
|
28
|
+
from starlette.status import HTTP_304_NOT_MODIFIED
|
|
29
|
+
|
|
30
|
+
from fastapi_cache import FastAPICache
|
|
31
|
+
from fastapi_cache.coder import Coder
|
|
32
|
+
from fastapi_cache.types import KeyBuilder
|
|
33
|
+
|
|
34
|
+
logger: logging.Logger = logging.getLogger(__name__)
|
|
35
|
+
logger.addHandler(logging.NullHandler())
|
|
36
|
+
P = ParamSpec("P")
|
|
37
|
+
R = TypeVar("R")
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
def _augment_signature(signature: Signature, *extra: Parameter) -> Signature:
|
|
41
|
+
if not extra:
|
|
42
|
+
return signature
|
|
43
|
+
|
|
44
|
+
parameters = list(signature.parameters.values())
|
|
45
|
+
variadic_keyword_params: List[Parameter] = []
|
|
46
|
+
while parameters and parameters[-1].kind is Parameter.VAR_KEYWORD:
|
|
47
|
+
variadic_keyword_params.append(parameters.pop())
|
|
48
|
+
|
|
49
|
+
return signature.replace(parameters=[*parameters, *extra, *variadic_keyword_params])
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def _locate_param(
|
|
53
|
+
sig: Signature, dep: Parameter, to_inject: List[Parameter]
|
|
54
|
+
) -> Parameter:
|
|
55
|
+
"""Locate an existing parameter in the decorated endpoint
|
|
56
|
+
|
|
57
|
+
If not found, returns the injectable parameter, and adds it to the to_inject list.
|
|
58
|
+
|
|
59
|
+
"""
|
|
60
|
+
param = next(
|
|
61
|
+
(p for p in sig.parameters.values() if p.annotation is dep.annotation), None
|
|
62
|
+
)
|
|
63
|
+
if param is None:
|
|
64
|
+
to_inject.append(dep)
|
|
65
|
+
param = dep
|
|
66
|
+
return param
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def _uncacheable(request: Optional[Request]) -> bool:
|
|
70
|
+
"""Determine if this request should not be cached
|
|
71
|
+
|
|
72
|
+
Returns true if:
|
|
73
|
+
- Caching has been disabled globally
|
|
74
|
+
- This is not a GET request
|
|
75
|
+
- The request has a Cache-Control header with a value of "no-store"
|
|
76
|
+
|
|
77
|
+
"""
|
|
78
|
+
if not FastAPICache.get_enable():
|
|
79
|
+
return True
|
|
80
|
+
if request is None:
|
|
81
|
+
return False
|
|
82
|
+
if request.method != "GET":
|
|
83
|
+
return True
|
|
84
|
+
return request.headers.get("Cache-Control") == "no-store"
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
def cache(
|
|
88
|
+
expire: Optional[int] = None,
|
|
89
|
+
coder: Optional[Type[Coder]] = None,
|
|
90
|
+
key_builder: Optional[KeyBuilder] = None,
|
|
91
|
+
namespace: str = "",
|
|
92
|
+
injected_dependency_namespace: str = "__fastapi_cache",
|
|
93
|
+
) -> Callable[[Callable[P, Awaitable[R]]], Callable[P, Awaitable[Union[R, Response]]]]:
|
|
94
|
+
"""
|
|
95
|
+
cache all function
|
|
96
|
+
:param injected_dependency_namespace:
|
|
97
|
+
:param namespace:
|
|
98
|
+
:param expire:
|
|
99
|
+
:param coder:
|
|
100
|
+
:param key_builder:
|
|
101
|
+
|
|
102
|
+
:return:
|
|
103
|
+
"""
|
|
104
|
+
|
|
105
|
+
injected_request = Parameter(
|
|
106
|
+
name=f"{injected_dependency_namespace}_request",
|
|
107
|
+
annotation=Request,
|
|
108
|
+
kind=Parameter.KEYWORD_ONLY,
|
|
109
|
+
)
|
|
110
|
+
injected_response = Parameter(
|
|
111
|
+
name=f"{injected_dependency_namespace}_response",
|
|
112
|
+
annotation=Response,
|
|
113
|
+
kind=Parameter.KEYWORD_ONLY,
|
|
114
|
+
)
|
|
115
|
+
|
|
116
|
+
def wrapper(
|
|
117
|
+
func: Callable[P, Awaitable[R]]
|
|
118
|
+
) -> Callable[P, Awaitable[Union[R, Response]]]:
|
|
119
|
+
# get_typed_signature ensures that any forward references are resolved first
|
|
120
|
+
wrapped_signature = get_typed_signature(func)
|
|
121
|
+
to_inject: List[Parameter] = []
|
|
122
|
+
request_param = _locate_param(wrapped_signature, injected_request, to_inject)
|
|
123
|
+
response_param = _locate_param(wrapped_signature, injected_response, to_inject)
|
|
124
|
+
return_type = get_typed_return_annotation(func)
|
|
125
|
+
|
|
126
|
+
@wraps(func)
|
|
127
|
+
async def inner(*args: P.args, **kwargs: P.kwargs) -> Union[R, Response]:
|
|
128
|
+
nonlocal coder
|
|
129
|
+
nonlocal expire
|
|
130
|
+
nonlocal key_builder
|
|
131
|
+
|
|
132
|
+
async def ensure_async_func(*args: P.args, **kwargs: P.kwargs) -> R:
|
|
133
|
+
"""Run cached sync functions in thread pool just like FastAPI."""
|
|
134
|
+
# if the wrapped function does NOT have request or response in
|
|
135
|
+
# its function signature, make sure we don't pass them in as
|
|
136
|
+
# keyword arguments
|
|
137
|
+
kwargs.pop(injected_request.name, None)
|
|
138
|
+
kwargs.pop(injected_response.name, None)
|
|
139
|
+
|
|
140
|
+
if iscoroutinefunction(func):
|
|
141
|
+
# async, return as is.
|
|
142
|
+
# unintuitively, we have to await once here, so that caller
|
|
143
|
+
# does not have to await twice. See
|
|
144
|
+
# https://stackoverflow.com/a/59268198/532513
|
|
145
|
+
return await func(*args, **kwargs)
|
|
146
|
+
else:
|
|
147
|
+
# sync, wrap in thread and return async
|
|
148
|
+
# see above why we have to await even although caller also awaits.
|
|
149
|
+
return await run_in_threadpool(func, *args, **kwargs) # type: ignore[arg-type]
|
|
150
|
+
|
|
151
|
+
copy_kwargs = kwargs.copy()
|
|
152
|
+
request: Optional[Request] = copy_kwargs.pop(request_param.name, None) # type: ignore[assignment]
|
|
153
|
+
response: Optional[Response] = copy_kwargs.pop(response_param.name, None) # type: ignore[assignment]
|
|
154
|
+
|
|
155
|
+
if _uncacheable(request):
|
|
156
|
+
return await ensure_async_func(*args, **kwargs)
|
|
157
|
+
|
|
158
|
+
prefix = FastAPICache.get_prefix()
|
|
159
|
+
coder = coder or FastAPICache.get_coder()
|
|
160
|
+
expire = expire or FastAPICache.get_expire()
|
|
161
|
+
key_builder = key_builder or FastAPICache.get_key_builder()
|
|
162
|
+
backend = FastAPICache.get_backend()
|
|
163
|
+
cache_status_header = FastAPICache.get_cache_status_header()
|
|
164
|
+
|
|
165
|
+
cache_key = key_builder(
|
|
166
|
+
func,
|
|
167
|
+
f"{prefix}:{namespace}",
|
|
168
|
+
request=request,
|
|
169
|
+
response=response,
|
|
170
|
+
args=args,
|
|
171
|
+
kwargs=copy_kwargs,
|
|
172
|
+
)
|
|
173
|
+
if isawaitable(cache_key):
|
|
174
|
+
cache_key = await cache_key
|
|
175
|
+
assert isinstance(cache_key, str) # noqa: S101 # assertion is a type guard
|
|
176
|
+
|
|
177
|
+
try:
|
|
178
|
+
ttl, cached = await backend.get_with_ttl(cache_key)
|
|
179
|
+
except Exception:
|
|
180
|
+
logger.warning(
|
|
181
|
+
f"Error retrieving cache key '{cache_key}' from backend:",
|
|
182
|
+
exc_info=True,
|
|
183
|
+
)
|
|
184
|
+
ttl, cached = 0, None
|
|
185
|
+
|
|
186
|
+
if cached is None or (request is not None and request.headers.get("Cache-Control") == "no-cache") : # cache miss
|
|
187
|
+
result = await ensure_async_func(*args, **kwargs)
|
|
188
|
+
to_cache = coder.encode(result)
|
|
189
|
+
|
|
190
|
+
try:
|
|
191
|
+
await backend.set(cache_key, to_cache, expire)
|
|
192
|
+
except Exception:
|
|
193
|
+
logger.warning(
|
|
194
|
+
f"Error setting cache key '{cache_key}' in backend:",
|
|
195
|
+
exc_info=True,
|
|
196
|
+
)
|
|
197
|
+
|
|
198
|
+
if response:
|
|
199
|
+
response.headers.update(
|
|
200
|
+
{
|
|
201
|
+
"Cache-Control": f"max-age={expire}",
|
|
202
|
+
"ETag": f"W/{hash(to_cache)}",
|
|
203
|
+
cache_status_header: "MISS",
|
|
204
|
+
}
|
|
205
|
+
)
|
|
206
|
+
|
|
207
|
+
else: # cache hit
|
|
208
|
+
if response:
|
|
209
|
+
etag = f"W/{hash(cached)}"
|
|
210
|
+
response.headers.update(
|
|
211
|
+
{
|
|
212
|
+
"Cache-Control": f"max-age={ttl}",
|
|
213
|
+
"ETag": etag,
|
|
214
|
+
cache_status_header: "HIT",
|
|
215
|
+
}
|
|
216
|
+
)
|
|
217
|
+
|
|
218
|
+
if_none_match = request and request.headers.get("if-none-match")
|
|
219
|
+
if if_none_match == etag:
|
|
220
|
+
response.status_code = HTTP_304_NOT_MODIFIED
|
|
221
|
+
return response
|
|
222
|
+
|
|
223
|
+
result = cast(R, coder.decode_as_type(cached, type_=return_type))
|
|
224
|
+
|
|
225
|
+
return result
|
|
226
|
+
|
|
227
|
+
inner.__signature__ = _augment_signature(wrapped_signature, *to_inject) # type: ignore[attr-defined]
|
|
228
|
+
|
|
229
|
+
return inner
|
|
230
|
+
|
|
231
|
+
return wrapper
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import hashlib
|
|
2
|
+
from typing import Any, Callable, Dict, Optional, Tuple
|
|
3
|
+
|
|
4
|
+
from starlette.requests import Request
|
|
5
|
+
from starlette.responses import Response
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def default_key_builder(
|
|
9
|
+
func: Callable[..., Any],
|
|
10
|
+
namespace: str = "",
|
|
11
|
+
*,
|
|
12
|
+
request: Optional[Request] = None,
|
|
13
|
+
response: Optional[Response] = None,
|
|
14
|
+
args: Tuple[Any, ...],
|
|
15
|
+
kwargs: Dict[str, Any],
|
|
16
|
+
) -> str:
|
|
17
|
+
cache_key = hashlib.md5( # noqa: S324
|
|
18
|
+
f"{func.__module__}:{func.__name__}:{args}:{kwargs}".encode()
|
|
19
|
+
).hexdigest()
|
|
20
|
+
return f"{namespace}:{cache_key}"
|
fastapi_cache/py.typed
ADDED
|
File without changes
|
fastapi_cache/types.py
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import abc
|
|
2
|
+
from typing import Any, Awaitable, Callable, Dict, Optional, Tuple, Union
|
|
3
|
+
|
|
4
|
+
from starlette.requests import Request
|
|
5
|
+
from starlette.responses import Response
|
|
6
|
+
from typing_extensions import Protocol
|
|
7
|
+
|
|
8
|
+
_Func = Callable[..., Any]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class KeyBuilder(Protocol):
|
|
12
|
+
def __call__(
|
|
13
|
+
self,
|
|
14
|
+
__function: _Func,
|
|
15
|
+
__namespace: str = ...,
|
|
16
|
+
*,
|
|
17
|
+
request: Optional[Request] = ...,
|
|
18
|
+
response: Optional[Response] = ...,
|
|
19
|
+
args: Tuple[Any, ...],
|
|
20
|
+
kwargs: Dict[str, Any],
|
|
21
|
+
) -> Union[Awaitable[str], str]:
|
|
22
|
+
...
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class Backend(abc.ABC):
|
|
26
|
+
@abc.abstractmethod
|
|
27
|
+
async def get_with_ttl(self, key: str) -> Tuple[int, Optional[bytes]]:
|
|
28
|
+
raise NotImplementedError
|
|
29
|
+
|
|
30
|
+
@abc.abstractmethod
|
|
31
|
+
async def get(self, key: str) -> Optional[bytes]:
|
|
32
|
+
raise NotImplementedError
|
|
33
|
+
|
|
34
|
+
@abc.abstractmethod
|
|
35
|
+
async def set(self, key: str, value: bytes, expire: Optional[int] = None) -> None:
|
|
36
|
+
raise NotImplementedError
|
|
37
|
+
|
|
38
|
+
@abc.abstractmethod
|
|
39
|
+
async def clear(self, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
40
|
+
raise NotImplementedError
|
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fastapi-cache-stable
|
|
3
|
+
Version: 0.3.0a0
|
|
4
|
+
Summary: Community-maintained, drop-in stable fork of fastapi-cache2
|
|
5
|
+
License: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
License-File: NOTICE
|
|
8
|
+
Keywords: fastapi,cache,caching
|
|
9
|
+
Author: Agustin Saiz
|
|
10
|
+
Author-email: agustinsaiz02@gmail.com
|
|
11
|
+
Requires-Python: >=3.8,<4.0
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Framework :: FastAPI
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
24
|
+
Classifier: Typing :: Typed
|
|
25
|
+
Provides-Extra: all
|
|
26
|
+
Provides-Extra: dynamodb
|
|
27
|
+
Provides-Extra: memcache
|
|
28
|
+
Provides-Extra: redis
|
|
29
|
+
Requires-Dist: aiobotocore (>=2.13.1,<3.0.0) ; extra == "dynamodb" or extra == "all"
|
|
30
|
+
Requires-Dist: aiomcache (>=0.8.2,<0.9.0) ; extra == "memcache" or extra == "all"
|
|
31
|
+
Requires-Dist: fastapi
|
|
32
|
+
Requires-Dist: importlib-metadata (>=6.6.0,<7.0.0) ; python_version < "3.8"
|
|
33
|
+
Requires-Dist: jinja2 (>=3.0)
|
|
34
|
+
Requires-Dist: pendulum (>=3.0.0,<4.0.0)
|
|
35
|
+
Requires-Dist: redis (>=4.2.0rc1,<5.0.0) ; extra == "redis" or extra == "all"
|
|
36
|
+
Requires-Dist: typing-extensions (>=4.1.0)
|
|
37
|
+
Requires-Dist: uvicorn
|
|
38
|
+
Project-URL: Documentation, https://github.com/agustin18/fastapi-cache#readme
|
|
39
|
+
Project-URL: Homepage, https://github.com/agustin18/fastapi-cache
|
|
40
|
+
Project-URL: Repository, https://github.com/agustin18/fastapi-cache.git
|
|
41
|
+
Description-Content-Type: text/markdown
|
|
42
|
+
|
|
43
|
+
# fastapi-cache-stable
|
|
44
|
+
|
|
45
|
+
> **Community-maintained stable fork of fastapi-cache2.**
|
|
46
|
+
> This is an alpha (`0.3.0a0`) based on `v0.2.2`. The `fastapi_cache` import and public API are unchanged.
|
|
47
|
+
> See [MIGRATION.md](MIGRATION.md) and [SUPPORT.md](SUPPORT.md). Not affiliated with the original author.
|
|
48
|
+
|
|
49
|
+
[](https://pypi.org/p/fastapi-cache-stable)
|
|
50
|
+
[](https://github.com/agustin18/fastapi-cache/blob/stable/LICENSE)
|
|
51
|
+
[](https://github.com/agustin18/fastapi-cache/actions/workflows/ci-cd.yml)
|
|
52
|
+
|
|
53
|
+
## Introduction
|
|
54
|
+
|
|
55
|
+
`fastapi-cache` is a tool to cache FastAPI endpoint and function results, with
|
|
56
|
+
backends supporting Redis, Memcached, and Amazon DynamoDB.
|
|
57
|
+
|
|
58
|
+
## Features
|
|
59
|
+
|
|
60
|
+
- Supports `redis`, `memcache`, `dynamodb`, and `in-memory` backends.
|
|
61
|
+
- Easy integration with [FastAPI](https://fastapi.tiangolo.com/).
|
|
62
|
+
- Support for HTTP cache headers like `ETag` and `Cache-Control`, as well as conditional `If-Match-None` requests.
|
|
63
|
+
|
|
64
|
+
## Requirements
|
|
65
|
+
|
|
66
|
+
- FastAPI
|
|
67
|
+
- `redis` when using `RedisBackend`.
|
|
68
|
+
- `memcache` when using `MemcacheBackend`.
|
|
69
|
+
- `aiobotocore` when using `DynamoBackend`.
|
|
70
|
+
|
|
71
|
+
## Install
|
|
72
|
+
|
|
73
|
+
```shell
|
|
74
|
+
> pip install fastapi-cache-stable
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
or
|
|
78
|
+
|
|
79
|
+
```shell
|
|
80
|
+
> pip install "fastapi-cache-stable[redis]"
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
or
|
|
84
|
+
|
|
85
|
+
```shell
|
|
86
|
+
> pip install "fastapi-cache-stable[memcache]"
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
or
|
|
90
|
+
|
|
91
|
+
```shell
|
|
92
|
+
> pip install "fastapi-cache-stable[dynamodb]"
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Usage
|
|
96
|
+
|
|
97
|
+
### Quick Start
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
from collections.abc import AsyncIterator
|
|
101
|
+
from contextlib import asynccontextmanager
|
|
102
|
+
|
|
103
|
+
from fastapi import FastAPI
|
|
104
|
+
from starlette.requests import Request
|
|
105
|
+
from starlette.responses import Response
|
|
106
|
+
|
|
107
|
+
from fastapi_cache import FastAPICache
|
|
108
|
+
from fastapi_cache.backends.redis import RedisBackend
|
|
109
|
+
from fastapi_cache.decorator import cache
|
|
110
|
+
|
|
111
|
+
from redis import asyncio as aioredis
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
@asynccontextmanager
|
|
115
|
+
async def lifespan(_: FastAPI) -> AsyncIterator[None]:
|
|
116
|
+
redis = aioredis.from_url("redis://localhost")
|
|
117
|
+
FastAPICache.init(RedisBackend(redis), prefix="fastapi-cache")
|
|
118
|
+
yield
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
app = FastAPI(lifespan=lifespan)
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
@cache()
|
|
125
|
+
async def get_cache():
|
|
126
|
+
return 1
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
@app.get("/")
|
|
130
|
+
@cache(expire=60)
|
|
131
|
+
async def index():
|
|
132
|
+
return dict(hello="world")
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Initialization
|
|
136
|
+
|
|
137
|
+
First you must call `FastAPICache.init` during startup FastAPI startup; this is where you set global configuration.
|
|
138
|
+
|
|
139
|
+
### Use the `@cache` decorator
|
|
140
|
+
|
|
141
|
+
If you want cache a FastAPI response transparently, you can use the `@cache`
|
|
142
|
+
decorator between the router decorator and the view function.
|
|
143
|
+
|
|
144
|
+
Parameter | type | default | description
|
|
145
|
+
------------ | ----| --------- | --------
|
|
146
|
+
`expire` | `int` | | sets the caching time in seconds
|
|
147
|
+
`namespace` | `str` | `""` | namespace to use to store certain cache items
|
|
148
|
+
`coder` | `Coder` | `JsonCoder` | which coder to use, e.g. `JsonCoder`
|
|
149
|
+
`key_builder` | `KeyBuilder` callable | `default_key_builder` | which key builder to use
|
|
150
|
+
`injected_dependency_namespace` | `str` | `__fastapi_cache` | prefix for injected dependency keywords.
|
|
151
|
+
`cache_status_header` | `str` | `X-FastAPI-Cache` | Name for the header on the response indicating if the request was served from cache; either `HIT` or `MISS`.
|
|
152
|
+
|
|
153
|
+
You can also use the `@cache` decorator on regular functions to cache their result.
|
|
154
|
+
|
|
155
|
+
### Injected Request and Response dependencies
|
|
156
|
+
|
|
157
|
+
The `cache` decorator injects dependencies for the `Request` and `Response`
|
|
158
|
+
objects, so that it can add cache control headers to the outgoing response, and
|
|
159
|
+
return a 304 Not Modified response when the incoming request has a matching
|
|
160
|
+
`If-Non-Match` header. This only happens if the decorated endpoint doesn't already
|
|
161
|
+
list these dependencies already.
|
|
162
|
+
|
|
163
|
+
The keyword arguments for these extra dependencies are named
|
|
164
|
+
`__fastapi_cache_request` and `__fastapi_cache_response` to minimize collisions.
|
|
165
|
+
Use the `injected_dependency_namespace` argument to `@cache` to change the
|
|
166
|
+
prefix used if those names would clash anyway.
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### Supported data types
|
|
170
|
+
|
|
171
|
+
When using the (default) `JsonCoder`, the cache can store any data type that FastAPI can convert to JSON, including Pydantic models and dataclasses,
|
|
172
|
+
_provided_ that your endpoint has a correct return type annotation. An
|
|
173
|
+
annotation is not needed if the return type is a standard JSON-supported Python
|
|
174
|
+
type such as a dictionary or a list.
|
|
175
|
+
|
|
176
|
+
E.g. for an endpoint that returns a Pydantic model named `SomeModel`, the return annotation is used to ensure that the cached result is converted back to the correct class:
|
|
177
|
+
|
|
178
|
+
```python
|
|
179
|
+
from .models import SomeModel, create_some_model
|
|
180
|
+
|
|
181
|
+
@app.get("/foo")
|
|
182
|
+
@cache(expire=60)
|
|
183
|
+
async def foo() -> SomeModel:
|
|
184
|
+
return create_some_model()
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
It is not sufficient to configure a response model in the route decorator; the cache needs to know what the method itself returns. If no return type decorator is given, the primitive JSON type is returned instead.
|
|
188
|
+
|
|
189
|
+
For broader type support, use the `fastapi_cache.coder.PickleCoder` or implement a custom coder (see below).
|
|
190
|
+
|
|
191
|
+
### Custom coder
|
|
192
|
+
|
|
193
|
+
By default use `JsonCoder`, you can write custom coder to encode and decode cache result, just need
|
|
194
|
+
inherit `fastapi_cache.coder.Coder`.
|
|
195
|
+
|
|
196
|
+
```python
|
|
197
|
+
from typing import Any
|
|
198
|
+
import orjson
|
|
199
|
+
from fastapi.encoders import jsonable_encoder
|
|
200
|
+
from fastapi_cache import Coder
|
|
201
|
+
|
|
202
|
+
class ORJsonCoder(Coder):
|
|
203
|
+
@classmethod
|
|
204
|
+
def encode(cls, value: Any) -> bytes:
|
|
205
|
+
return orjson.dumps(
|
|
206
|
+
value,
|
|
207
|
+
default=jsonable_encoder,
|
|
208
|
+
option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY,
|
|
209
|
+
)
|
|
210
|
+
|
|
211
|
+
@classmethod
|
|
212
|
+
def decode(cls, value: bytes) -> Any:
|
|
213
|
+
return orjson.loads(value)
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
@app.get("/")
|
|
217
|
+
@cache(expire=60, coder=ORJsonCoder)
|
|
218
|
+
async def index():
|
|
219
|
+
return dict(hello="world")
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Custom key builder
|
|
223
|
+
|
|
224
|
+
By default the `default_key_builder` builtin key builder is used; this creates a
|
|
225
|
+
cache key from the function module and name, and the positional and keyword
|
|
226
|
+
arguments converted to their `repr()` representations, encoded as a MD5 hash.
|
|
227
|
+
You can provide your own by passing a key builder in to `@cache()`, or to
|
|
228
|
+
`FastAPICache.init()` to apply globally.
|
|
229
|
+
|
|
230
|
+
For example, if you wanted to use the request method, URL and query string as a cache key instead of the function identifier you could use:
|
|
231
|
+
|
|
232
|
+
```python
|
|
233
|
+
def request_key_builder(
|
|
234
|
+
func,
|
|
235
|
+
namespace: str = "",
|
|
236
|
+
*,
|
|
237
|
+
request: Request = None,
|
|
238
|
+
response: Response = None,
|
|
239
|
+
*args,
|
|
240
|
+
**kwargs,
|
|
241
|
+
):
|
|
242
|
+
return ":".join([
|
|
243
|
+
namespace,
|
|
244
|
+
request.method.lower(),
|
|
245
|
+
request.url.path,
|
|
246
|
+
repr(sorted(request.query_params.items()))
|
|
247
|
+
])
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
@app.get("/")
|
|
251
|
+
@cache(expire=60, key_builder=request_key_builder)
|
|
252
|
+
async def index():
|
|
253
|
+
return dict(hello="world")
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Backend notes
|
|
257
|
+
|
|
258
|
+
### InMemoryBackend
|
|
259
|
+
|
|
260
|
+
The `InMemoryBackend` stores cache data in memory and only deletes when an
|
|
261
|
+
expired key is accessed. This means that if you don't access a function after
|
|
262
|
+
data has been cached, the data will not be removed automatically.
|
|
263
|
+
|
|
264
|
+
### RedisBackend
|
|
265
|
+
|
|
266
|
+
When using the Redis backend, please make sure you pass in a redis client that does [_not_ decode responses][redis-decode] (`decode_responses` **must** be `False`, which is the default). Cached data is stored as `bytes` (binary), decoding these in the Redis client would break caching.
|
|
267
|
+
|
|
268
|
+
[redis-decode]: https://redis-py.readthedocs.io/en/latest/examples/connection_examples.html#by-default-Redis-return-binary-responses,-to-decode-them-use-decode_responses=True
|
|
269
|
+
|
|
270
|
+
## Tests and coverage
|
|
271
|
+
|
|
272
|
+
```shell
|
|
273
|
+
coverage run -m pytest
|
|
274
|
+
coverage html
|
|
275
|
+
xdg-open htmlcov/index.html
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
## License
|
|
279
|
+
|
|
280
|
+
This project is licensed under the [Apache-2.0](https://github.com/long2ice/fastapi-cache/blob/master/LICENSE) License.
|
|
281
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
fastapi_cache/__init__.py,sha256=Y-JyXq9x7Paw4g3D6Qfjl-cQc2Es5qArGPA82FixdOQ,3126
|
|
2
|
+
fastapi_cache/backends/__init__.py,sha256=ET0t_S9WZy7_vNdZ6GrfZjcxY5AzaiXRTKWMCv-v3OM,625
|
|
3
|
+
fastapi_cache/backends/dynamodb.py,sha256=rY0kRasGeHOfIUMNf3eAk6vF52RvPP4nKfSFJqfxeSc,3430
|
|
4
|
+
fastapi_cache/backends/inmemory.py,sha256=f3H7MVX8yBGm1lAKm4F0c9ETO-HcrcJHvA1s2ZjGwrs,1641
|
|
5
|
+
fastapi_cache/backends/memcached.py,sha256=Ih8c34L3fHI1ECtkSRRpns32B3ZeewqzDBrIWjcgUQc,722
|
|
6
|
+
fastapi_cache/backends/redis.py,sha256=bIHxsY9AGWrTd8_fEJSLJi7JGzTH6ORrLzT-m2Xkd5k,1357
|
|
7
|
+
fastapi_cache/coder.py,sha256=CYqx8mUrCeEk9T8GX8euwEjheKQ2qOgPrm-oWP0X5ho,3683
|
|
8
|
+
fastapi_cache/decorator.py,sha256=Mo7aaqU-YSyEXs1QlES7GZUjw9aRGvNkl4VFDFUthDw,8136
|
|
9
|
+
fastapi_cache/key_builder.py,sha256=8ndWNZn7Mcarwjkjm3zYs6kI53kBuss9bqsfXAUrGik,555
|
|
10
|
+
fastapi_cache/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
11
|
+
fastapi_cache/types.py,sha256=FW1zNmDdtC578HCCQiqaZizPPF5L3q2UoBjt_GZL_vI,1134
|
|
12
|
+
fastapi_cache_stable-0.3.0a0.dist-info/METADATA,sha256=xADzUSRSPa0O9YTpFskxRocMsSQDbpxPGgBAjcyQ2ik,9491
|
|
13
|
+
fastapi_cache_stable-0.3.0a0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
|
|
14
|
+
fastapi_cache_stable-0.3.0a0.dist-info/licenses/LICENSE,sha256=TMAPDjOsjgibN9ihR0vkQbJjEb3Bb-A1x1tRIBUV9hc,11338
|
|
15
|
+
fastapi_cache_stable-0.3.0a0.dist-info/licenses/NOTICE,sha256=OjtnYIRn0Hb4tsTGrI9J0HP-_Z7RHUdnfFvYobvNrT4,230
|
|
16
|
+
fastapi_cache_stable-0.3.0a0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2020 long2ice
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|