ecflow.JobCreationCtrl

class ecflow.JobCreationCtrl

Bases: instance

The class JobCreationCtrl is used in job creation checking

Constructor:

JobCreationCtrl()

Usage:

defs = Defs('my.def')                     # specify the definition we want to check, load into memory
job_ctrl = JobCreationCtrl()
job_ctrl.set_node_path('/suite/to_check') # will hierarchically check job creation under this node
defs.check_job_creation(job_ctrl)         # job files generated to ECF_JOB
print(job_ctrl.get_error_msg())            # report any errors in job generation

job_ctrl = JobCreationCtrl()              # no set_node_path() hence check job creation for all tasks
job_ctrl.set_dir_for_job_creation(tmp)    # generate jobs file under this directory
defs.check_job_creation(job_ctrl)
print(job_ctrl.get_error_msg())

job_ctrl = JobCreationCtrl()              # no set_node_path() hence check job creation for all tasks
job_ctrl.generate_temp_dir()              # automatically generate directory for job file
defs.check_job_creation(job_ctrl)
print(job_ctrl.get_error_msg())

JobCreationCtrl.generate_temp_dir((JobCreationCtrl)arg1) → None :

Automatically generated temporary directory for job creation. Directory written to stdout for information

JobCreationCtrl.get_dir_for_job_creation((JobCreationCtrl)arg1) → str :

Returns the directory set for job creation

JobCreationCtrl.get_error_msg((JobCreationCtrl)arg1) → str :

Returns an error message generated during checking of job creation

JobCreationCtrl.set_dir_for_job_creation((JobCreationCtrl)arg1, (str)arg2) → None :

Specify directory, for job creation

JobCreationCtrl.set_node_path((JobCreationCtrl)arg1, (str)arg2) → None :

The node we want to check job creation for. If no node specified check all tasks

JobCreationCtrl.set_verbose((JobCreationCtrl)arg1, (bool)arg2) → None :

Output each task as its being checked.