cfitall.manager.ProviderManager

class ProviderManager(providers=None)

Bases: object

The ProviderManager manages configuration providers, handling registration, deregistration and ordering. It is attached to a registry’s providers attribute.

Parameters

providers (Optional[List[ConfigProviderBase]]) – optional list of preconfigured providers to manage

Methods

deregister

Deregisters a provider from the manager

get

Retrieves a reference to the named provider from the manager.

register

Registers a provider with the manager.

update_all

Triggers each registered provider to run its update() function, updating the values it will return.

Attributes

ordering

list determining the order in which providers are merged

deregister(provider_name)

Deregisters a provider from the manager

Parameters

provider_name (str) –

Return type

None

get(name)

Retrieves a reference to the named provider from the manager.

Parameters

name (str) – friendly name of a registered provider

Return type

Optional[ConfigProviderBase]

Returns

provider instance or None

ordering: List[str]

list determining the order in which providers are merged

register(provider)

Registers a provider with the manager.

Parameters

provider (ConfigProviderBase) – an instance of a configured provider

Return type

None

update_all()

Triggers each registered provider to run its update() function, updating the values it will return.

Return type

None