update deps

Use FastAPI's built in jsonable_encoder

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+custom: ["https://sponsor.long2ice.cn"]
+

.github/workflows/ci.yml

@@ -1,5 +1,5 @@
 name: ci
-on: [push, pull_request]
+on: [ push, pull_request ]
 jobs:
   ci:
     runs-on: ubuntu-latest
@@ -8,6 +8,9 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: "3.x"
-      - uses: dschep/install-poetry-action@v1.3
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1.1.1
+        with:
+          virtualenvs-create: false
       - name: CI
         run: make ci

.github/workflows/pypi.yml

@@ -11,7 +11,10 @@ jobs:
       - uses: actions/setup-python@v1
         with:
           python-version: '3.x'
-      - uses: dschep/install-poetry-action@v1.3
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1.1.1
+        with:
+          virtualenvs-create: false
       - name: Build dists
         run: make build
       - name: Pypi Publish

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## 0.1
 
+### 0.1.4
+
+- Fix default expire for memcached. (#13)
+- Update default key builder. (#12)
+
+### 0.1.3
+
+- Fix cache key builder.
+
+### 0.1.2
+
+- Add default config when init.
+- Update JsonEncoder.
+
 ### 0.1.1
 
 - Add in-memory support.

Makefile

@@ -32,7 +32,10 @@ check: deps
 test: deps
 	$(py_warn) pytest
 
-build: deps
+build: clean deps
 	@poetry build
 
+clean:
+	@rm -rf ./dist
+
 ci: check test

README.md

@@ -74,10 +74,22 @@ async def startup():
 
 ```
 
+### Initialization
+
+Firstly you must call `FastAPICache.init` on startup event of `fastapi`, there are some global config you can pass in.
+
 ### Use `cache` decorator
 
 If you want cache `fastapi` response transparently, you can use `cache` as decorator between router decorator and view function and must pass `request` as param of view function.
 
+Parameter | type, description
+------------ | -------------
+expire | int, states a caching time in seconds
+namespace | str, namespace to use to store certain cache items
+coder | which coder to use, e.g. JsonCoder
+key_builder | which key builder to use, default to builtin
+
+
 And if you want use `ETag` and `Cache-Control` features, you must pass `response` param also.
 
 You can also use `cache` as decorator like other cache tools to cache common function result.
@@ -95,6 +107,8 @@ async def index(request: Request, response: Response):
 
 ### Custom key builder
 
+By default use builtin key builder, if you need, you can override this and pass in `cache` or `FastAPICache.init` to take effect globally.
+
 ```python
 def my_key_builder(
     func,
@@ -116,7 +130,7 @@ async def index(request: Request, response: Response):
 
 ### InMemoryBackend
 
-`InMemoryBackend` only support in single node instead of distributed environment.
+`InMemoryBackend` store cache data in memory and use lazy delete, which mean if you don't access it after cached, it will not delete automatically.
 
 ## License
 

examples/main.py

@@ -12,7 +12,7 @@ app = FastAPI()
 ret = 0
 
 
-@cache(expire=1)
+@cache(namespace="test", expire=1)
 async def get_ret():
     global ret
     ret = ret + 1
@@ -20,11 +20,16 @@ async def get_ret():
 
 
 @app.get("/")
-@cache(expire=2)
+@cache(namespace="test", expire=2)
 async def index(request: Request, response: Response):
     return dict(ret=await get_ret())
 
 
+@app.get("/clear")
+async def clear():
+    return await FastAPICache.clear(namespace="test")
+
+
 @app.on_event("startup")
 async def startup():
     FastAPICache.init(InMemoryBackend(), prefix="fastapi-cache")

fastapi_cache/__init__.py

@@ -1,17 +1,34 @@
+from typing import Callable
+
+from fastapi_cache.coder import Coder, JsonCoder
+from fastapi_cache.key_builder import default_key_builder
+
+
 class FastAPICache:
     _backend = None
     _prefix = None
     _expire = None
     _init = False
+    _coder = None
+    _key_builder = None
 
     @classmethod
-    def init(cls, backend, prefix: str = "", expire: int = None):
+    def init(
+        cls,
+        backend,
+        prefix: str = "",
+        expire: int = None,
+        coder: Coder = JsonCoder,
+        key_builder: Callable = default_key_builder,
+    ):
         if cls._init:
             return
         cls._init = True
         cls._backend = backend
         cls._prefix = prefix
         cls._expire = expire
+        cls._coder = coder
+        cls._key_builder = key_builder
 
     @classmethod
     def get_backend(cls):
@@ -25,3 +42,16 @@ class FastAPICache:
     @classmethod
     def get_expire(cls):
         return cls._expire
+
+    @classmethod
+    def get_coder(cls):
+        return cls._coder
+
+    @classmethod
+    def get_key_builder(cls):
+        return cls._key_builder
+
+    @classmethod
+    async def clear(cls, namespace: str = None, key: str = None):
+        namespace = cls._prefix + ":" + namespace if namespace else None
+        return await cls._backend.clear(namespace, key)

fastapi_cache/backends/__init__.py

@@ -14,3 +14,7 @@ class Backend:
     @abc.abstractmethod
     async def set(self, key: str, value: str, expire: int = None):
         raise NotImplementedError
+
+    @abc.abstractmethod
+    async def clear(self, namespace: str = None, key: str = None) -> int:
+        raise NotImplementedError

fastapi_cache/backends/inmemory.py

@@ -1,6 +1,6 @@
 import time
+from asyncio import Lock
 from dataclasses import dataclass
-from threading import Lock
 from typing import Dict, Optional, Tuple
 
 from fastapi_cache.backends import Backend
@@ -29,18 +29,31 @@ class InMemoryBackend(Backend):
                 return v
 
     async def get_with_ttl(self, key: str) -> Tuple[int, Optional[str]]:
-        with self._lock:
+        async with self._lock:
             v = self._get(key)
             if v:
                 return v.ttl_ts - self._now, v.data
             return 0, None
 
     async def get(self, key: str) -> str:
-        with self._lock:
+        async with self._lock:
             v = self._get(key)
             if v:
                 return v.data
 
     async def set(self, key: str, value: str, expire: int = None):
-        with self._lock:
+        async with self._lock:
             self._store[key] = Value(value, self._now + expire)
+
+    async def clear(self, namespace: str = None, key: str = None) -> int:
+        count = 0
+        if namespace:
+            keys = list(self._store.keys())
+            for key in keys:
+                if key.startswith(namespace):
+                    del self._store[key]
+                    count += 1
+        elif key:
+            del self._store[key]
+            count += 1
+        return count

fastapi_cache/backends/memcached.py

@@ -5,15 +5,18 @@ from aiomcache import Client
 from fastapi_cache.backends import Backend
 
 
-class MemcacheBackend(Backend):
+class MemcachedBackend(Backend):
     def __init__(self, mcache: Client):
         self.mcache = mcache
 
     async def get_with_ttl(self, key: str) -> Tuple[int, str]:
-        return 0, await self.mcache.get(key.encode())
+        return 3600, await self.mcache.get(key.encode())
 
     async def get(self, key: str):
         return await self.mcache.get(key, key.encode())
 
     async def set(self, key: str, value: str, expire: int = None):
-        return await self.mcache.set(key.encode(), value.encode(), exptime=expire)
+        return await self.mcache.set(key.encode(), value.encode(), exptime=expire or 0)
+
+    async def clear(self, namespace: str = None, key: str = None):
+        raise NotImplementedError

fastapi_cache/backends/redis.py

@@ -20,3 +20,10 @@ class RedisBackend(Backend):
 
     async def set(self, key: str, value: str, expire: int = None):
         return await self.redis.set(key, value, expire=expire)
+
+    async def clear(self, namespace: str = None, key: str = None) -> int:
+        if namespace:
+            lua = f"for i, name in ipairs(redis.call('KEYS', '{namespace}:*')) do redis.call('DEL', name); end"
+            return await self.redis.eval(lua)
+        elif key:
+            return await self.redis.delete(key)

fastapi_cache/coder.py

@@ -1,6 +1,43 @@
+import datetime
 import json
 import pickle  # nosec:B403
+from decimal import Decimal
 from typing import Any
+from fastapi.encoders import jsonable_encoder
+
+import dateutil.parser
+
+CONVERTERS = {
+    "date": dateutil.parser.parse,
+    "datetime": dateutil.parser.parse,
+    "decimal": Decimal,
+}
+
+
+class JsonEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, datetime.datetime):
+            if obj.tzinfo:
+                return {"val": obj.strftime("%Y-%m-%d %H:%M:%S%z"), "_spec_type": "datetime"}
+            else:
+                return {"val": obj.strftime("%Y-%m-%d %H:%M:%S"), "_spec_type": "datetime"}
+        elif isinstance(obj, datetime.date):
+            return {"val": obj.strftime("%Y-%m-%d"), "_spec_type": "date"}
+        elif isinstance(obj, Decimal):
+            return {"val": str(obj), "_spec_type": "decimal"}
+        else:
+            return jsonable_encoder(obj)
+
+
+def object_hook(obj):
+    _spec_type = obj.get("_spec_type")
+    if not _spec_type:
+        return obj
+
+    if _spec_type in CONVERTERS:
+        return CONVERTERS[_spec_type](obj["val"])
+    else:
+        raise TypeError("Unknown {}".format(_spec_type))
 
 
 class Coder:
@@ -16,11 +53,11 @@ class Coder:
 class JsonCoder(Coder):
     @classmethod
     def encode(cls, value: Any):
-        return json.dumps(value)
+        return json.dumps(value, cls=JsonEncoder)
 
     @classmethod
     def decode(cls, value: Any):
-        return json.loads(value)
+        return json.loads(value, object_hook=object_hook)
 
 
 class PickleCoder(Coder):

fastapi_cache/decorator.py

@@ -1,30 +1,14 @@
 from functools import wraps
 from typing import Callable, Optional, Type
 
-from starlette.requests import Request
-from starlette.responses import Response
-
 from fastapi_cache import FastAPICache
-from fastapi_cache.coder import Coder, JsonCoder
+from fastapi_cache.coder import Coder
-
-
-def default_key_builder(
-    func,
-    namespace: Optional[str] = "",
-    request: Request = None,
-    response: Response = None,
-    *args,
-    **kwargs,
-):
-    prefix = FastAPICache.get_prefix()
-    cache_key = f"{prefix}:{namespace}:{func.__module__}:{func.__name__}:{args}:{kwargs}"
-    return cache_key
 
 
 def cache(
     expire: int = None,
-    coder: Type[Coder] = JsonCoder,
+    coder: Type[Coder] = None,
-    key_builder: Callable = default_key_builder,
+    key_builder: Callable = None,
     namespace: Optional[str] = "",
 ):
     """
@@ -39,9 +23,23 @@ def cache(
     def wrapper(func):
         @wraps(func)
         async def inner(*args, **kwargs):
-            request = kwargs.get("request")
+            nonlocal coder
+            nonlocal expire
+            nonlocal key_builder
+            copy_kwargs = kwargs.copy()
+            request = copy_kwargs.pop("request", None)
+            response = copy_kwargs.pop("response", None)
+            if request and request.headers.get("Cache-Control") == "no-store":
+                return await func(*args, **kwargs)
+
+            coder = coder or FastAPICache.get_coder()
+            expire = expire or FastAPICache.get_expire()
+            key_builder = key_builder or FastAPICache.get_key_builder()
             backend = FastAPICache.get_backend()
-            cache_key = key_builder(func, namespace, *args, **kwargs)
+
+            cache_key = key_builder(
+                func, namespace, request=request, response=response, args=args, kwargs=copy_kwargs
+            )
             ttl, ret = await backend.get_with_ttl(cache_key)
             if not request:
                 if ret is not None:
@@ -54,7 +52,6 @@ def cache(
                 return await func(request, *args, **kwargs)
             if_none_match = request.headers.get("if-none-match")
             if ret is not None:
-                response = kwargs.get("response")
                 if response:
                     response.headers["Cache-Control"] = f"max-age={ttl}"
                     etag = f"W/{hash(ret)}"

fastapi_cache/key_builder.py

@@ -0,0 +1,25 @@
+import hashlib
+from typing import Optional
+
+from starlette.requests import Request
+from starlette.responses import Response
+
+
+def default_key_builder(
+    func,
+    namespace: Optional[str] = "",
+    request: Optional[Request] = None,
+    response: Optional[Response] = None,
+    args: Optional[tuple] = None,
+    kwargs: Optional[dict] = None,
+):
+    from fastapi_cache import FastAPICache
+
+    prefix = f"{FastAPICache.get_prefix()}:{namespace}:"
+    cache_key = (
+        prefix
+        + hashlib.md5(  # nosec:B303
+            f"{func.__module__}:{func.__name__}:{args}:{kwargs}"
+        ).hexdigest()
+    )
+    return cache_key

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastapi-cache2"
-version = "0.1.1"
+version = "0.1.4"
 description = "Cache for FastAPI"
 authors = ["long2ice <long2ice@gmail.com>"]
 license = "Apache-2.0"
@@ -18,8 +18,9 @@ include = ["LICENSE", "README.md"]
 python = "^3.7"
 fastapi = "*"
 uvicorn = "*"
-aioredis = {version = "*", optional = true}
+aioredis = {version = ">=2.0.0b1", optional = true}
 aiomcache = {version = "*", optional = true}
+python-dateutil = "*"
 
 [tool.poetry.dev-dependencies]
 flake8 = "*"