Skip to main content

component.backend_component

BackendComponent Objects​

class BackendComponent()

Base class for all project components.

Components are always based on this class. It mainly maintains an instance of the Core, but also stores general information about the component itself and the entire project.

__init__​

def __init__(comp_id: UnitID,
             comp_name: str,
             role: ComponentRole,
             *,
             module_name: str,
             config_file: str = "./.config/config.toml")

Arguments:

  • comp_id - The identifier of this component.
  • comp_name - The display name of this component.
  • role - The role of this component.
  • module_name - The component module name; simply pass __name__ here.
  • config_file - The configuration file to load.

app​

def app() -> typing.Any

Creates a WSGI application object that can be used to be run by a gateway service.

Returns:

The WSGI application object.

run​

def run() -> None

Starts the component's execution cycles.

Notes:

It is mandatory to call this method after creating and setting up a component.

create_service​

def create_service(
        name: str,
        *,
        context_type: type["ServiceContextType"] | None = None) -> "Service"

Creates and registers a new service.

Arguments:

  • name - The name of the service.
  • context_type - Can be used to override the default ServiceContext type. All message handlers associated with the new service will then receive instances of this type for their service context.

Returns:

The newly created service.

data​

@property
def data() -> BackendComponentData

A data helper object that stores useful component data and information.

instance​

@staticmethod
def instance() -> "BackendComponent"

The global BackendComponent instance.

Raises:

  • RuntimeError - If no instance has been created.