fastapi-cache/fastapi_cache/key_builder.py

import hashlib
from typing import Any, Callable, Dict, Optional, Tuple

from starlette.requests import Request
from starlette.responses import Response


def default_key_builder(
    func: Callable[..., Any],
    namespace: str = "",
    request: Optional[Request] = None,
    response: Optional[Response] = None,
    args: Optional[Tuple[Any, ...]] = None,
    kwargs: Optional[Dict[str, Any]] = None,
) -> str:
    cache_key = hashlib.md5(  # nosec:B303
        f"{func.__module__}:{func.__name__}:{args}:{kwargs}".encode()
    ).hexdigest()
    return f"{namespace}:{cache_key}"
- Fix default expire for memcached. (#13) - Update default key builder. (#12) 2021-03-20 14:42:29 +08:00			`import hashlib`
Typing cleanup - Compatibility with older Python versions - use `Optional` and `Union` instead of `... \| None` and `a \| b` - use `typing_extensions.Protocol` instead of `typing.Protocol` - use `typing.Dict`, `typing.List`, etc. instead of the concrete types. - Fix backend `.get()` annotations; not all were marked as `Optional[str]` - Don't return anything from `Backend.set()` methods. - The `Coder.decode_as_type()` type parameter must be a type to be compatible with `ModelField(..., type_=...)`. - Clean up `Optional[]` use, remove where it is not needed. - Clean up variable use in decorator, keeping the raw cached value separate from the return value from the wrapped endpoint. - Annotate the wrapper as returning either the original type _or_ a Response (returning a 304 Not Modified response). - Clean up small edge-case where `response` could be `None`. - Correct type annotation on `JsonCoder.decode()` to match `Coder.decode()`. 2023-05-09 15:30:46 +01:00			`from typing import Any, Callable, Dict, Optional, Tuple`
Add default config when init update JsonEncoder 2020-10-16 16:55:33 +08:00
			`from starlette.requests import Request`
			`from starlette.responses import Response`


			`def default_key_builder(`
Use complete type hints with all generic parameters filled This makes the core fastapi_cache pass all strict type checker tests. 2023-04-27 16:31:42 +01:00			`func: Callable[..., Any],`
Correct type hint: namespace is not optional The namespace argument is positional and will never be `None` so should not be marked as Optional. It is always a string, and the default is to pass in an empty string. 2023-04-27 16:11:59 +01:00			`namespace: str = "",`
Fix cache key builder. 2021-01-06 10:34:30 +08:00			`request: Optional[Request] = None,`
			`response: Optional[Response] = None,`
Typing cleanup - Compatibility with older Python versions - use `Optional` and `Union` instead of `... \| None` and `a \| b` - use `typing_extensions.Protocol` instead of `typing.Protocol` - use `typing.Dict`, `typing.List`, etc. instead of the concrete types. - Fix backend `.get()` annotations; not all were marked as `Optional[str]` - Don't return anything from `Backend.set()` methods. - The `Coder.decode_as_type()` type parameter must be a type to be compatible with `ModelField(..., type_=...)`. - Clean up `Optional[]` use, remove where it is not needed. - Clean up variable use in decorator, keeping the raw cached value separate from the return value from the wrapped endpoint. - Annotate the wrapper as returning either the original type _or_ a Response (returning a 304 Not Modified response). - Clean up small edge-case where `response` could be `None`. - Correct type annotation on `JsonCoder.decode()` to match `Coder.decode()`. 2023-05-09 15:30:46 +01:00			`args: Optional[Tuple[Any, ...]] = None,`
			`kwargs: Optional[Dict[str, Any]] = None,`
feat: add more type hints 2022-10-22 20:59:37 +04:00			`) -> str:`
Make decorator responsibe for applying the prefix The key builder should not have to fetch the prefix separately, as this makes creating custom key builders that much harder. 2023-05-10 17:46:48 +01:00			`cache_key = hashlib.md5( # nosec:B303`
			`f"{func.__module__}:{func.__name__}:{args}:{kwargs}".encode()`
			`).hexdigest()`
			`return f"{namespace}:{cache_key}"`