fastapi-cache/fastapi_cache/types.py

from typing import Any, Awaitable, Callable, Dict, Optional, Tuple, Union

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


_Func = Callable[..., Any]


class KeyBuilder(Protocol):
    def __call__(
        self,
        _function: _Func,
        _namespace: str = ...,
        *,
        request: Optional[Request] = ...,
        response: Optional[Response] = ...,
        args: Tuple[Any, ...] = ...,
        kwargs: Dict[str, Any] = ...,
    ) -> Union[Awaitable[str], str]:
        ...
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, Awaitable, Callable, Dict, Optional, Tuple, Union`
Define keybuilder protocol This lets others create key builders that are type checked fully. 2023-04-27 16:24:22 +01:00
			`from starlette.requests import Request`
			`from starlette.responses import Response`
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_extensions import Protocol`
Define keybuilder protocol This lets others create key builders that are type checked fully. 2023-04-27 16:24:22 +01:00

			`_Func = Callable[..., Any]`


			`class KeyBuilder(Protocol):`
			`def __call__(`
			`self,`
			`_function: _Func,`
			`_namespace: str = ...,`
			`*,`
			`request: Optional[Request] = ...,`
			`response: Optional[Response] = ...,`
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: Tuple[Any, ...] = ...,`
			`kwargs: Dict[str, Any] = ...,`
Define keybuilder protocol This lets others create key builders that are type checked fully. 2023-04-27 16:24:22 +01:00			`) -> Union[Awaitable[str], str]:`
			`...`