beamlime.constructors.providers.ProviderGroup

class beamlime.constructors.providers.ProviderGroup(*initial_providers)

Group of providers.

__init__(*initial_providers)

Initializes an empty internal provider dictionary and fills it with the initial providers from the argument.

Methods

__init__(*initial_providers)	Initializes an empty internal provider dictionary and fills it with the initial providers from the argument.
clear()	Clear all providers of this group.
items()	rtype: ItemsView[type[TypeVar(Product)], Provider[TypeVar(Product)]]
keys()	rtype: KeysView[type[TypeVar(Product)]]
merge(*others)	Merge other provider groups into this group after checking conflicts.
pop(product_type)	Remove and return the provider of product_type.
provider([provider_call, provider_type])	Register the decorated callable into this group.
values()	rtype: ValuesView[Provider[TypeVar(Product)]]

__getitem__(product_type)

Return the provider of the requested product type.

Raises:

ProviderNotFoundError – If there is any providers for the requested product type.

Return type:

Provider[TypeVar(Product)]

clear()

Clear all providers of this group.

Return type:

None

merge(*others)

Merge other provider groups into this group after checking conflicts.

Return type:

None

pop(product_type)

Remove and return the provider of product_type. Return UnknownProvider if not found.

Return type:

Provider[TypeVar(Product)]

provider(provider_call=None, /, *, provider_type=None)

Register the decorated callable into this group. The product type will be retrieved from the annotation.

Return type:

Callable[[Callable[..., TypeVar(Product)] | type[TypeVar(Product)]], Callable[..., TypeVar(Product)] | type[TypeVar(Product)]] | Callable[..., TypeVar(Product)] | type[TypeVar(Product)]

Examples

>>> from beamlime import ProviderGroup
>>> from typing import Literal
>>> number_providers = ProviderGroup()
>>> @number_providers.provider
... def give_one() -> Literal[1]:
...   return 1
...
>>> number_providers[Literal[1]]() == 1
True