Processes

class pipeliner.process.Process(name: str, p_type: str, status: str, alias: str | None = None)

Bases: object

A Process represents a job that has been run by the Pipeliner

name

The name of the process. It should be in the format “<jobtype>/jobxxx/”. The trailing slash is required

Type:

str

alias

An alternate name for the process to make it easier to identify

Type:

str

outdir

The directory the process was written into

Type:

str

p_type

The process’ type

Type:

str

status

The processes’ status ‘running, scheduled, successful, failed, or aborted’

Type:

str

input_nodes

Node objects for files the process use as inputs

Type:

list

output_nodes

Node objects for files the process produces

Type:

list

remove_nonexistent_nodes() List[str]

Checks the files for the output nodes of the process actually exist

Removes them from the output node list if the files are not found

Returns:

The names of the removed nodes

Return type:

List[str]

update_jobinfo_file(action: str, comment: str | None = None, command_list: list | None = None) None

Update the file in the jobdir that stores info about the job

Parameters:
  • current_proc (Process) – Process object for the job being operated on

  • action (str) – what action was performed on the job, e.g. Run, Scheduled, Cleaned up

  • comment (str) – Comment to append to the job’s comments list

  • command_list (list) – Commands that were run. Generally None if action was any other than Run or Scheduled