aea.registries.resources
This module contains the resources class.
Resources
class Resources()
This class implements the object that holds the resources of an AEA.
__init__
| __init__(directory: Optional[Union[str, os.PathLike]] = None)
Instantiate the resources.
Arguments:
directory: the path to the directory which contains the resources (skills, connections and protocols)
add_component
| add_component(component: Component)
Add a component to resources.
add_protocol
| add_protocol(protocol: Protocol) -> None
Add a protocol to the set of resources.
Arguments:
protocol: a protocol
Returns:
None
get_protocol
| get_protocol(protocol_id: ProtocolId) -> Optional[Protocol]
Get protocol for given protocol id.
Arguments:
protocol_id: the protocol id
Returns:
a matching protocol, if present, else None
get_all_protocols
| get_all_protocols() -> List[Protocol]
Get the list of all the protocols.
Returns:
the list of protocols.
remove_protocol
| remove_protocol(protocol_id: ProtocolId) -> None
Remove a protocol from the set of resources.
Arguments:
protocol_id: the protocol id for the protocol to be removed.
Returns:
None
add_contract
| add_contract(contract: Contract) -> None
Add a contract to the set of resources.
Arguments:
contract: a contract
Returns:
None
get_contract
| get_contract(contract_id: ContractId) -> Optional[Contract]
Get contract for given contract id.
Arguments:
contract_id: the contract id
Returns:
a matching contract, if present, else None
get_all_contracts
| get_all_contracts() -> List[Contract]
Get the list of all the contracts.
Returns:
the list of contracts.
remove_contract
| remove_contract(contract_id: ContractId) -> None
Remove a contract from the set of resources.
Arguments:
contract_id: the contract id for the contract to be removed.
Returns:
None
add_skill
| add_skill(skill: Skill) -> None
Add a skill to the set of resources.
Arguments:
skill: a skill
Returns:
None
get_skill
| get_skill(skill_id: SkillId) -> Optional[Skill]
Get the skill for a given skill id.
Arguments:
skill_id: the skill id
Returns:
a matching skill, if present, else None
get_all_skills
| get_all_skills() -> List[Skill]
Get the list of all the skills.
Returns:
the list of skills.
remove_skill
| remove_skill(skill_id: SkillId) -> None
Remove a skill from the set of resources.
Arguments:
skill_id: the skill id for the skill to be removed.
Returns:
None
get_handler
| get_handler(protocol_id: ProtocolId, skill_id: SkillId) -> Optional[Handler]
Get a specific handler.
Arguments:
protocol_id: the protocol id the handler is handlingskill_id: the skill id of the handler's skill
Returns:
the handler
get_handlers
| get_handlers(protocol_id: ProtocolId) -> List[Handler]
Get all handlers for a given protocol.
Arguments:
protocol_id: the protocol id the handler is handling
Returns:
the list of handlers matching the protocol
get_all_handlers
| get_all_handlers() -> List[Handler]
Get all handlers from all skills.
Returns:
the list of handlers
get_behaviour
| get_behaviour(skill_id: SkillId, behaviour_name: str) -> Optional[Behaviour]
Get a specific behaviours for a given skill.
Arguments:
skill_id: the skill idbehaviour_name: the behaviour name
Returns:
the behaviour, if it is present, else None
get_behaviours
| get_behaviours(skill_id: SkillId) -> List[Behaviour]
Get all behaviours for a given skill.
Arguments:
skill_id: the skill id
Returns:
the list of behaviours of the skill
get_all_behaviours
| get_all_behaviours() -> List[Behaviour]
Get all behaviours from all skills.
Returns:
the list of all behaviours
setup
| setup() -> None
Set up the resources.
Calls setup on all resources.
Returns:
None
teardown
| teardown() -> None
Teardown the resources.
Calls teardown on all resources.
Returns:
None