Package schrodinger :: Package test :: Package scival :: Module jobs :: Class BaseSuiteJob

Class BaseSuiteJob

         object --+                
                  |                
  job.queue.BaseJob --+            
                      |            
job.queue.JobControlJob --+        
                          |        
             object --+   |        
                      |   |        
       suite._SciValJob --+        
                          |        
         suite.BaseSuiteJob --+    
                              |    
                 suite.SuiteJob --+
                                  |
                                 BaseSuiteJob

Known Subclasses:

The base job class for all jobs.

Instance Methods

[hide private]

__init__(self, test, run_env, jobname, command, **kwargs)
Initialize the suite job.

getFiles(self, test, *prop_names, **kwargs)
Gets all the input files for this suite job

getResults(self)
All non-terminal workflow stages will return None for this method.

Inherited from suite.SuiteJob: __str__, execFilepath, finalize, getJobParams, kill, postCommand, run, setServerRunState, setup, suiteName, testName, update, upload

Inherited from job.queue.JobControlJob: __getstate__, __setstate__, cancelSubmitted, doCommand, getCommand, getJob, getStatusStrings, maxFailuresReached, retryFailure, runsLocally, usesJobServer

Inherited from job.queue.JobControlJob (private): _downloadFromJobServer, _hasDied, _launch_with_retries, _markFinished, _readAgain

Inherited from job.queue.BaseJob: __lt__, addFinalizer, addGroupPrereq, addPrereq, genAllJobs, genAllPrereqs, getCommandDir, getJobDJ, getPrereqs, hasStarted, isComplete, preCommand

Inherited from job.queue.BaseJob (private): _getState, _pruneGraph, _setState

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables

[hide private]

Inherited from suite.SuiteJob: client, prerequisite_job_classes

Inherited from job.queue.BaseJob: init_count

Properties

[hide private]

Inherited from suite.SuiteJob: host_id, host_name

Inherited from job.queue.BaseJob: state

Inherited from object: __class__

Method Details

[hide private]

init(self, test, run_env, jobname, command, **kwargs)
(Constructor)

Initialize the suite job. All job-specific arguments should be passed in the **kwargs

Here is a description of optional kwargs:

output_files - List of filenames. If all the filenames are found to exist AND the -rerun flag was not invoked this stage will be bypassed.

Parameters:

client - A validation.aggregate.AggregateClient instance.
test - A dictionary describing the test as downloaded from the server. Guaranteed to have a 'name' key.
jobname - A name for the job.
command - The command that will launch the job.

Overrides: object.__init__

getFiles(self, test, *prop_names, **kwargs)

Gets all the input files for this suite job

Overrides: suite.SuiteJob.getFiles: (inherited documentation)

getResults(self)

All non-terminal workflow stages will return None for this method.

Overrides: suite.SuiteJob.getResults

See Also: SuiteJob

Class BaseSuiteJob

__init__(self, test, run_env, jobname, command, **kwargs) (Constructor)

getFiles(self, test, *prop_names, **kwargs)

getResults(self)

init(self, test, run_env, jobname, command, **kwargs)
(Constructor)