fabricatio_comfyui.capabilities.comfyui

ComfyUI capability mixin.

Holds a ComfyuiClient instance and delegates every API call to it. Mix into a Role to gain ComfyUI interaction methods.

Classes

Comfyui

ComfyUI capability mixin — delegates to a ComfyuiClient.

Module Contents

class fabricatio_comfyui.capabilities.comfyui.Comfyui

ComfyUI capability mixin — delegates to a ComfyuiClient.

property comfyui: fabricatio_comfyui.client.ComfyuiClient

Return the underlying client, creating lazily if needed.

async comfyui_queue_prompt(workflow: Dict[str, Any], client_id: str | None = None, front: bool = False) fabricatio_comfyui.models.comfyui.PromptResponse

Submit a workflow graph for execution.

async comfyui_get_queue_info() fabricatio_comfyui.models.comfyui.QueueInfo

Get current queue status.

async comfyui_get_history(prompt_id: str) fabricatio_comfyui.models.comfyui.HistoryEntry | None

Get execution history for a specific prompt.

async comfyui_wait_for_completion(prompt_id: str, poll_interval: float = 1.0, timeout: float | None = None) fabricatio_comfyui.models.comfyui.ComfyuiExecutionResult

Poll until a prompt completes or fails.

async comfyui_get_image(filename: str, subfolder: str = '', image_type: str = 'output') bytes

Download a generated image.

async comfyui_upload_image(image_path: str | pathlib.Path, image_type: str = 'input', overwrite: bool = True) fabricatio_comfyui.models.comfyui.UploadResponse

Upload an image to the server.

async comfyui_interrupt() None

Interrupt the currently running workflow.

async comfyui_generate(workflow: Dict[str, Any], download_dir: str | pathlib.Path | None = None, client_id: str | None = None, poll_interval: float = 1.0, timeout: float | None = None) fabricatio_comfyui.models.comfyui.ComfyuiExecutionResult

Queue a workflow, wait for completion, optionally download images.