Rename BaseTask → BaseWorker and reserve "task" for asyncio
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é
179
examples/multi-worker/code-assistant/code-assistant.py
Normal file
179
examples/multi-worker/code-assistant/code-assistant.py
Normal file
@@ -0,0 +1,179 @@
|
||||
#
|
||||
# Copyright (c) 2026, Daily
|
||||
#
|
||||
# SPDX-License-Identifier: BSD 2-Clause License
|
||||
#
|
||||
|
||||
"""Voice code assistant powered by Claude Agent SDK.
|
||||
|
||||
Talk to your codebase hands-free. Ask questions like "what does the
|
||||
auth middleware do?" or "find all TODO comments" and get spoken answers
|
||||
based on actual file contents. The Claude Agent SDK worker navigates
|
||||
the filesystem using Read, Bash, Glob, and Grep tools.
|
||||
|
||||
Architecture::
|
||||
|
||||
Main worker (transport + LLM + ``ask_code`` tool)
|
||||
└── job → CodeWorker (Claude Agent SDK)
|
||||
|
||||
Requirements:
|
||||
|
||||
- ANTHROPIC_API_KEY
|
||||
- OPENAI_API_KEY
|
||||
- DEEPGRAM_API_KEY
|
||||
- CARTESIA_API_KEY
|
||||
- DAILY_API_KEY (for Daily transport)
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
from code_worker import CodeWorker
|
||||
from dotenv import load_dotenv
|
||||
from loguru import logger
|
||||
|
||||
from pipecat.adapters.schemas.tools_schema import ToolsSchema
|
||||
from pipecat.audio.vad.silero import SileroVADAnalyzer
|
||||
from pipecat.frames.frames import LLMMessagesAppendFrame, LLMRunFrame
|
||||
from pipecat.pipeline.pipeline import Pipeline
|
||||
from pipecat.pipeline.runner import PipelineRunner
|
||||
from pipecat.pipeline.worker import PipelineParams, PipelineWorker
|
||||
from pipecat.processors.aggregators.llm_context import LLMContext
|
||||
from pipecat.processors.aggregators.llm_response_universal import (
|
||||
LLMContextAggregatorPair,
|
||||
LLMUserAggregatorParams,
|
||||
)
|
||||
from pipecat.runner.types import RunnerArguments
|
||||
from pipecat.runner.utils import create_transport
|
||||
from pipecat.services.cartesia.tts import CartesiaTTSService
|
||||
from pipecat.services.deepgram.stt import DeepgramSTTService
|
||||
from pipecat.services.llm_service import FunctionCallParams
|
||||
from pipecat.services.openai.llm import OpenAILLMService
|
||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
||||
from pipecat.transports.daily.transport import DailyParams
|
||||
|
||||
load_dotenv(override=True)
|
||||
|
||||
PROJECT_PATH = os.getenv("PROJECT_PATH", os.getcwd())
|
||||
|
||||
transport_params = {
|
||||
"daily": lambda: DailyParams(
|
||||
audio_in_enabled=True,
|
||||
audio_out_enabled=True,
|
||||
),
|
||||
"webrtc": lambda: TransportParams(
|
||||
audio_in_enabled=True,
|
||||
audio_out_enabled=True,
|
||||
),
|
||||
}
|
||||
|
||||
|
||||
async def ask_code(params: FunctionCallParams, question: str):
|
||||
"""Ask a question about the codebase. A Claude Code worker will
|
||||
explore the project by reading files, searching code, and running
|
||||
commands. It remembers previous questions for follow-ups.
|
||||
|
||||
Args:
|
||||
question (str): The question about code, files, structure,
|
||||
dependencies, or anything in the project.
|
||||
"""
|
||||
logger.info(f"Asking code worker: '{question}'")
|
||||
async with params.pipeline_worker.job("code_worker", payload={"question": question}) as job:
|
||||
await params.llm.queue_frame(
|
||||
LLMMessagesAppendFrame(
|
||||
messages=[{"role": "developer", "content": "Give me a moment."}],
|
||||
run_llm=True,
|
||||
)
|
||||
)
|
||||
# The LLM keeps talking while the worker runs.
|
||||
await params.result_callback(job.response)
|
||||
|
||||
|
||||
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
||||
logger.info("Starting code assistant")
|
||||
|
||||
runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
|
||||
|
||||
stt = DeepgramSTTService(api_key=os.environ["DEEPGRAM_API_KEY"])
|
||||
tts = CartesiaTTSService(
|
||||
api_key=os.environ["CARTESIA_API_KEY"],
|
||||
settings=CartesiaTTSService.Settings(
|
||||
voice="9626c31c-bec5-4cca-baa8-f8ba9e84c8bc", # Jacqueline
|
||||
),
|
||||
)
|
||||
llm = OpenAILLMService(
|
||||
api_key=os.environ["OPENAI_API_KEY"],
|
||||
settings=OpenAILLMService.Settings(
|
||||
system_instruction=(
|
||||
"You are a voice interface to a code assistant powered by Claude Code. "
|
||||
"Behind you is a worker that can read files, search code with grep and "
|
||||
"glob patterns, and run bash commands on the project. It maintains "
|
||||
"context across questions, so follow-up questions work naturally.\n\n"
|
||||
"When the user asks anything about code, project structure, files, "
|
||||
"dependencies, tests, or wants to explore the codebase, call the "
|
||||
"ask_code tool. When the worker result comes back, summarize it naturally "
|
||||
"for speaking. Keep responses concise and conversational.\n"
|
||||
),
|
||||
),
|
||||
)
|
||||
|
||||
llm.register_direct_function(ask_code, cancel_on_interruption=False, timeout_secs=60)
|
||||
|
||||
context = LLMContext(tools=ToolsSchema(standard_tools=[ask_code]))
|
||||
aggregators = LLMContextAggregatorPair(
|
||||
context,
|
||||
user_params=LLMUserAggregatorParams(vad_analyzer=SileroVADAnalyzer()),
|
||||
)
|
||||
|
||||
pipeline = Pipeline(
|
||||
[
|
||||
transport.input(),
|
||||
stt,
|
||||
aggregators.user(),
|
||||
llm,
|
||||
tts,
|
||||
transport.output(),
|
||||
aggregators.assistant(),
|
||||
]
|
||||
)
|
||||
|
||||
worker = PipelineWorker(
|
||||
pipeline,
|
||||
params=PipelineParams(
|
||||
enable_metrics=True,
|
||||
enable_usage_metrics=True,
|
||||
),
|
||||
idle_timeout_secs=runner_args.pipeline_idle_timeout_secs,
|
||||
)
|
||||
|
||||
@transport.event_handler("on_client_connected")
|
||||
async def on_client_connected(transport, client):
|
||||
logger.info("Client connected")
|
||||
context.add_message(
|
||||
{
|
||||
"role": "developer",
|
||||
"content": "Greet the user and tell them you're a code assistant.",
|
||||
}
|
||||
)
|
||||
await worker.queue_frame(LLMRunFrame())
|
||||
|
||||
@transport.event_handler("on_client_disconnected")
|
||||
async def on_client_disconnected(transport, client):
|
||||
logger.info("Client disconnected")
|
||||
await runner.cancel()
|
||||
|
||||
await runner.add_worker(CodeWorker("code_worker", project_path=PROJECT_PATH))
|
||||
await runner.add_worker(worker)
|
||||
|
||||
await runner.run()
|
||||
|
||||
|
||||
async def bot(runner_args: RunnerArguments):
|
||||
"""Main bot entry point compatible with Pipecat Cloud."""
|
||||
transport = await create_transport(runner_args, transport_params)
|
||||
await run_bot(transport, runner_args)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
from pipecat.runner.run import main
|
||||
|
||||
main()
|
||||
118
examples/multi-worker/code-assistant/code_worker.py
Normal file
118
examples/multi-worker/code-assistant/code_worker.py
Normal file
@@ -0,0 +1,118 @@
|
||||
#
|
||||
# Copyright (c) 2026, Daily
|
||||
#
|
||||
# SPDX-License-Identifier: BSD 2-Clause License
|
||||
#
|
||||
|
||||
"""Code worker that explores a codebase using Claude Agent SDK."""
|
||||
|
||||
import asyncio
|
||||
|
||||
from loguru import logger
|
||||
|
||||
from pipecat.bus import BusJobRequestMessage
|
||||
from pipecat.pipeline.base_worker import BaseWorker
|
||||
from pipecat.pipeline.job_context import JobStatus
|
||||
|
||||
try:
|
||||
from claude_agent_sdk import ClaudeAgentOptions, ClaudeSDKClient
|
||||
except ModuleNotFoundError as e:
|
||||
logger.error(f"Exception: {e}")
|
||||
logger.error("In order to use CodeWorker, you need to `pip install claude-agent-sdk`.")
|
||||
raise Exception(f"Missing module: {e}")
|
||||
|
||||
|
||||
class CodeWorker(BaseWorker):
|
||||
"""Bus-only worker that answers code questions using Claude Agent SDK.
|
||||
|
||||
Maintains a persistent Claude SDK session so follow-up questions
|
||||
share context. Questions are queued and processed sequentially. The
|
||||
worker has no Pipecat pipeline — it consumes job requests from the
|
||||
bus and replies with job responses.
|
||||
"""
|
||||
|
||||
def __init__(self, name: str, *, project_path: str):
|
||||
"""Initialize the CodeWorker.
|
||||
|
||||
Args:
|
||||
name: Unique worker name.
|
||||
project_path: Filesystem path the Claude SDK should explore.
|
||||
"""
|
||||
super().__init__(name)
|
||||
|
||||
self._project_path = project_path
|
||||
self._queue: asyncio.Queue = asyncio.Queue()
|
||||
self._worker_task: asyncio.Task | None = None
|
||||
|
||||
self._claude_options = ClaudeAgentOptions(
|
||||
permission_mode="bypassPermissions",
|
||||
system_prompt=(
|
||||
f"You are a code assistant. The project is at: {self._project_path}\n\n"
|
||||
"Answer the user's question by exploring the codebase. Use Read to "
|
||||
"view files, Glob to find files by pattern, and Bash to run commands "
|
||||
"like grep or find. Be thorough but concise in your answer. "
|
||||
"Focus on what the user asked. Respond with a clear, spoken-friendly "
|
||||
"summary (no markdown, no bullet points, no code blocks)."
|
||||
),
|
||||
allowed_tools=["Read", "Bash", "Glob", "Grep"],
|
||||
model="sonnet",
|
||||
max_turns=10,
|
||||
)
|
||||
|
||||
async def start(self) -> None:
|
||||
"""Launch the Claude SDK worker loop alongside the standard worker start."""
|
||||
await super().start()
|
||||
self._worker_task = self.create_task(self._worker_loop(), "worker")
|
||||
|
||||
async def stop(self) -> None:
|
||||
"""Cancel the worker loop before tearing down the worker."""
|
||||
if self._worker_task:
|
||||
await self.cancel_task(self._worker_task)
|
||||
self._worker_task = None
|
||||
await super().stop()
|
||||
|
||||
async def on_job_request(self, message: BusJobRequestMessage) -> None:
|
||||
"""Enqueue an incoming job for the worker loop."""
|
||||
await super().on_job_request(message)
|
||||
logger.info(f"Worker '{self.name}': queued '{message.payload['question']}'")
|
||||
self._queue.put_nowait(message)
|
||||
|
||||
async def _worker_loop(self):
|
||||
client = ClaudeSDKClient(options=self._claude_options)
|
||||
try:
|
||||
await client.connect()
|
||||
except Exception as e:
|
||||
logger.error(f"Worker '{self.name}': failed to start Claude SDK: {e}")
|
||||
return
|
||||
|
||||
try:
|
||||
while True:
|
||||
message = await self._queue.get()
|
||||
question = message.payload["question"]
|
||||
logger.info(f"Worker '{self.name}': researching '{question}'")
|
||||
|
||||
try:
|
||||
answer = ""
|
||||
await client.query(prompt=question)
|
||||
async for msg in client.receive_response():
|
||||
if type(msg).__name__ == "AssistantMessage":
|
||||
for block in msg.content:
|
||||
if type(block).__name__ == "TextBlock":
|
||||
answer += block.text
|
||||
|
||||
logger.info(f"Worker '{self.name}': completed ({len(answer)} chars)")
|
||||
await self.send_job_response(message.job_id, {"answer": answer})
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Worker '{self.name}': error: {e}")
|
||||
await self.send_job_response(
|
||||
message.job_id, {"error": str(e)}, status=JobStatus.ERROR
|
||||
)
|
||||
finally:
|
||||
# Bypass `async with ClaudeSDKClient` and call disconnect()
|
||||
# ourselves: __aexit__ → Query.close() → _read_task.wait() uses
|
||||
# `with suppress(asyncio.CancelledError)`, which would swallow the
|
||||
# outer task's cancellation. By the time this finally runs, our
|
||||
# CancelledError has already been raised once, so _must_cancel is
|
||||
# cleared and disconnect()'s awaits proceed normally.
|
||||
await client.disconnect()
|
||||
Reference in New Issue
Block a user