minos.common.builders

Classes

`BuildableMixin`	Buildable Mixin class.
`Builder`	Builder class.

class Builder[source]

Bases: SetupMixin, ABC, Generic[Instance]

Builder class.

__init__(instance_cls=None, *args, **kwargs)[source]

Parameters: instance_cls (Optional[type[~Instance]]) –

copy()[source]

Get a copy of the instance.

Returns: A Builder instance.
Parameters: self (type[~B]) –
Return type: B

classmethod new()[source]

Get a new instance.

Returns: A Builder instance.
Return type: B

with_cls(cls)[source]

Set class to be built.

Parameters

cls (type) – The class to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B

with_kwargs(kwargs)[source]

Set kwargs.

Parameters

kwargs (dict[str, Any]) – The kwargs to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B

with_config(config)[source]

Set config.

Parameters

config (Config) – The config to be set.
self (B) –

Returns

This method return the builder instance.

Return type

B

build()[source]

Build the instance.

Returns: A Instance instance.
Return type: Instance

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

async destroy()

Destroy miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.
kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

class BuildableMixin[source]

Bases: SetupMixin

Buildable Mixin class.

classmethod set_builder(builder)[source]

Set a builder class.

Parameters: builder (Union[Builder[Ins], type[minos.common.builders.Builder[~Ins]]]) – The builder class to be set.
Returns: This method does not return anything.
Return type: None

classmethod get_builder()[source]

Get the builder class.

Returns: A Builder instance.
Return type: Builder[Ins]

__init__(*args, already_setup=False, **kwargs)

Parameters: already_setup (bool) –

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

async destroy()

Destroy miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.
kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None