koi_net.infra.component

Defines decorators for manipulating component metadata, informing the assembly process.

Functions

depends_on(*components)	Decorator that declares the dependencies of a start or stop method in a component class.
provides(component_type)	Decorator for a component that overrides its type.

Classes

CompType(*values)

Defines component types.

class koi_net.infra.component.CompType(*values)

Bases: StrEnum

Defines component types.

Singletons are callable components (typically classes) which need to be instantiated prior to use. They define their dependencies in their function signature (this is __init__ for classes).

Objects are constant components that are simply passed “as is.”

OBJECT = 'OBJECT'

SINGLETON = 'SINGLETON'

koi_net.infra.component.depends_on(*components)

Decorator that declares the dependencies of a start or stop method in a component class.

Example:

from koi_net.infra import depends_on

class MyComponent:
    @depends_on("another_component")
    def start(self):
        ...

koi_net.infra.component.provides(component_type)

Decorator for a component that overrides its type.

This is typically used to pass a class “as is.” Example:

from koi_net.infra import provides, CompType

@provides(CompType.OBJECT)
class MyClassComponent:
    ...

Parameters:

component_type (CompType)