gstlal 1.13.0
Loading...
Searching...
No Matches
python.dagfile.JOB Class Reference
Inheritance diagram for python.dagfile.JOB:
Collaboration diagram for python.dagfile.JOB:

Public Member Functions

 __init__ (self, name, filename, directory=None, done=False, noop=False)
 write (self, f, progress=None)
 state (self)

Public Attributes

 name = name
 filename = filename
 directory = directory
 done = done
 noop = noop
dict vars = {}
 retry = None
 retry_unless_exit_value = None
 priority = None
 category = None
 parents = set()
 children = set()
 prescript = None
 prescriptargs = None
 postscript = None
 postscriptargs = None
 abort_dag_on_abortexitvalue = None
 abort_dag_on_dagreturnvalue = None

Static Public Attributes

str keyword = "JOB"

Detailed Description

Representation of a JOB node in a Condor DAG.  JOB objects have the
following attributes corresponding to information in the DAG file:

.name
    The name of the node in the DAG.

.filename
    The name of the submit file for the JOB.

.directory
    The initial working directory for the JOB.  Set to None to
    omit from DAG (job's working directory will be chosen by
    Condor).

.done
    Boolean indicating if the JOB is done or not.  See
    DAG.load_rescue() for more information.

.noop
    Boolean indicating if the JOB is a no-op or not.

.vars
    A dictionary of the name-->value pairs in the VARS line for
    the JOB.  Leave empty to omit VARS from DAG.

.retry
    The number of retries for the job.  Set to None to omit
    from DAG.

.retry_unless_exit_value
    The value of the UNLESS-EXIT suffix of the RETRY line.
    Set to None to omit from DAG.

.priority
.category
    The PRIORITY value and CATEGORY name for the node in the
    DAG.  Set to None to omit from the DAG.

.parents
.children
    Sets of the parent and child nodes of JOB.  The sets
    contain references to the node objects, not their names.

.prescript
.prescriptargs
.postscript
.postscriptargs
    The names and lists of arguments of the PRE and POST
    scripts.  Set to None to omit from DAG.

.abort_dag_on_abortexitvalue
.abort_dag_on_dagreturnvalue
    The ABORT-DAG-ON abort exit value and DAG return value for
    the JOB.  Set to None to omit from DAG.

For more information about the function of these parameters, refer
to the Condor documentation.

Definition at line 130 of file dagfile.py.

Constructor & Destructor Documentation

◆ __init__()

python.dagfile.JOB.__init__ ( self,
name,
filename,
directory = None,
done = False,
noop = False )

Definition at line 192 of file dagfile.py.

Member Function Documentation

◆ state()

python.dagfile.JOB.state ( self)
Get the state of the node.  One of 'wait', 'idle', 'run',
'abort', 'stop', 'success', 'fail'.

NOTE:  this feature is not implemented at this time.

Definition at line 310 of file dagfile.py.

◆ write()

python.dagfile.JOB.write ( self,
f,
progress = None )
Write the lines describing this node to the file-like
object f.  The object must provide a .write() method.

If progress is not None, it will be incremented by 1 for
every line written.

Definition at line 230 of file dagfile.py.

Member Data Documentation

◆ abort_dag_on_abortexitvalue

python.dagfile.JOB.abort_dag_on_abortexitvalue = None

Definition at line 227 of file dagfile.py.

◆ abort_dag_on_dagreturnvalue

python.dagfile.JOB.abort_dag_on_dagreturnvalue = None

Definition at line 228 of file dagfile.py.

◆ category

python.dagfile.JOB.category = None

Definition at line 210 of file dagfile.py.

◆ children

python.dagfile.JOB.children = set()

Definition at line 216 of file dagfile.py.

◆ directory

python.dagfile.JOB.directory = directory

Definition at line 196 of file dagfile.py.

◆ done

python.dagfile.JOB.done = done

Definition at line 197 of file dagfile.py.

◆ filename

python.dagfile.JOB.filename = filename

Definition at line 195 of file dagfile.py.

◆ keyword

python.dagfile.JOB.keyword = "JOB"
static

Definition at line 190 of file dagfile.py.

◆ name

python.dagfile.JOB.name = name

Definition at line 194 of file dagfile.py.

◆ noop

python.dagfile.JOB.noop = noop

Definition at line 198 of file dagfile.py.

◆ parents

python.dagfile.JOB.parents = set()

Definition at line 215 of file dagfile.py.

◆ postscript

python.dagfile.JOB.postscript = None

Definition at line 222 of file dagfile.py.

◆ postscriptargs

python.dagfile.JOB.postscriptargs = None

Definition at line 223 of file dagfile.py.

◆ prescript

python.dagfile.JOB.prescript = None

Definition at line 220 of file dagfile.py.

◆ prescriptargs

python.dagfile.JOB.prescriptargs = None

Definition at line 221 of file dagfile.py.

◆ priority

python.dagfile.JOB.priority = None

Definition at line 209 of file dagfile.py.

◆ retry

python.dagfile.JOB.retry = None

Definition at line 205 of file dagfile.py.

◆ retry_unless_exit_value

python.dagfile.JOB.retry_unless_exit_value = None

Definition at line 206 of file dagfile.py.

◆ vars

dict python.dagfile.JOB.vars = {}

Definition at line 202 of file dagfile.py.


The documentation for this class was generated from the following file: