mirror of
https://github.com/long2ice/fastapi-cache.git
synced 2026-03-25 04:57:54 +00:00
d10f4af6d6
This ensures that any syntax issues are caught early (by type checkers and tests). Backends that are missing dependencies are skipped. By importing, this exposed an issue where the redis type annotations raised an exception, which has been fixed by using forward annotations. To help avoid import dependency hell, the Backend ABC has been moved to `fastapi_cache.types`. In the process, it has been made an actual ABC.
90 lines
2.5 KiB
Python
90 lines
2.5 KiB
Python
from typing import ClassVar, Optional, Type
|
|
|
|
from fastapi_cache.coder import Coder, JsonCoder
|
|
from fastapi_cache.key_builder import default_key_builder
|
|
from fastapi_cache.types import Backend, KeyBuilder
|
|
|
|
|
|
__all__ = [
|
|
"Backend",
|
|
"Coder",
|
|
"FastAPICache",
|
|
"JsonCoder",
|
|
"KeyBuilder",
|
|
"default_key_builder",
|
|
]
|
|
|
|
|
|
class FastAPICache:
|
|
_backend: ClassVar[Optional[Backend]] = None
|
|
_prefix: ClassVar[Optional[str]] = None
|
|
_expire: ClassVar[Optional[int]] = None
|
|
_init: ClassVar[bool] = False
|
|
_coder: ClassVar[Optional[Type[Coder]]] = None
|
|
_key_builder: ClassVar[Optional[KeyBuilder]] = None
|
|
_enable: ClassVar[bool] = True
|
|
|
|
@classmethod
|
|
def init(
|
|
cls,
|
|
backend: Backend,
|
|
prefix: str = "",
|
|
expire: Optional[int] = None,
|
|
coder: Type[Coder] = JsonCoder,
|
|
key_builder: KeyBuilder = default_key_builder,
|
|
enable: bool = True,
|
|
) -> None:
|
|
if cls._init:
|
|
return
|
|
cls._init = True
|
|
cls._backend = backend
|
|
cls._prefix = prefix
|
|
cls._expire = expire
|
|
cls._coder = coder
|
|
cls._key_builder = key_builder
|
|
cls._enable = enable
|
|
|
|
@classmethod
|
|
def reset(cls) -> None:
|
|
cls._init = False
|
|
cls._backend = None
|
|
cls._prefix = None
|
|
cls._expire = None
|
|
cls._coder = None
|
|
cls._key_builder = None
|
|
cls._enable = True
|
|
|
|
@classmethod
|
|
def get_backend(cls) -> Backend:
|
|
assert cls._backend, "You must call init first!" # nosec: B101
|
|
return cls._backend
|
|
|
|
@classmethod
|
|
def get_prefix(cls) -> str:
|
|
assert cls._prefix is not None, "You must call init first!" # nosec: B101
|
|
return cls._prefix
|
|
|
|
@classmethod
|
|
def get_expire(cls) -> Optional[int]:
|
|
return cls._expire
|
|
|
|
@classmethod
|
|
def get_coder(cls) -> Type[Coder]:
|
|
assert cls._coder, "You must call init first!" # nosec: B101
|
|
return cls._coder
|
|
|
|
@classmethod
|
|
def get_key_builder(cls) -> KeyBuilder:
|
|
assert cls._key_builder, "You must call init first!" # nosec: B101
|
|
return cls._key_builder
|
|
|
|
@classmethod
|
|
def get_enable(cls) -> bool:
|
|
return cls._enable
|
|
|
|
@classmethod
|
|
async def clear(cls, namespace: Optional[str] = None, key: Optional[str] = None) -> int:
|
|
assert cls._backend and cls._prefix is not None, "You must call init first!" # nosec: B101
|
|
namespace = cls._prefix + (":" + namespace if namespace else "")
|
|
return await cls._backend.clear(namespace, key)
|