Task

class deepfos.lib.subtask.Task(arg=None, task_name_tmpl='Task - {counter:03}', swallow_exc=False, check_started=True)

子任务对象

参数
  • arg (Optional[Any]) – 执行参数

  • task_name_tmpl (Optional[str]) – 任务名模板,支持替换的字段为counter(自增任务编号) 和 arg(任务使用的参数),默认以 Task-{counter:03} 格式产生

  • swallow_exc (Optional[bool]) – 在任务出现异常时是否忽略(不中断程序执行)

  • check_started (Optional[bool]) – 是否检查任务启动过

示例

with Task():
    time.sleep(1)

with Task(swallow_exc=True):
    raise ValueError('an error occurs')

with Task(task_name_tmpl="Your task name"):
    time.sleep(1)

注解

  • 若不通过 TaskContainercreate_tasks

    而是直接实例化Task对象,则只有其中任务被执行时, 记录才会创建更新,作业界面进度条不能反映实际运行进度

  • 如需看到稳定进度条的情况,建议从 TaskContainer 调用或使用

    create_tasks 方法

Exclude-members

子任务对象

Args:

arg: 执行参数 task_name_tmpl: 任务名模板,支持替换的字段为counter(自增任务编号)

和 arg(任务使用的参数),默认以 Task-{counter:03} 格式产生

swallow_exc: 在任务出现异常时是否忽略(不中断程序执行) check_started: 是否检查任务启动过

示例

with Task():
    time.sleep(1)

with Task(swallow_exc=True):
    raise ValueError('an error occurs')

with Task(task_name_tmpl="Your task name"):
    time.sleep(1)
Note:
  • 若不通过 TaskContainercreate_tasks

    而是直接实例化Task对象,则只有其中任务被执行时, 记录才会创建更新,作业界面进度条不能反映实际运行进度

  • 如需看到稳定进度条的情况,建议从 TaskContainer 调用或使用

    create_tasks 方法

See Also:

TaskContainer create_tasks