Skip to main content

A Flexible Service Locator

Project description

svcs logo showing a hexagon-shaped radar

A Flexible Service Locator for Python.

WARNING ☠️ Not ready yet! ☠️

This project is only public to gather feedback, and everything can and will change until the project is proclaimed stable.

The code has 100% test and type coverage, and the shipped Flask and Pyramid integrations have been in production for years, but the API details can still change.

svcs (pronounced services) is a dependency container for Python. It gives you a central place to register factories for types/interfaces and then imperatively request 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,
  • and allows for easy health checks across all services.

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? if you're intrigued!

Project Links

Release Information

Changed

  • Various optimizations & cleanups.

→ 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-23.19.0.tar.gz (697.5 kB view details)

Uploaded Source

Built Distribution

svcs-23.19.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for svcs-23.19.0.tar.gz
Algorithm Hash digest
SHA256 c9a33da0fe769c683bf08f0861f312634d60fd02a0ad38aca339124418003bcc
MD5 194938f3f68e5259f6bc18fbb15d7087
BLAKE2b-256 202e00adb48da217ad132afe2ae341ae330fa27fadf25aa6a92dc7b1d6e9c711

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for svcs-23.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bcc2957b9d904ad2bea718ff6558c06b95b4b2110d3b08b913c045fbceca6f67
MD5 43aee6244e3f5db999035c20a0ccb27c
BLAKE2b-256 01c18b88088ee008f7ced6d620ee6f9220e9055fc02e951789125061b4a19028

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