Skip to content

pipen.progressbar

module

pipen.progressbar

Provide the PipelinePBar and ProcPBar classes

Classes
class

pipen.progressbar.ProcPBar(manager, proc_size, proc_name)

The progress bar for processes

Methods
method

update_job_submitted()

Update the progress bar when a job is submitted

method

update_job_retrying()

Update the progress bar when a job is retrying

method

update_job_running()

Update the progress bar when a job is running

method

update_job_succeeded()

Update the progress bar when a job is succeeded

method

update_job_failed()

Update the progress bar when a job is failed

method

done()

The process is done

class

pipen.progressbar.PipelinePBar(n_procs, ppln_name)

Progress bar for the pipeline

Methods
method

proc_bar(proc_size, proc_name)

Get the progress bar for a process

Parameters
  • proc_size (int) The size of the process
  • proc_name (str) The name of the process
Returns (ProcPBar)

The progress bar for the given process

method

update_proc_running()

Update the progress bar when a process is running

method

update_proc_done()

Update the progress bar when a process is done

method

update_proc_error()

Update the progress bar when a process is errored

method

done()

When the pipeline is done