Plugins for FastAPI framework
Project description
Plugins for FastAPI framework, high performance, easy to learn, fast to code, ready for production
fastapi-plugins
FastAPI framework plugins
Changes
See release notes
Installation
pip install fastapi-plugins
Plugins
Redis
Supports
- single instance
- sentinel
- fake redis NOT SUPPORTED NOW
Valid variable are
REDIS_TYPE
redis
- single Redis isntancesentinel
- Redis clusterfake
- by using fake Redis
REDIS_URL
- URL to connect to Redis server. Exampleredis://user:password@localhost:6379/2
. Supports protocolsredis://
,rediss://
(redis over TLS) andunix://
.REDIS_HOST
- Redis server host.REDIS_PORT
- Redis server port. Default is6379
.REDIS_PASSWORD
- Redis password for server.REDIS_DB
- Redis db (zero-based number index). Default is0
.REDIS_CONNECTION_TIMEOUT
- Redis connection timeout. Default is2
.REDIS_POOL_MINSIZE
- Minimum number of free connection to create in pool. Default is0
.REDIS_POOL_MAXSIZE
- Maximum number of connection to keep in pool. Default is10
. Must be greater than0
.None
is disallowed.REDIS_SENTINELS
- List or a tuple of Redis sentinel addresses.REDIS_SENTINEL_MASTER
- The name of the master server in a sentinel configuration. Default ismymaster
.REDIS_PRESTART_TRIES
- The number tries to connect to the a Redis instance.REDIS_PRESTART_WAIT
- The interval in seconds to wait between connection failures on application start.
Example
# run with `uvicorn demo_app:app`
import typing
import aioredis
import fastapi
import pydantic
import fastapi_plugins
class AppSettings(OtherSettings, fastapi_plugins.RedisSettings):
api_name: str = str(__name__)
app = fastapi.FastAPI()
config = AppSettings()
@app.get("/")
async def root_get(
cache: aioredis.Redis=fastapi.Depends(fastapi_plugins.depends_redis),
) -> typing.Dict:
return dict(ping=await cache.ping())
@app.on_event('startup')
async def on_startup() -> None:
await fastapi_plugins.redis_plugin.init_app(app, config=config)
await fastapi_plugins.redis_plugin.init()
@app.on_event('shutdown')
async def on_shutdown() -> None:
await fastapi_plugins.redis_plugin.terminate()
Example with Docker Compose - Redis
version: '3.7'
services:
redis:
image: redis
ports:
- "6379:6379"
demo_fastapi_plugin:
image: demo_fastapi_plugin
environment:
- REDIS_TYPE=redis
- REDIS_HOST=redis
- REDIS_PORT=6379
ports:
- "8000:8000"
Example with Docker Compose - Redis Sentinel
version: '3.7'
services:
...
redis-sentinel:
ports:
- "26379:26379"
environment:
- ...
links:
- redis-master
- redis-slave
demo_fastapi_plugin:
image: demo_fastapi_plugin
environment:
- REDIS_TYPE=sentinel
- REDIS_SENTINELS=redis-sentinel:26379
ports:
- "8000:8000"
Scheduler
Simple schedule an awaitable job as a task.
- long running
async
functions (e.g. monitor a file a system or events) - gracefully cancel spawned tasks
Valid variable are:
AIOJOBS_CLOSE_TIMEOUT
- The timeout in seconds before canceling a task.AIOJOBS_LIMIT
- The number of concurrent tasks to be executed.AIOJOBS_PENDING_LIMIT
- The number of pending jobs (waiting fr execution).
# run with `uvicorn demo_app:app`
import ...
import fastapi_plugins
class AppSettings(OtherSettings, fastapi_plugins.RedisSettings, fastapi_plugins.SchedulerSettings):
api_name: str = str(__name__)
app = fastapi.FastAPI()
config = AppSettings()
@app.post("/jobs/schedule/<timeout>")
async def job_post(
timeout: int=fastapi.Query(..., title='the job sleep time'),
cache: aioredis.Redis=fastapi.Depends(fastapi_plugins.depends_redis),
scheduler: aiojobs.Scheduler=fastapi.Depends(fastapi_plugins.depends_scheduler), # @IgnorePep8
) -> str:
async def coro(job_id, timeout, cache):
await cache.set(job_id, 'processing')
try:
await asyncio.sleep(timeout)
if timeout == 8:
raise Exception('ugly error')
except asyncio.CancelledError:
await cache.set(job_id, 'canceled')
except Exception:
await cache.set(job_id, 'erred')
else:
await cache.set(job_id, 'success')
job_id = str(uuid.uuid4()).replace('-', '')
await cache.set(job_id, 'pending')
await scheduler.spawn(coro(job_id, timeout, cache))
return job_id
@app.get("/jobs/status/<job_id>")
async def job_get(
job_id: str=fastapi.Query(..., title='the job id'),
cache: aioredis.Redis=fastapi.Depends(fastapi_plugins.depends_redis),
) -> typing.Dict:
status = await cache.get(job_id)
if status is None:
raise fastapi.HTTPException(
status_code=starlette.status.HTTP_404_NOT_FOUND,
detail='Job %s not found' % job_id
)
return dict(job_id=job_id, status=status)
@app.on_event('startup')
async def on_startup() -> None:
await fastapi_plugins.redis_plugin.init_app(app, config=config)
await fastapi_plugins.redis_plugin.init()
await fastapi_plugins.scheduler_plugin.init_app(app=app, config=config)
await fastapi_plugins.scheduler_plugin.init()
@app.on_event('shutdown')
async def on_shutdown() -> None:
await fastapi_plugins.scheduler_plugin.terminate()
await fastapi_plugins.redis_plugin.terminate()
... more already in progress ...
Development
Issues and suggestions are welcome through issues
License
This project is licensed under the terms of the MIT license.
deactivate rm -rf venv virtualenv -ppython3.7 venv source venv/bin/activate pip freeze
cp ../fastapi-plugins/demo.py . pip install ../fastapi-plugins/dist/fastapi_plugins-0.4.0-py3-none-any.whl pip install ../fastapi-plugins/dist/fastapi_plugins-0.4.0-py3-none-any.whl[redis] pip install ../fastapi-plugins/dist/fastapi_plugins-0.4.0-py3-none-any.whl[jobs] pip install ../fastapi-plugins/dist/fastapi_plugins-0.4.0-py3-none-any.whl[test] pip freeze
Changes
0.4.1 (2020-06-16)
- Refactor requirements
0.4.0 (2020-04-09)
- structure and split dependencies to
extra
0.3.0 (2020-04-07)
- Scheduler: tasks scheduler based on
aiojobs
0.2.1 (2020-04-06)
- Redis: pre-start
0.2.0 (2019-12-11)
- Redis: sentinels
0.1.0 (2019-11-20)
- Initial release: simple redis pool client
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fastapi_plugins-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e49e781a28b16e4edcbbc68708fadf37dd994de83b4d079c0b343a974dc28ab8 |
|
MD5 | b75ae68ef9e4a5b1c10e05f2a06bb45b |
|
BLAKE2b-256 | 5c342bb110af04ba62b29dd1b7c7219764c1fdf07b95bfa6fd7760f78b94565b |