svcs25.1.0
Published
A Flexible Service Locator
pip install svcs
Package Downloads
Authors
Requires Python
>=3.9
Dependencies
- attrs
>=21.3.0
- aiohttp
; extra == "dev"
- fastapi
; extra == "dev"
- flask
; extra == "dev"
- httpx
; extra == "dev"
- mypy
>=1.4; extra == "dev"
- pyramid
; extra == "dev"
- pytest
; extra == "dev"
- pytest-asyncio
; extra == "dev"
- starlette
; extra == "dev"
- sybil
>=6; extra == "dev"
- tox-uv
; extra == "dev"
- tox
>4; extra == "dev"
- aiohttp
; extra == "docs"
- fastapi
; extra == "docs"
- flask
; extra == "docs"
- furo
>=2023.8.17; extra == "docs"
- httpx
; extra == "docs"
- myst-parser
; extra == "docs"
- pyramid
; extra == "docs"
- pytest
; extra == "docs"
- pytest-asyncio
; extra == "docs"
- sphinx-copybutton
; extra == "docs"
- sphinx-design
; extra == "docs"
- sphinx-notfound-page
; extra == "docs"
- sphinx
>=7.2.2; extra == "docs"
- sphinxext-opengraph
; extra == "docs"
- sqlalchemy
; extra == "docs"
- starlette
; extra == "docs"
- sybil
; extra == "docs"
- pytest
; extra == "tests"
- pytest-asyncio
; extra == "tests"
- sybil
>=6; extra == "tests"
- aiohttp
; extra == "typing"
- fastapi
; extra == "typing"
- flask
; extra == "typing"
- mypy
>=1.4; extra == "typing"
- pyramid
; extra == "typing"
- starlette
; extra == "typing"
A Flexible Service Locator for Python.
svcs (pronounced services) is a dependency container for Python. It gives you a central place to register factories for types/interfaces and then imperatively acquire instances of those types with automatic cleanup and health checks.
It's suitable for implementing Inversion of Control using either dependency injection or service location while not requiring global state, decorators, or mangling of function signatures.
Benefits:
- Eliminates tons of repetitive boilerplate code,
- unifies acquisition and cleanups of services,
- provides full static type safety for them,
- simplifies testing through loose coupling,
- improves live introspection and monitoring with health checks.
The goal is to minimize the code for acquiring pluggable services to:
from svcs.your_framework import svcs_from
def view(request):
db, api, cache = svcs_from(request).get(Database, WebAPIClient, Cache)
... or less!
To a type checker like Mypy, db
has the type Database
, api
has the type WebAPIClient
, and cache
has the type Cache
.
db
, api
, and cache
will be automatically cleaned up when the request ends -- it's context managers all the way down.
svcs comes with seamless integration for AIOHTTP, FastAPI, Flask, Pyramid, and Starlette.
While svcs also has first-class support for static typing, it is strictly optional and will always remain so. svcs also doesn't check your types at runtime. It only forwards the type you have asked for to the type checker. If you don't use a type checker, that information is ignored without any runtime overhead.
Read on in Why? or watch this short video if you're intrigued:
Project Links
Release Information
Added
-
Python 3.13 support.
-
svcs.Registry
now implements a__iter__
method that allows to iterate over its registered services. #106
Removed
- Python 3.8 support.
Changed
-
Flask: The registry is now stored on
app.extensions
, notapp.config
. This is an implementation detail. If you are directly accessing the registry viaapp.config
, this is a breaking change, though you should ideally move tosvcs.flask.registry
anyway. #71 #72 #73 -
Registry.register_factory()
is now more lenient regarding the arguments of the factory. It only looks at the first argument (if present) and ignores the rest. #110
Fixed
-
Container.aget()
now also enters and exits synchronous context managers. #93 -
Container.aget()
now also enters and exits context managers that are returned by async factories. #105
Credits
svcs is written by Hynek Schlawack and distributed under the terms of the MIT license.
The development is kindly supported by my employer Variomedia AG and all my fabulous GitHub Sponsors.
The Bestagon radar logo is made by Lynn Root, based on an Font Awesome icon. svcs has started out as a wrapper around wired by Michael Merickel and has been heavily influenced by it.