mavis.schedule.job
class mavis.schedule.job.LogFile
stores information about the log status
mavis.schedule.job.LogFile.__init__()
def __init__(self, filename, status, message=None):
Args
- filename (
str): path to the logfile - status (
LogFile.STATUS): the status of the logfile - message (
str): the message parsed from the logfile. Generally this is an error from the log
mavis.schedule.job.LogFile.parse()
given a file parse to see if it looks like a complete log file (contains run time), was truncated, or reported an error
@classmethod
def parse(cls, filename):
Args
- filename
class mavis.schedule.job.Job
mavis.schedule.job.Job.display_name()
Used for identifying this job in an ini config file
@property
def display_name(self):
Args
- self
mavis.schedule.job.Job.logfile()
returns the path to the logfile with job name and job id substituted into the stdout pattern
def logfile(self):
mavis.schedule.job.Job.complete_stamp()
returns the path to the expected complete stamp
def complete_stamp(self):
class mavis.schedule.job.ArrayJob
inherits Job
Class for dealing with array jobs. Jobs with many tasks
mavis.schedule.job.ArrayJob.__init__()
def __init__(self, stage, task_list, **kwargs):
Args
- stage
- task_list (
Union[List,int]): the ids of tasks in the job array
mavis.schedule.job.ArrayJob.get_task()
returns a task by task id
def get_task(self, task_ident):
Args
- task_ident
mavis.schedule.job.ArrayJob.complete_stamp()
returns the path to the expected complete stamp
def complete_stamp(self, task_ident):
Args
- task_ident
class mavis.schedule.job.TorqueArrayJob
inherits ArrayJob