导出任务

导出任务将任务输出导出到 CSV 或 Excel。

示例

以下是使用此任务作为工作流一部分的简单示例。

from txtai.workflow import FileTask, Workflow

workflow = Workflow([ExportTask()])
workflow(["Input 1", "Input2"])

配置驱动的示例

此任务也可以通过工作流配置创建。

workflow:
  tasks:
    - task: export

方法

该任务的 Python 文档。

__init__(action=None, select=None, unpack=True, column=None, merge='hstack', initialize=None, finalize=None, concurrency=None, onetomany=True, **kwargs)

创建一个新任务。任务定义了两种方法，即它接受的数据类型以及对每个数据元素执行的操作。操作可以是可调用函数或可调用函数的列表。

参数

名称	类型	描述	默认值
action		对每个数据元素执行的操作	None
select		用于选择要处理的数据的过滤器	None
unpack		数据元素是否应从 (id, data, tag) 元组中解包	True
column		如果元素是元组，要选择的列索引，默认为全部	None
merge		合并多操作输出的模式，默认为 hstack	'hstack'
initialize		处理前执行的操作	None
finalize		处理后执行的操作	None
concurrency		当执行实例可用时设置并发方法 有效值："thread" 表示基于线程的并发，"process" 表示基于进程的并发	None
onetomany		是否启用一对多数据转换，默认为 True	True
kwargs		附加关键字参数	{}

源代码位于 txtai/workflow/task/base.py

def __init__(
    self,
    action=None,
    select=None,
    unpack=True,
    column=None,
    merge="hstack",
    initialize=None,
    finalize=None,
    concurrency=None,
    onetomany=True,
    **kwargs,
):
    """
    Creates a new task. A task defines two methods, type of data it accepts and the action to execute
    for each data element. Action is a callable function or list of callable functions.

    Args:
        action: action(s) to execute on each data element
        select: filter(s) used to select data to process
        unpack: if data elements should be unpacked or unwrapped from (id, data, tag) tuples
        column: column index to select if element is a tuple, defaults to all
        merge: merge mode for joining multi-action outputs, defaults to hstack
        initialize: action to execute before processing
        finalize: action to execute after processing
        concurrency: sets concurrency method when execute instance available
                     valid values: "thread" for thread-based concurrency, "process" for process-based concurrency
        onetomany: if one-to-many data transformations should be enabled, defaults to True
        kwargs: additional keyword arguments
    """

    # Standardize into list of actions
    if not action:
        action = []
    elif not isinstance(action, list):
        action = [action]

    self.action = action
    self.select = select
    self.unpack = unpack
    self.column = column
    self.merge = merge
    self.initialize = initialize
    self.finalize = finalize
    self.concurrency = concurrency
    self.onetomany = onetomany

    # Check for custom registration. Adds additional instance members and validates required dependencies available.
    if hasattr(self, "register"):
        self.register(**kwargs)
    elif kwargs:
        # Raise error if additional keyword arguments passed in without register method
        kwargs = ", ".join(f"'{kw}'" for kw in kwargs)
        raise TypeError(f"__init__() got unexpected keyword arguments: {kwargs}")

register(output=None, timestamp=None)

向任务添加导出参数。检查是否安装了所需的依赖项。

参数

名称	类型	描述	默认值
output		输出文件路径	None
timestamp		如果输出文件应带有时间戳，则为 true	None

源代码位于 txtai/workflow/task/export.py

def register(self, output=None, timestamp=None):
    """
    Add export parameters to task. Checks if required dependencies are installed.

    Args:
        output: output file path
        timestamp: true if output file should be timestamped
    """

    if not PANDAS:
        raise ImportError('ExportTask is not available - install "workflow" extra to enable')

    # pylint: disable=W0201
    self.output = output
    self.timestamp = timestamp