fastapi-cache-stable 0.3.0a0__tar.gz

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.
@@ -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.
@@ -0,0 +1,6 @@
1
+ fastapi-cache-stable
2
+ Copyright 2026 Agustin Saiz and contributors
3
+
4
+ This product includes software developed by long2ice and contributors
5
+ (https://github.com/long2ice/fastapi-cache), licensed under the Apache
6
+ License, Version 2.0.
@@ -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
+ [![pypi](https://img.shields.io/pypi/v/fastapi-cache-stable.svg?style=flat)](https://pypi.org/p/fastapi-cache-stable)
50
+ [![license](https://img.shields.io/github/license/agustin18/fastapi-cache)](https://github.com/agustin18/fastapi-cache/blob/stable/LICENSE)
51
+ [![CI/CD](https://github.com/agustin18/fastapi-cache/actions/workflows/ci-cd.yml/badge.svg)](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
+