fabricatio_plot.capabilities.plot

Plot Module.

This module defines the Plot class, which serves as a handler for managing plot-related operations. It utilizes various toolboxes to fulfill plotting requirements and provides an asynchronous interface for handling plot tasks.

Classes

Plot	A class representing a Plot handler, which manages plot-related operations and toolboxes.

Module Contents

class fabricatio_plot.capabilities.plot.Plot(/, **data: Any)

Bases: fabricatio_tool.capabilities.handle.Handle

A class representing a Plot handler, which manages plot-related operations and toolboxes.

toolboxes: Set[fabricatio_tool.models.tool.ToolBox] = None

A set of toolboxes used by the Plot handler, including plot_toolbox and data_toolbox by default.

async plot(requirement: str, data: Dict[str, Any] | None = None, output_spec: Dict[str, str] | None = None, **kwargs: Unpack[fabricatio_core.models.kwargs_types.ValidateKwargs[str]]) → fabricatio_tool.models.collector.ResultCollector | None

An asynchronous method that initiates a plot operation based on the given requirement and keyword arguments.

Parameters:

• requirement (str) – A string describing the plot requirement or command.

• data (Optional[Dict[str, Any]]) – A dictionary containing data for plotting.

• output_spec (Optional[Dict[str, str]]) – A dictionary specifying the output format and location.

• **kwargs (ValidateKwargs[str]) – Additional unpacked keyword arguments for customizing the plot operation.

Returns:

A ResultCollector instance containing the results of the plot operation,

or None if not applicable.

Return type:

ResultCollector | None