aries_cloudagent.config package

Submodules

aries_cloudagent.config.argparse module

Command line option parsing.

class aries_cloudagent.config.argparse.AdminGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Admin server settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Admin'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add admin-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>)

Extract admin settings.

class aries_cloudagent.config.argparse.ArgumentGroup

Bases: abc.ABC

A class representing a group of related command line arguments.

GROUP_NAME = None

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add arguments to the provided argument parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract settings from the parsed arguments.

class aries_cloudagent.config.argparse.DebugGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Debug settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Debug'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add debug command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract debug settings.

class aries_cloudagent.config.argparse.GeneralGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

General settings.

CATEGORIES = ('general', 'start')

GROUP_NAME = 'General'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add general command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract general settings.

class aries_cloudagent.config.argparse.LedgerGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Ledger settings.

CATEGORIES = ('start', 'general')

GROUP_NAME = 'Ledger'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add ledger-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract ledger settings.

class aries_cloudagent.config.argparse.LoggingGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Logging settings.

CATEGORIES = ('general', 'start')

GROUP_NAME = 'Logging'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add logging-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract logging settings.

class aries_cloudagent.config.argparse.MediationGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Mediation settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Mediation'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add mediation command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>)

Extract mediation settings.

class aries_cloudagent.config.argparse.MultitenantGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Multitenant settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Multitenant'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add multitenant-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>)

Extract multitenant settings.

class aries_cloudagent.config.argparse.ProtocolGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Protocol settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Protocol'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add protocol-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Get protocol settings.

class aries_cloudagent.config.argparse.StartupGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Startup settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Start-up'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add startup-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>)

Extract startup settings.

class aries_cloudagent.config.argparse.TransportGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Transport settings.

CATEGORIES = ('start',)

GROUP_NAME = 'Transport'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add transport-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>)

Extract transport settings.

class aries_cloudagent.config.argparse.WalletGroup

Bases: aries_cloudagent.config.argparse.ArgumentGroup

Wallet settings.

CATEGORIES = ('general', 'start')

GROUP_NAME = 'Wallet'

add_arguments(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>)

Add wallet-specific command line arguments to the parser.

get_settings(args: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f1fd650>) → dict

Extract wallet settings.

aries_cloudagent.config.argparse.create_argument_parser(*, prog: str = None)

Create am instance of an arg parser, force yaml format for external config.

class aries_cloudagent.config.argparse.group(*categories)

Bases: object

Decorator for registering argument groups.

classmethod get_registered(category: str = None)

Fetch the set of registered classes in a category.

aries_cloudagent.config.argparse.load_argument_groups(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f760f2cb7d0>, *groups)

Log a set of argument groups into a parser.

Returns:A callable to convert loaded arguments into a settings dictionary

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[Inject], settings: Mapping[str, object] = None, *, required: bool = True) → Optional[Inject]

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.core.error.BaseError

A base exception for all configuration errors.

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

Bases: aries_cloudagent.config.base.ConfigError

The base exception raised by Injector and Provider 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.base_context module

Base injection context builder classes.

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

Bases: abc.ABC

Base injection context builder class.

build_context() → aries_cloudagent.config.injection_context.InjectionContext

Build the base injection context.

update_settings(settings: Mapping[str, object])

Update the context builder with additional settings.

aries_cloudagent.config.default_context module

Classes for configuring the default injection context.

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

Bases: aries_cloudagent.config.base_context.ContextBuilder

Default context builder.

bind_providers(context: aries_cloudagent.config.injection_context.InjectionContext)

Bind various class providers.

build_context() → aries_cloudagent.config.injection_context.InjectionContext

Build the base injection context; set DIDComm prefix to emit.

load_plugins(context: aries_cloudagent.config.injection_context.InjectionContext)

Set up plugin registry and load plugins.

aries_cloudagent.config.error module

Errors for config modules.

exception aries_cloudagent.config.error.ArgsParseError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.config.base.ConfigError

Error raised when there is a problem parsing the command-line arguments.

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[Inject], settings: Mapping[str, object] = None, *, required: bool = True) → Optional[Inject]

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.InjectionError

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[Inject], instance: Inject)

Add a static instance as a class binding.

bind_provider(base_cls: Type[Inject], provider: aries_cloudagent.config.base.BaseProvider, *, cache: bool = False)

Add a dynamic instance resolver as a class binding.

clear_binding(base_cls: Type[Inject])

Remove a previously-added binding.

copy() → aries_cloudagent.config.base.BaseInjector

Produce a copy of the injector instance.

get_provider(base_cls: Type[Inject])

Find the provider associated with a class binding.

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

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.ledger module

Ledger configuration.

aries_cloudagent.config.ledger.accept_taa(ledger: aries_cloudagent.ledger.base.BaseLedger, taa_info, provision: bool = False) → bool

Perform TAA acceptance.

aries_cloudagent.config.ledger.fetch_genesis_transactions(genesis_url: str) → str

Get genesis transactions.

aries_cloudagent.config.ledger.get_genesis_transactions(settings: aries_cloudagent.config.settings.Settings) → str

Fetch genesis transactions if necessary.

aries_cloudagent.config.ledger.ledger_config(profile: aries_cloudagent.core.profile.Profile, public_did: str, provision: bool = False) → bool

Perform Indy ledger configuration.

aries_cloudagent.config.logging module

Utilities related to logging.

class aries_cloudagent.config.logging.LoggingConfigurator

Bases: object

Utility class used to configure logging and print an informative start banner.

classmethod configure(logging_config_path: str = None, log_level: str = None, log_file: str = None)

Configure logger.

Parameters:

• logging_config_path – str: (Default value = None) Optional path to custom logging config
• log_level – str: (Default value = None)

classmethod print_banner(agent_label, inbound_transports, outbound_transports, public_did, admin_server=None, banner_length=40, border_character=':')

Print a startup banner describing the configuration.

Parameters:

• agent_label – Agent Label
• inbound_transports – Configured inbound transports
• outbound_transports – Configured outbound transports
• admin_server – Admin server info
• public_did – Public DID
• banner_length – (Default value = 40) Length of the banner
• border_character – (Default value = “:”) Character to use in banner
• border –

aries_cloudagent.config.logging.load_resource(path: str, encoding: str = None) → TextIO

Open a resource file located in a python package or the local filesystem.

Parameters:path – The resource path in the form of dir/file or package:dir/file Returns:A file-like object representing the resource

aries_cloudagent.config.provider module

Service provider implementations.

class aries_cloudagent.config.provider.CachedProvider(provider: aries_cloudagent.config.base.BaseProvider, unique_settings_keys: tuple = ())

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.

Instances are cached keyed on a SHA256 digest of the relevant subset of settings.

class aries_cloudagent.config.provider.ClassProvider(instance_cls: Union[str, type], *ctor_args, init_method: 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

update(other: Mapping[str, object])

Update the settings in place.

aries_cloudagent.config.util module

Entrypoint.

class aries_cloudagent.config.util.ByteSize(min_size: int = 0, max_size: int = 0)

Bases: object

Argument value parser for byte sizes.

aries_cloudagent.config.util.common_config(settings: Mapping[str, Any])

Perform common app configuration.

aries_cloudagent.config.wallet module

Wallet configuration.

aries_cloudagent.config.wallet.wallet_config(context: aries_cloudagent.config.injection_context.InjectionContext, provision: bool = False) -> (<class 'aries_cloudagent.core.profile.Profile'>, <class 'aries_cloudagent.wallet.base.DIDInfo'>)

Initialize the root profile.