aea.skills.base
This module contains the base classes for the skills.
SkillContext
class SkillContext()
This class implements the context of a skill.
__init__
| __init__(agent_context: Optional[AgentContext] = None, skill: Optional["Skill"] = None)
Initialize a skill context.
set_agent_context
| set_agent_context(agent_context: AgentContext) -> None
Set the agent context.
shared_state
| @property
| shared_state() -> Dict[str, Any]
Get the shared state dictionary.
agent_name
| @property
| agent_name() -> str
Get agent name.
skill_id
| @property
| skill_id() -> PublicId
Get the skill id of the skill context.
is_active
| @is_active.setter
| is_active(value: bool) -> None
Set the status of the skill (active/not active).
new_behaviours
| @property
| new_behaviours() -> Queue
The queue for the new behaviours.
This queue can be used to send messages to the framework to request the registration of a behaviour.
:return the queue of new behaviours.
agent_addresses
| @property
| agent_addresses() -> Dict[str, str]
Get addresses.
agent_address
| @property
| agent_address() -> str
Get address.
connection_status
| @property
| connection_status() -> ConnectionStatus
Get connection status.
outbox
| @property
| outbox() -> OutBox
Get outbox.
message_in_queue
| @property
| message_in_queue() -> Queue
Get message in queue.
decision_maker_message_queue
| @property
| decision_maker_message_queue() -> Queue
Get message queue of decision maker.
decision_maker_handler_context
| @property
| decision_maker_handler_context() -> SimpleNamespace
Get decision maker handler context.
task_manager
| @property
| task_manager() -> TaskManager
Get behaviours of the skill.
ledger_apis
| @property
| ledger_apis() -> LedgerApis
Get ledger APIs.
search_service_address
| @property
| search_service_address() -> Address
Get the address of the search service.
handlers
| @property
| handlers() -> SimpleNamespace
Get handlers of the skill.
behaviours
| @property
| behaviours() -> SimpleNamespace
Get behaviours of the skill.
contracts
| @property
| contracts() -> SimpleNamespace
Get contracts the skill has access to.
namespace
| @property
| namespace() -> SimpleNamespace
Get the agent context namespace.
__getattr__
| __getattr__(item) -> Any
Get attribute.
SkillComponent
class SkillComponent(ABC)
This class defines an abstract interface for skill component classes.
__init__
| __init__(name: str, skill_context: SkillContext, configuration: Optional[SkillComponentConfiguration] = None, **kwargs, ,)
Initialize a skill component.
Arguments:
name: the name of the component.configuration: the configuration for the component.skill_context: the skill context.
name
| @property
| name() -> str
Get the name of the skill component.
context
| @property
| context() -> SkillContext
Get the context of the skill component.
skill_id
| @property
| skill_id() -> PublicId
Get the skill id of the skill component.
configuration
| @property
| configuration() -> SkillComponentConfiguration
Get the skill component configuration.
config
| @property
| config() -> Dict[Any, Any]
Get the config of the skill component.
setup
| @abstractmethod
| setup() -> None
Implement the setup.
Returns:
None
teardown
| @abstractmethod
| teardown() -> None
Implement the teardown.
Returns:
None
parse_module
| @classmethod
| @abstractmethod
| parse_module(cls, path: str, configs: Dict[str, SkillComponentConfiguration], skill_context: SkillContext)
Parse the component module.
AbstractBehaviour
class AbstractBehaviour(SkillComponent, ABC)
Abstract behaviour for periodical calls.
tick_interval: float, interval to call behaviour's act. start_at: optional datetime, when to start periodical calls.
Behaviour
class Behaviour(AbstractBehaviour, ABC)
This class implements an abstract behaviour.
act
| @abstractmethod
| act() -> None
Implement the behaviour.
Returns:
None
is_done
| is_done() -> bool
Return True if the behaviour is terminated, False otherwise.
act_wrapper
| act_wrapper() -> None
Wrap the call of the action. This method must be called only by the framework.
parse_module
| @classmethod
| parse_module(cls, path: str, behaviour_configs: Dict[str, SkillComponentConfiguration], skill_context: SkillContext) -> Dict[str, "Behaviour"]
Parse the behaviours module.
Arguments:
path: path to the Python module containing the Behaviour classes.behaviour_configs: a list of behaviour configurations.skill_context: the skill context
Returns:
a list of Behaviour.
Handler
class Handler(SkillComponent, ABC)
This class implements an abstract behaviour.
handle
| @abstractmethod
| handle(message: Message) -> None
Implement the reaction to a message.
Arguments:
message: the message
Returns:
None
parse_module
| @classmethod
| parse_module(cls, path: str, handler_configs: Dict[str, SkillComponentConfiguration], skill_context: SkillContext) -> Dict[str, "Handler"]
Parse the handler module.
Arguments:
path: path to the Python module containing the Handler class.handler_configs: the list of handler configurations.skill_context: the skill context
Returns:
an handler, or None if the parsing fails.
Model
class Model(SkillComponent, ABC)
This class implements an abstract model.
setup
| setup() -> None
Set the class up.
teardown
| teardown() -> None
Tear the class down.
parse_module
| @classmethod
| parse_module(cls, path: str, model_configs: Dict[str, SkillComponentConfiguration], skill_context: SkillContext) -> Dict[str, "Model"]
Parse the tasks module.
Arguments:
path: path to the Python skill module.model_configs: a list of model configurations.skill_context: the skill context
Returns:
a list of Model.
Skill
class Skill(Component)
This class implements a skill.
__init__
| __init__(configuration: SkillConfig, skill_context: Optional[SkillContext] = None, handlers: Optional[Dict[str, Handler]] = None, behaviours: Optional[Dict[str, Behaviour]] = None, models: Optional[Dict[str, Model]] = None)
Initialize a skill.
Arguments:
configuration: the skill configuration.
contracts
| @property
| contracts() -> Dict[str, Contract]
Get the contracts associated with the skill.
inject_contracts
| inject_contracts(contracts: Dict[str, Contract]) -> None
Add the contracts to the skill.
skill_context
| @property
| skill_context() -> SkillContext
Get the skill context.
handlers
| @property
| handlers() -> Dict[str, Handler]
Get the handlers.
behaviours
| @property
| behaviours() -> Dict[str, Behaviour]
Get the handlers.
models
| @property
| models() -> Dict[str, Model]
Get the handlers.
from_dir
| @classmethod
| from_dir(cls, directory: str, skill_context: Optional[SkillContext] = None) -> "Skill"
Load the skill from a directory.
Arguments:
directory: the directory to the skill package.skill_context: the skill context
Returns:
the skill object.
from_config
| @classmethod
| from_config(cls, configuration: SkillConfig, skill_context: Optional[SkillContext] = None) -> "Skill"
Load the skill from configuration.
Arguments:
configuration: a skill configuration. Must be associated with a directory.
Returns:
the skill.