sphinx.util.parallel.ParallelTasks

Modules Classes Names

class documentation

class ParallelTasks: (source)

View In Hierarchy

Executes *nproc* tasks in parallel after forking.

Method	`__init__`	Undocumented
Method	`add_task`	Undocumented
Method	`join`	Undocumented
Method	`terminate`	Undocumented
Instance Variable	`nproc`	Undocumented
Method	`_join_one`	Undocumented
Method	`_process`	Undocumented
Instance Variable	`_args`	Undocumented
Instance Variable	`_precvs`	Undocumented
Instance Variable	`_precvsWaiting`	Undocumented
Instance Variable	`_procs`	Undocumented
Instance Variable	`_pworking`	Undocumented
Instance Variable	`_result_funcs`	Undocumented
Instance Variable	`_taskid`	Undocumented

def __init__(self, nproc): (source) ¶

Undocumented

Parameters
nproc:`int`	Undocumented

def add_task(self, task_func, arg=None, result_func=None): (source) ¶

Undocumented

Parameters
task_func:`Callable`	Undocumented
arg:`Any`	Undocumented
result_func:`Callable\|None`	Undocumented

def join(self): (source) ¶

Undocumented

def terminate(self): (source) ¶

Undocumented

nproc = (source) ¶

Undocumented

def _join_one(self): (source) ¶

Undocumented

Returns
`bool`	Undocumented

def _process(self, pipe, func, arg): (source) ¶

Undocumented

Parameters
pipe:`Any`	Undocumented
func:`Callable`	Undocumented
arg:`Any`	Undocumented

_args: dict[int, list[Any]|None] = (source) ¶

Undocumented

_precvs: dict[int, Any] = (source) ¶

Undocumented

_precvsWaiting: dict[int, Any] = (source) ¶

Undocumented

_procs: dict[int, Any] = (source) ¶

Undocumented

_pworking: int = (source) ¶

Undocumented

_result_funcs: dict[int, Callable] = (source) ¶

Undocumented

_taskid: int = (source) ¶

Undocumented