harp.services.models

class BaseServiceDefinitionCollection

Bases: BaseModel

Base class for coherent sequences of services. The traverse() method can be used to get a flat iterator over all the service definitions in the collection and its children, ordered.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

bind_settings(settings)

Parameters:

settings (Any)

traverse()

Return type:

Iterable[ServiceDefinition]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

services: Sequence[Annotated[Annotated[ServiceDefinition, Tag(tag=service)] | Annotated[BaseServiceDefinitionCollection, Tag(tag=collection)] | Annotated[ConditionalServiceDefinitionCollection, Tag(tag=conditional_collection)], Discriminator(discriminator=_discriminator, custom_error_type=None, custom_error_message=None, custom_error_context=None)]]

class ConditionalServiceDefinitionCollection

Bases: BaseServiceDefinitionCollection

A collection of services that are only registered if a condition is met. This is useful for conditional service registration, for example based on a configuration value.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

bind_settings(settings)

Parameters:

settings (Any)

traverse()

Return type:

Iterable[ServiceDefinition]

condition: str | bool | LazySettingReference | Sequence[str | bool | LazySettingReference] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ServiceDefinition

Bases: BaseModel

Describes a service that our container is able to register. Services within a collection can override each other, if explicitely stated. This is useful for conditional service change (for example, based on a configuration value).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

bind_settings(settings)

Parameters:

settings (Any)

override_with(other)

Parameters:

other (Self)

Return type:

Self

arguments: Mapping[str, Any] | Sequence[Mapping[str, Any] | LazySettingReference] | None

base: str | LazySettingReference | LazyServiceReference | Sequence[str | LazySettingReference | LazyServiceReference] | None

base type for service, aka the interface we are implementing, if different from type

constructor: str | LazySettingReference | LazyServiceReference | Sequence[str | LazySettingReference | LazyServiceReference] | None

constructor name, if not default one

defaults: Mapping[str, Any] | Sequence[Mapping[str, Any] | LazySettingReference] | None

description: str | None

service description, for documentation and readbility purposes

lifestyle: Literal['singleton', 'transient', 'scoped'] | None

service lifestyle

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

service name (todo: constraints ?)

override: str | None

condition to be met for the service to register or override another one

positionals: Tuple[Any, ...] | None

positionnal arguments for the service constructor.

type: str | LazySettingReference | LazyServiceReference | Sequence[str | LazySettingReference | LazyServiceReference] | None

service type, aka the implementation we are using, if different from base

class ServiceDefinitionCollection

Bases: BaseServiceDefinitionCollection

Final class for a service collection. Iterate on it to get a flattened (one level) and merged (services with same name that allows overrides are merged together) list of services.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

classmethod model_validate_yaml(filename)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].