FastAPI simple cache

Last update: Dec 29, 2022

Overview

FastAPI Cache

Implements simple lightweight cache system as dependencies in FastAPI.

Installation

pip install fastapi-cache

Usage example

from fastapi import Depends, FastAPI

from fastapi_cache import caches, close_caches
from fastapi_cache.backends.redis import CACHE_KEY, RedisCacheBackend

app = FastAPI()


def redis_cache():
    return caches.get(CACHE_KEY)


@app.get('/')
async def hello(
    cache: RedisCacheBackend = Depends(redis_cache)
):
    in_cache = await cache.get('some_cached_key')
    if not in_cache:
        await cache.set('some_cached_key', 'new_value', 5)

    return {'response': in_cache or 'default'}


@app.on_event('startup')
async def on_startup() -> None:
    rc = RedisCacheBackend('redis://redis')
    caches.set(CACHE_KEY, rc)


@app.on_event('shutdown')
async def on_shutdown() -> None:
    await close_caches()

TODO

Add tests
~~Add registry decorator~~
Add dependency for requests caching

Acknowledgments

Balburdia
xobtoor

Changelog

0.0.6 Added typings for backends. Specific arguments now need to be passed through **kwargs. Set default encoding to utf-8 for redis backend, removed default TTL for redis keys.

Comments

Add support for caching generic types

Reference Issues/PRs

None

What does this implement/fix?

The current version of the package fails to retrieve objects in Redis that cannot be decoded by the default encoding='utf-8' option defined on get. In order to enable a more generic approach this PR refactor the Cache classes changing the value typing (both when setting and when retrieving) to Any, minimizing IDE's warnings, and adds a new optional parameter encoding to RedisCacheBackend.get method, keeping utf-8 as the default value to enable backwards compatibility. A new simple test for the option encoding=None was added.

opened by Balburdia 3
Add support for Redis backend requiring TLS

It looks like the RedisCacheBackend doesn't support specifying the ssl passthrough option to aioredis.create_redis_pool() in order to be able to connect to a Redis endpoint that requires TLS, e.g. ElastiCache in AWS.

opened by erhhung 1
Create expire function

This PR will include the aioredis function for expire(key, timeout) in order to automatically invalidate an entry after some time. This is useful when using redis for caching API responses.
enhancement

opened by jersobh 0
Add redis function to check if key exists or not

in our current implementation of redis we use exists a lot to check if a key is already set or not and then decide what to do.

exists can check multiple keys at once and returns an integer with the number of existing keys.

https://redis.io/commands/exists
enhancement

opened by stndrf 0
How to pass a KEYS pattern when get cache [Redis Backend]?

Hi guys, I couldn't find anywhere how I can get values from a given key with a pattern. Eg.: project_* where * can be any char.

I tried something like await cache.get("project_*") but no success.

Reference: https://redis.io/commands/KEYS

opened by mauricioribeiro 0
Upgrade aioredis to 2.x
aioredis 2.x introduces breaking changes in API

poo_min_size is dropped, the connection pool is now lazy filled, not pre-filled

whether decode or not is decided globally, could not be changed on each top level api (like Redis.get())
opened by laggardkernel 0

ImportError: cannot import name 'FastAPICache' from 'fastapi_cache'

I have the following issue when try running the API from my docker image. Running it locally, has no issue.

This is my requirements.txt:

fastapi==0.63.0
fastapi-cache==0.1.0

Full error message:

from api.routers import sa_ranking, sa_person_ranking
  File "./api/routers/sa_ranking.py", line 9, in <module>
    from fastapi_cache import FastAPICache
ImportError: cannot import name 'FastAPICache' from 'fastapi_cache' (/usr/local/lib/python3.8/site-packages/fastapi_cache/__init__.py)

Please help! Urgent need

opened by chenuratikah 1

Can we remove print statement in InMemoryCache?

Would it possible to remove below print statements https://github.com/comeuplater/fastapi_cache/blob/2723817a5d6f7d34c736acd09b155c05cd1221d3/fastapi_cache/backends/utils/ttldict.py#L14

https://github.com/comeuplater/fastapi_cache/blob/2723817a5d6f7d34c736acd09b155c05cd1221d3/fastapi_cache/backends/utils/ttldict.py#L28
bug

opened by herbherbherb 0

Releases(0.0.1)

0.0.1(Jul 26, 2020)
Added caches registry container

Implemented Redis based cache

Source code(tar.gz)
Source code(zip)

Owner

Ivan Sushkov

GitHub Repository

A rate limiter for Starlette and FastAPI

SlowApi A rate limiting library for Starlette and FastAPI adapted from flask-limiter. Note: this is alpha quality code still, the API may change, and

562 Jan 01, 2023

스타트업 개발자 채용

스타트업 개발자 채용 大 박람회 Seed ~ Series B에 있는 스타트업을 위한 채용정보 페이지입니다. Back-end, Frontend, Mobile 등 개발자를 대상으로 진행하고 있습니다. 해당 스타트업에 종사하시는 분뿐만 아니라 채용 관련 정보를 알고 계시다면

58 Dec 14, 2022

API Simples com python utilizando a biblioteca FastApi

api-fastapi-python API Simples com python utilizando a biblioteca FastApi Para rodar esse script são necessárias duas bibliotecas: Fastapi: Comando de

0 Apr 29, 2022

Dead-simple mailer micro-service for static websites

Mailer Dead-simple mailer micro-service for static websites A free and open-source software alternative to contact form services such as FormSpree, to

42 Dec 21, 2022

A simple Redis Streams backed Chat app using Websockets, Asyncio and FastAPI/Starlette.

redis-streams-fastapi-chat A simple demo of Redis Streams backed Chat app using Websockets, Python Asyncio and FastAPI/Starlette. Requires Python vers

135 Dec 19, 2022

Pagination support for flask

flask-paginate Pagination support for flask framework (study from will_paginate). It supports several css frameworks. It requires Python2.6+ as string

264 Nov 07, 2022

FastAPI Auth Starter Project

This is a template for FastAPI that comes with authentication preconfigured.

6 Nov 13, 2022

MQTT FastAPI Wrapper With Python

mqtt-fastapi-wrapper Quick start Create mosquitto.conf with the following content: ➜ /tmp cat mosquitto.conf persistence false allow_anonymous true

3 May 09, 2022

FastAPI pagination

FastAPI Pagination Installation # Basic version pip install fastapi-pagination # All available integrations pip install fastapi-pagination[all] Avail

561 Jan 07, 2023

Drop-in MessagePack support for ASGI applications and frameworks

msgpack-asgi msgpack-asgi allows you to add automatic MessagePack content negotiation to ASGI applications (Starlette, FastAPI, Quart, etc.), with a s

128 Jan 02, 2023

Simple notes app backend using Python's FastAPI framework.

my-notes-app Simple notes app backend using Python's FastAPI framework. Route "/": User login (GET): return 200, list of all of their notes; User sign

2 Sep 17, 2022

Cache-house - Caching tool for python, working with Redis single instance and Redis cluster mode

Caching tool for python, working with Redis single instance and Redis cluster mo

14 Jan 06, 2022

High-performance Async REST API, in Python. FastAPI + GINO + Arq + Uvicorn (w/ Redis and PostgreSQL).

fastapi-gino-arq-uvicorn High-performance Async REST API, in Python. FastAPI + GINO + Arq + Uvicorn (powered by Redis & PostgreSQL). Contents Get Star

351 Jan 04, 2023

Qwerkey is a social media platform for connecting and learning more about mechanical keyboards built on React and Redux in the frontend and Flask in the backend on top of a PostgreSQL database.

Flask React Project This is the backend for the Flask React project. Getting started Clone this repository (only this branch) git clone https://github

22 Dec 20, 2022