Skip to main content

No project description provided

Project description

anyioc

GitHub Build Status PyPI

Another simple ioc framework for python.

Usage

from anyioc import ServiceProvider
provider = ServiceProvider()
provider.register_singleton('the key', lambda ioc: 102) # ioc will be a `IServiceProvider`
value = provider.get('the key')
assert value == 102

Details

Features

By default, you can use methods of ServiceProvider to register services with lifetime:

  • register_singleton(key, factory)
  • register_scoped(key, factory)
  • register_transient(key, factory)
  • register(key, factory, lifetime)
  • register_value(key, value)
  • register_group(key, keys)
  • register_bind(new_key, target_key)

Global ServiceProvider

Process scoped

By default, you should create your ServiceProvider.

However, we can use a global ServiceProvider to share services in python process.

from anyioc.g import ioc

# ioc is a global `ServiceProvider` instance

Module scoped and namespace scoped

Also we have module scoped ServiceProvider and namespace scoped ServiceProvider.

If you have a project:

src/
  |- your_package/
     |- __init__.py
     |- a/
        |- __init__.py
        |- b.py

Then module scoped ServiceProvider:

# file: b.py
from anyioc.g import get_module_provider

provider = get_module_provider()
assert provider is get_module_provider('your_package.a.b')

and namespace scoped ServiceProvider:

# file: b.py
from anyioc.g import get_namespace_provider

provider = get_namespace_provider()
assert provider is get_module_provider('your_package')

Predefined keys

There are some predefined string keys you can use direct, but you still can overwrite it:

  • ioc - get current scoped ServiceProvider instance.
  • provider - alias of ioc
  • service_provider - alias of ioc

And predefined types:

  • ServiceProvider
  • IServiceProvider

provider.get() vs provider[]

There are two ways to get services from ServiceProvider:

  • provider[] will raise ServiceNotFoundError if the service was not found;
  • provider.get() only return None if the service was not found.

IServiceInfoResolver

By default, you can get a service after you register it;

If you want to dynamic get it without register, you can do that by use IServiceInfoResolver:

from anyioc import ServiceProvider
from anyioc.symbols import Symbols
from anyioc.ioc_resolver import ImportServiceInfoResolver

import sys
provider = ServiceProvider()
provider[Symbols.missing_resolver].append(ImportServiceInfoResolver().cache())
assert sys is provider['sys']

.cache() can cache the results.

There are other builtin resolvers:

  • ImportServiceInfoResolver - import module by name from a str key
  • TypesServiceInfoResolver - create instance by type from a type key
  • TypeNameServiceInfoResolver - create instance by type name from a str key
  • TypingServiceInfoResolver - get services tuple by keys from a typing.Tuple key.

Project details


Download files

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

Files for anyioc, version 0.9.0
Filename, size File type Python version Upload date Hashes
Filename, size anyioc-0.9.0-py3-none-any.whl (14.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size anyioc-0.9.0.tar.gz (11.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page