Skip to main content

A Flexible Service Locator

Project description

svcs logo showing a hexagon-shaped radar

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:

Watch the video

Project Links

Release Information

Fixed

  • AIOHTTP: The registry is now stored using aiohttp.web.AppKeys on the application. This is an implementation detail and shouldn't matter, but it fixes a warning on AIOHTTP 3.9 and later.

Full Changelog →

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

svcs-24.1.0.tar.gz (710.5 kB view details)

Uploaded Source

Built Distribution

svcs-24.1.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file svcs-24.1.0.tar.gz.

File metadata

  • Download URL: svcs-24.1.0.tar.gz
  • Upload date:
  • Size: 710.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for svcs-24.1.0.tar.gz
Algorithm Hash digest
SHA256 7419980475dd6b8e256e072c895c84cfe40d4da1ee944145f98724f2985dfd1f
MD5 490d38add0c4bd915f9c354d665f817b
BLAKE2b-256 0035d04e27a2c15dc948155eb4635338e9f2c66c5d0b68e1abee4eca887661f3

See more details on using hashes here.

File details

Details for the file svcs-24.1.0-py3-none-any.whl.

File metadata

  • Download URL: svcs-24.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for svcs-24.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f050f4a6fcf163aa3a5d5e17b66bbf5efa3ed2164018aebecd70fc27794ecf6b
MD5 2563967325ecd6b87131412ec38172da
BLAKE2b-256 5575795347abe56c4012fd511af35db80370f1461aa443546a83b32d65a19bbb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page