wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename BaseTask → BaseWorker and reserve "task" for asyncio

Browse Source 
Replaces every "task" identifier that referred to the BaseTask
abstraction with "worker". Asyncio task plumbing (asyncio.Task,
BaseTaskManager, TaskManager, create_task, cancel_task, etc.) stays
untouched. Highlights:

- Classes: BaseTask → BaseWorker, PipelineTask → PipelineWorker,
  LLMTask → LLMWorker, LLMContextTask → LLMContextWorker, TaskBus →
  WorkerBus, TaskRegistry → WorkerRegistry, TaskActivationArgs →
  WorkerActivationArgs, TaskReadyData → WorkerReadyData,
  TaskRegistryEntry → WorkerRegistryEntry, TaskObserver →
  WorkerObserver, all Bus*TaskMessage → Bus*WorkerMessage,
  BusAddTaskMessage.task field → worker, BusWorkerRegistryMessage.tasks
  field → workers.
- Methods/decorators: activate_task → activate_worker, deactivate_task
  → deactivate_worker, add_task → add_worker, watch_task →
  watch_worker, @task_ready → @worker_ready, setup_pipeline_task hook
  → setup_pipeline_worker.
- Params/fields: FrameProcessorSetup.pipeline_task and
  FunctionCallParams.pipeline_task → pipeline_worker. Parameter names
  like task_name → worker_name; spawn/run accept worker:.
- Files: pipeline/base_task.py → base_worker.py, pipeline/task.py →
  worker.py (plus a re-export shim at pipeline/task.py),
  task_observer.py → worker_observer.py, task_ready_decorator.py →
  worker_ready_decorator.py, pipecat.tasks → pipecat.workers,
  llm_task.py → llm_worker.py, llm_context_task.py →
  llm_context_worker.py, examples/multi-task → examples/multi-worker.

Back-compat:
- PipelineTask kept as a deprecated subclass of PipelineWorker that
  warns on construction.
- pipecat.pipeline.task re-exports PipelineWorker/PipelineTask/etc. so
  existing user imports keep working.
- FrameProcessor.pipeline_task kept as a deprecated property that
  forwards to pipeline_worker.

Local variables in examples that hold a worker (task = PipelineTask(...))
are renamed to worker = PipelineWorker(...). Asyncio-task locals
(runner_task, etc.) are preserved.
This commit is contained in:
Aleix Conchillo Flaqué
2026-05-20 16:39:45 -07:00
parent b9aed0d673
commit b03247f360
394 changed files with 4602 additions and 4487 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
tests/test_runner.py
View File

@@ -8,44 +8,44 @@ import asyncio
import unittest
from pipecat.bus import (
BusAddTaskMessage,
BusAddWorkerMessage,
BusCancelMessage,
BusCancelTaskMessage,
BusCancelWorkerMessage,
BusEndMessage,
BusEndTaskMessage,
BusEndWorkerMessage,
)
from pipecat.pipeline.base_task import BaseTask
from pipecat.pipeline.base_worker import BaseWorker
from pipecat.pipeline.runner import PipelineRunner
class StubTask(BaseTask):
"""BaseTask subclass that stops on end/cancel so the runner can exit."""
class StubTask(BaseWorker):
"""BaseWorker subclass that stops on end/cancel so the runner can exit."""
async def _handle_task_end(self, message):
await super()._handle_task_end(message)
async def _handle_worker_end(self, message):
await super()._handle_worker_end(message)
self._finished_event.set()
async def _handle_task_cancel(self, message):
await super()._handle_task_cancel(message)
async def _handle_worker_cancel(self, message):
await super()._handle_worker_cancel(message)
self._finished_event.set()
class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
async def test_spawn_registers_task(self):
"""spawn() registers the task by name (duplicate is silently skipped)."""
"""add_worker() registers the task by name (duplicate is silently skipped)."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
# Duplicate is silently skipped (logs error)
await runner.spawn(StubTask("task_a"))
await runner.add_worker(StubTask("task_a"))
async def test_run_starts_bus_and_tasks(self):
"""run() starts bus, starts all tasks, fires on_ready."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
runner_started = asyncio.Event()
@@ -63,7 +63,7 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
"""end() is idempotent — subsequent calls are no-ops."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
@runner.event_handler("on_ready")
async def on_ready(runner):
@@ -77,7 +77,7 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
"""cancel() is idempotent — subsequent calls are no-ops."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
@runner.event_handler("on_ready")
async def on_ready(runner):
@@ -90,14 +90,14 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
pass
async def test_end_sends_end_task_message_to_root_tasks_only(self):
"""end() sends BusEndTaskMessage only to root tasks (no parent)."""
"""end() sends BusEndWorkerMessage only to root tasks (no parent)."""
runner = PipelineRunner(handle_sigint=False)
root = StubTask("root")
child = StubTask("child")
# Manually mark child as having root as parent
child._parent = root.name
await runner.spawn(root)
await runner.spawn(child)
await runner.add_worker(root)
await runner.add_worker(child)
sent = []
bus = runner.bus
@@ -112,19 +112,19 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
# Call end() directly — no need to run the full pipeline lifecycle
await runner.end()
end_msgs = [m for m in sent if isinstance(m, BusEndTaskMessage)]
end_msgs = [m for m in sent if isinstance(m, BusEndWorkerMessage)]
targets = {m.target for m in end_msgs}
self.assertIn("root", targets)
self.assertNotIn("child", targets)
async def test_cancel_sends_cancel_task_message_to_root_tasks_only(self):
"""cancel() sends BusCancelTaskMessage only to root tasks (no parent)."""
"""cancel() sends BusCancelWorkerMessage only to root tasks (no parent)."""
runner = PipelineRunner(handle_sigint=False)
root = StubTask("root")
child = StubTask("child")
child._parent = root.name
await runner.spawn(root)
await runner.spawn(child)
await runner.add_worker(root)
await runner.add_worker(child)
sent = []
bus = runner.bus
@@ -139,7 +139,7 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
# Call cancel() directly — no need to run the full pipeline lifecycle
await runner.cancel()
cancel_msgs = [m for m in sent if isinstance(m, BusCancelTaskMessage)]
cancel_msgs = [m for m in sent if isinstance(m, BusCancelWorkerMessage)]
targets = {m.target for m in cancel_msgs}
self.assertIn("root", targets)
self.assertNotIn("child", targets)
@@ -148,7 +148,7 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
"""BusEndMessage on bus triggers runner.end()."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
bus = runner.bus
@@ -164,7 +164,7 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
"""BusCancelMessage on bus triggers runner.cancel()."""
runner = PipelineRunner(handle_sigint=False)
task = StubTask("task_a")
await runner.spawn(task)
await runner.add_worker(task)
bus = runner.bus
@@ -177,25 +177,25 @@ class TestPipelineRunner(unittest.IsolatedAsyncioTestCase):
except asyncio.CancelledError:
pass
async def test_bus_add_task_message_triggers_spawn(self):
"""BusAddTaskMessage on bus triggers spawn()."""
async def test_bus_add_task_message_triggers_add(self):
"""BusAddWorkerMessage on bus triggers add_worker()."""
runner = PipelineRunner(handle_sigint=False)
task_a = StubTask("task_a")
await runner.spawn(task_a)
await runner.add_worker(task_a)
task_b = StubTask("task_b")
bus = runner.bus
@runner.event_handler("on_ready")
async def on_ready(runner):
await bus.send(BusAddTaskMessage(source="task_a", task=task_b))
await bus.send(BusAddWorkerMessage(source="task_a", task=task_b))
await asyncio.sleep(0.1)
await runner.end()
await asyncio.wait_for(runner.run(), timeout=5.0)
# Verify task_b was added (duplicate is silently skipped)
await runner.spawn(StubTask("task_b"))
await runner.add_worker(StubTask("task_b"))
if __name__ == "__main__":