Class Job

Overrides: Base.Objects.Node.__getstate__

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

(inherited documentation)

Overrides: Base.Objects.GangaObject._attribute_filter__set__

Overrides: Base.Objects.GangaObject._auto__init__

Create an unpacked input sandbox which contains files (a list of File or FileBuffer objects). 'master' flag is not used in this case, and it provided only for uniformity with createPackedInputSandbox() method

Create a packed input sandbox which contains files (a list of File or FileBuffer objects). 'master' flag is used to make a difference between the master and shared input sandbox which is important if the job is not split (subjob and masterjob are the same object)

Deprecated. Use force_status('failed') instead.

Force job to enter the "failed" or "completed" state. This may be used for marking jobs "bad" jobs or jobs which are stuck in one of the internal ganga states (e.g. completing).

To see the list of allowed states do: job.force_status(None)

Return a fully qualified job id (within registry): a list of ids [masterjob_id,subjob_id,...] If optional sep is specified FQID string is returned, ids are separated by sep. For example: getFQID('.') will return 'masterjob_id.subjob_id....'

Kill the job. Raise JobError exception on error.

Merge the output of subjobs.

By default merge all subjobs into the master outputdir. The output location and the list of subjobs may be overriden. The options (keyword arguments) are passed onto the specific merger implementation. Refer to the specific merger documentation for more information about available options.

Send monitoring information (e.g. Dashboard) at the time of job submission

Allow viewing of job output (and input) files

Arguments other than self:
filename : name of file to be viewed
           => For backends where this is enabled, the filename
              for a job in the "running" state is relative to
              the job's work directory unless the filename begins
              with "../".  In all other cases, the filename is
              relative to the job's output directory
command  : command to be used for viewing the file
           => If no command is given, then the command defined in
              the [File_Associations] section of the Ganga
              configuration file(s) is used

Example usage:

   # examine contents of output/work directory
   peek()

   # examine contents of output directory,
   # even in case of job in "running" state
   peek( "../output" )

   # examine contents of input directory
   peek( "../input" )

   # View ROOT histograms, running root.exe in a new terminal window
   peek( "histograms.root", "root.exe &&" )

   # View contents of file in output/work directory, using
   # command defined in configuration file
   peek( "output.txt" )

   # View ROOT histograms in ouput/work directory,
   # running root.exe in a new terminal window
   peek( "histograms.root", "root.exe &&" )
              
Return value: None

Remove the job.

If job has been submitted try to kill it first. Then remove the file workspace associated with the job.

If force=True then remove job without killing it.

Resubmit a failed or completed job.  A backend object may
be specified to change some submission parameters (which
parameters may be effectively changed depends on a
particular backend implementation).

Example:
 b = j.backend.copy()
 b.CE = 'some CE'
 j.resubmit(backend=b)

Note: it is not possible to change the type of the backend in this way.

Rollback the job to the "new" state if submitting of job failed:

• cleanup the input and output workspace preserving the top dir(bug ##19434)
• do not remove debug directory
• cleanup subjobs

This method is used as a hook for submitting->new transition @see updateJobStatus()

Submits a job. Return true on success.

First the application is configured which may generate additional input files, preprocess executable scripts etc. Then backend handler is used to submit the configured job. The job is automatically checkpointed to persistent storage.

The default values of keep_going and keep_on_fail are controlled by [GPI_Semantics] configuration options.

When the submission fails the job status is automatically reverted to new and all files in the input directory are deleted (keep_on_fail=False is the default behaviour unless modified in configuration). If keep_on_fail=True then the job status is moved to the failed status and input directory is left intact. This is helpful for debugging anf implements the request #43143.

For split jobs: consult https://twiki.cern.ch/twiki/bin/view/ArdaGrid/GangaSplitters#Subjob_submission

Update master job status based on the status of subjobs. This is an auxiliary method for implementing bulk subjob monitoring.

Move job to the new status. according to the state transition graph (Job.status_graph). If transition is allowed:

• call the specific transition hook (if exists)
• call the general transition update hook (triggers the auto merger and application hooks)
• commit the job

If job cannot be commited, then revert to old status and raise JobStatusError. If transition is not allowed then raise JobStatusError.

Transitions from to the current state are allowed by default (so you can updateStatus('running') if job is 'running'). Such default transitions do not have hooks.

Allow file viewing

Arguments other than self:
path    : path to file to be viewed
command  : command to be used for viewing the file
           => If no command is given, then the command defined in
              the [File_Associations] section of the Ganga
              configuration file(s) is used

This is intended as a helper function for the peek() method.

Return value: None

allowed_force_states

Value:

{'completed': ['completing', 'failed'], 'failed': ['submitting', 'completing', 'completed', 'submitted', 'running', 'killed']}

application

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a93d0>

backend

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a97d0>

do_auto_resubmit

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a91d0>

inputdata

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x189df90>

inputdir

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a90d0>

inputsandbox

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a9250>

master

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a9450>

merger

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a9150>

outputdata

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a94d0>

outputdir

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a92d0>

outputsandbox

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a9650>

splitter

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a95d0>

status

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x189df10>

status_graph

Value:

{'completed': {'failed': <Ganga.GPIDev.Lib.Job.Job.State instance at 0 x18a6a28>, 'removed': <Ganga.GPIDev.Lib.Job.Job.State instance at 0x18 a69e0>, 'submitted': <Ganga.GPIDev.Lib.Job.Job.State instance at 0x18a 6ab8>, 'submitting': <Ganga.GPIDev.Lib.Job.Job.State instance at 0x18a 6a70>}, 'completing': {'failed': <Ganga.GPIDev.Lib.Job.Job.State instance at 0x18a66c8>, 'completed': <Ganga.GPIDev.Lib.Job.Job.State instance at 0 x18a6680>, 'submitted': <Ganga.GPIDev.Lib.Job.Job.State instance at 0x ...

subjobs

Value:

<Ganga.GPIDev.Base.Objects.Descriptor object at 0x18a96d0>