Skip to content

aea.components.base

This module contains definitions of agent components.

Component Objects

class Component(ABC, WithLogger)

Abstract class for an agent component.

__init__

def __init__(configuration: Optional[ComponentConfiguration] = None,
             is_vendor: bool = False,
             **kwargs: Any) -> None

Initialize a package.

Arguments:

  • configuration: the package configuration.
  • is_vendor: whether the package is vendorized.
  • kwargs: the keyword arguments for the logger.

component_type

@property
def component_type() -> ComponentType

Get the component type.

is_vendor

@property
def is_vendor() -> bool

Get whether the component is vendorized or not.

prefix_import_path

@property
def prefix_import_path() -> str

Get the prefix import path for this component.

component_id

@property
def component_id() -> ComponentId

Ge the package id.

public_id

@property
def public_id() -> PublicId

Get the public id.

configuration

@property
def configuration() -> ComponentConfiguration

Get the component configuration.

directory

@property
def directory() -> Path

Get the directory. Raise error if it has not been set yet.

directory

@directory.setter
def directory(path: Path) -> None

Set the directory. Raise error if already set.

build_directory

@property
def build_directory() -> Optional[str]

Get build directory for the component.

load_aea_package

def load_aea_package(configuration: ComponentConfiguration) -> None

Load the AEA package from configuration.

It adds all the init.py modules into sys.modules.

Arguments:

  • configuration: the configuration object.

perform_load_aea_package

def perform_load_aea_package(dir_: Path, author: str, package_type_plural: str,
                             package_name: str) -> None

Load the AEA package from values provided.

It adds all the init.py modules into sys.modules.

Arguments:

  • dir_: path of the component.
  • author: str
  • package_type_plural: str
  • package_name: str