chore: apply suggestion
Changed `add_background_task` to `add_behavior` and added extra docs.
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
import asyncio
|
||||
import logging
|
||||
from abc import ABC, abstractmethod
|
||||
from collections.abc import Coroutine
|
||||
from dataclasses import dataclass
|
||||
|
||||
# Central directory to resolve agent names to instances
|
||||
@@ -69,7 +70,7 @@ class BaseAgent(ABC):
|
||||
await self.setup()
|
||||
|
||||
# Start processing inbox
|
||||
await self.add_background_task(self._process_inbox())
|
||||
await self.add_behavior(self._process_inbox())
|
||||
|
||||
async def stop(self):
|
||||
"""Stops the agent."""
|
||||
@@ -98,8 +99,13 @@ class BaseAgent(ABC):
|
||||
"""Override this to handle incoming messages."""
|
||||
raise NotImplementedError
|
||||
|
||||
async def add_background_task(self, coro):
|
||||
"""Helper to add a behavior to the agent."""
|
||||
async def add_behavior(self, coro: Coroutine):
|
||||
"""
|
||||
Helper to add a behavior to the agent. To add asynchronous behavior to an agent, define
|
||||
an `async` function and add it to the task list by calling :func:`add_background_task`
|
||||
with it. This should happen in the :func:`setup` method of the agent. For an example, see:
|
||||
:func:`~control_backend.agents.bdi.BDICoreAgent`.
|
||||
"""
|
||||
task = asyncio.create_task(coro)
|
||||
self._tasks.add(task)
|
||||
task.add_done_callback(self._tasks.discard)
|
||||
|
||||
Reference in New Issue
Block a user