aries_cloudagent.config package

Subpackages

• aries_cloudagent.config.tests package
  • Submodules
  • aries_cloudagent.config.tests.test_injection_context module
  • aries_cloudagent.config.tests.test_injector module
  • aries_cloudagent.config.tests.test_settings module

Submodules

aries_cloudagent.config.base module

Configuration base classes.

class aries_cloudagent.config.base.BaseInjector

Bases: abc.ABC

Base injector class.

copy() → aries_cloudagent.config.base.BaseInjector

Produce a copy of the injector instance.

inject(base_cls: type, settings: Mapping[str, object] = None, *, required: bool = True) → object

Get the provided instance of a given class identifier.

Parameters:

• cls – The base class to retrieve an instance of
• settings – An optional mapping providing configuration to the provider

Returns:

An instance of the base class, or None

class aries_cloudagent.config.base.BaseProvider

Bases: abc.ABC

Base provider class.

provide(settings: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Provide the object instance given a config and injector.

class aries_cloudagent.config.base.BaseSettings

Bases: collections.abc.Mapping, typing.Generic

Base settings class.

copy() → aries_cloudagent.config.base.BaseSettings

Produce a copy of the settings instance.

extend(other: Mapping[str, object]) → aries_cloudagent.config.base.BaseSettings

Merge another mapping to produce a new settings instance.

get_bool(*var_names, default=None) → bool

Fetch a setting as a boolean value.

Parameters:

• var_names – A list of variable name alternatives
• default – The default value to return if none are defined

get_int(*var_names, default=None) → int

Fetch a setting as an integer value.

Parameters:

• var_names – A list of variable name alternatives
• default – The default value to return if none are defined

get_str(*var_names, default=None) → str

Fetch a setting as a string value.

Parameters:

• var_names – A list of variable name alternatives
• default – The default value to return if none are defined

get_value(*var_names, default=None)

Fetch a setting.

Parameters:

• var_names – A list of variable name alternatives
• default – The default value to return if none are defined

Returns:

The setting value, if defined, otherwise the default value

exception aries_cloudagent.config.base.ConfigError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.error.BaseError

A base exception for all configuration errors.

exception aries_cloudagent.config.base.InjectorError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.config.base.ConfigError

The base exception raised by BaseInjector implementations.

exception aries_cloudagent.config.base.ProviderError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.config.base.ConfigError

The base exception raised by BaseProvider implementations.

exception aries_cloudagent.config.base.SettingsError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.config.base.ConfigError

The base exception raised by BaseSettings implementations.

aries_cloudagent.config.injection_context module

Injection context implementation.

class aries_cloudagent.config.injection_context.InjectionContext(*, settings: Mapping[str, object] = None, enforce_typing: bool = True)

Bases: aries_cloudagent.config.base.BaseInjector

Manager for configuration settings and class providers.

ROOT_SCOPE = 'application'

copy() → aries_cloudagent.config.injection_context.InjectionContext

Produce a copy of the injector instance.

inject(base_cls: type, settings: Mapping[str, object] = None, *, required: bool = True) → object

Get the provided instance of a given class identifier.

Parameters:

• cls – The base class to retrieve an instance of
• settings – An optional mapping providing configuration to the provider

Returns:

An instance of the base class, or None

injector

Accessor for scope-specific injector.

injector_for_scope(scope_name: str) → aries_cloudagent.config.injector.Injector

Fetch the injector for a specific scope.

Parameters:scope_name – The unique scope identifier

scope_name

Accessor for the current scope name.

settings

Accessor for scope-specific settings.

start_scope(scope_name: str, settings: Mapping[str, object] = None) → aries_cloudagent.config.injection_context.InjectionContext

Begin a new named scope.

Parameters:

• scope_name – The unique name for the scope being entered
• settings – An optional mapping of additional settings to apply

Returns:

A new injection context representing the scope

update_settings(settings: Mapping[str, object])

Update the scope with additional settings.

exception aries_cloudagent.config.injection_context.InjectionContextError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.config.base.InjectorError

Base class for issues in the injection context.

class aries_cloudagent.config.injection_context.Scope(name, injector)

Bases: tuple

injector

Alias for field number 1

name

Alias for field number 0

aries_cloudagent.config.injector module

Standard Injector implementation.

class aries_cloudagent.config.injector.Injector(settings: Mapping[str, object] = None, enforce_typing: bool = True)

Bases: aries_cloudagent.config.base.BaseInjector

Injector implementation with static and dynamic bindings.

bind_instance(base_cls: type, instance: object)

Add a static instance as a class binding.

bind_provider(base_cls: type, provider: aries_cloudagent.config.base.BaseProvider, *, cache: bool = False)

Add a dynamic instance resolver as a class binding.

clear_binding(base_cls: type)

Remove a previously-added binding.

copy() → aries_cloudagent.config.base.BaseInjector

Produce a copy of the injector instance.

get_provider(base_cls: type)

Find the provider associated with a class binding.

inject(base_cls: type, settings: Mapping[str, object] = None, *, required: bool = True)

Get the provided instance of a given class identifier.

Parameters:

• cls – The base class to retrieve an instance of
• params – An optional dict providing configuration to the provider

Returns:

An instance of the base class, or None

settings

Accessor for scope-specific settings.

aries_cloudagent.config.provider module

Service provider implementations.

class aries_cloudagent.config.provider.CachedProvider(provider: aries_cloudagent.config.base.BaseProvider)

Bases: aries_cloudagent.config.base.BaseProvider

Cache the result of another provider.

provide(config: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Provide the object instance given a config and injector.

class aries_cloudagent.config.provider.ClassProvider(instance_cls: Union[str, type], *ctor_args, async_init: str = None, **ctor_kwargs)

Bases: aries_cloudagent.config.base.BaseProvider

Provider for a particular class.

class Inject(base_cls: type)

Bases: object

A class for passing injected arguments to the constructor.

provide(config: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Provide the object instance given a config and injector.

class aries_cloudagent.config.provider.InstanceProvider(instance)

Bases: aries_cloudagent.config.base.BaseProvider

Provider for a previously-created instance.

provide(config: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Provide the object instance given a config and injector.

class aries_cloudagent.config.provider.StatsProvider(provider: aries_cloudagent.config.base.BaseProvider, methods: Sequence[str], *, ignore_missing: bool = True)

Bases: aries_cloudagent.config.base.BaseProvider

Add statistics to the results of another provider.

provide(config: aries_cloudagent.config.base.BaseSettings, injector: aries_cloudagent.config.base.BaseInjector)

Provide the object instance given a config and injector.

aries_cloudagent.config.settings module

Settings implementation.

class aries_cloudagent.config.settings.Settings(values: Mapping[str, object] = None)

Bases: aries_cloudagent.config.base.BaseSettings

Mutable settings implementation.

clear_value(var_name: str)

Remove a setting.

Parameters:var_name – The name of the setting

copy() → aries_cloudagent.config.base.BaseSettings

Produce a copy of the settings instance.

extend(other: Mapping[str, object]) → aries_cloudagent.config.base.BaseSettings

Merge another settings instance to produce a new instance.

get_value(*var_names, default=None)

Fetch a setting.

Parameters:

• var_names – A list of variable name alternatives
• default – The default value to return if none are defined

set_default(var_name: str, value)

Add a setting if not currently defined.

Parameters:

• var_name – The name of the setting
• value – The value to assign

set_value(var_name: str, value)

Add a setting.

Parameters:

• var_name – The name of the setting
• value – The value to assign