Home       Trees       Indices       Help   
Package Ganga :: Package Lib :: Package Localhost :: Module Localhost' :: Class Localhost
[hide private]
[frames] | no frames]

Class Localhost

source code

                 object --+            
                          |            
   GPIDev.Base.Objects.Node --+        
                              |        
GPIDev.Base.Objects.GangaObject --+    
                                  |    
  GPIDev.Adapters.IBackend.IBackend --+
                                      |
                                     Localhost

This is a Ganga.GPI.Localhost implementation class. Refer to Ganga.GPI.Localhost.__doc__ for documentation.

Nested Classes [hide private]
  _proxyClass
Run jobs in the background on local host.

Inherited from GPIDev.Base.Objects.GangaObject: __metaclass__

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature		 source code
 
getStateTime(self, status)
Obtains the timestamps for the 'running', 'completed', and 'failed' states.		 source code
 
kill(self)
Kill a job (and also all its subjobs).		 source code
 
peek(self, filename='', command='')
Allow viewing of output files in job's work directory (i.e.		 source code
 
preparejob(self, jobconfig, master_input_sandbox) source code
 
remove_workdir(self) source code
 
resubmit(self) source code
 
run(self, scriptpath) source code
 
submit(self, jobconfig, master_input_sandbox)
Submit an individual job.		 source code
 
timedetails(self)
Return all available timestamps from this backend.		 source code

Inherited from GPIDev.Adapters.IBackend.IBackend: check_auto_resubmit, master_auto_resubmit, master_kill, master_prepare, master_resubmit, master_submit, remove, setup

Inherited from GPIDev.Base.Objects.GangaObject: __construct__, __deepcopy__, __getstate__, __setstate__, _attribute_filter__set__, _auto__init__, accept, getJobObject

Inherited from GPIDev.Base.Objects.GangaObject (private): _getReadAccess, _getRegistry, _getRegistryID, _getWriteAccess, _readonly, _releaseWriteAccess, _setDirty, _setFlushed, _setRegistry

Inherited from GPIDev.Base.Objects.Node: __copy__, __eq__, __ne__, clone, copyFrom, printSummaryTree, printTree

Inherited from GPIDev.Base.Objects.Node (private): _getParent, _getRoot, _setParent

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

Class Methods [hide private]

Inherited from GPIDev.Base.Objects.GangaObject (private): _declared_property

Static Methods [hide private]
 
updateMonitoringInformation(jobs)
Update monitoring information for individual jobs: jobs is a list which may contain subjobs as well as the non-split jobs.		 source code

Inherited from GPIDev.Adapters.IBackend.IBackend: master_updateMonitoringInformation

Class Variables [hide private]
  _GUIAdvancedPrefs = [{'attribute': 'nice', 'widget': 'String'}...
  _GUIPrefs = [{'attribute': 'nice', 'widget': 'String'}, {'attr...
  _name = 'Local'
  _schema = <Ganga.GPIDev.Schema.Schema.Schema instance at 0x2fe...
  actualCE = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2...
  exitcode = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2...
  id = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec8d0>
  nice = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec950>
  status = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fe...
  workdir = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x2f...
  wrapper_pid = <Ganga.GPIDev.Base.Objects.Descriptor object at ...

Inherited from GPIDev.Adapters.IBackend.IBackend (private): _category, _hidden, _packed_input_sandbox

Inherited from GPIDev.Base.Objects.GangaObject (private): _exportmethods, _registry

Inherited from GPIDev.Base.Objects.Node (private): _index_cache, _parent

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)

getStateTime(self, status)

source code 

Obtains the timestamps for the 'running', 'completed', and 'failed' states.

The __jobstatus__ file in the job's output directory is read to obtain the start and stop times of the job. These are converted into datetime objects and returned to the user.

Overrides: GPIDev.Adapters.IBackend.IBackend.getStateTime

kill(self)

source code 

Kill a job (and also all its subjobs). This method is never called by the framework directly. It may only be called by the default implementation of master_kill().

Overrides: GPIDev.Adapters.IBackend.IBackend.kill
(inherited documentation)

peek(self, filename='', command='')

source code  

Allow viewing of output files in job's work directory
(i.e. while job is in 'running' state)
                                                                          
Arguments other than self:
filename : name of file to be viewed
          => Path specified relative to work directory
command  : command to be used for file viewing
                                                                          
Return value: None
Overrides: GPIDev.Adapters.IBackend.IBackend.peek

resubmit(self)

source code 
Overrides: GPIDev.Adapters.IBackend.IBackend.resubmit

submit(self, jobconfig, master_input_sandbox)

source code 

Submit an individual job. Return 1 in case of success.

master_input_sandbox is a list of file-names which is shared by all subjobs.

This method is not called directly by the framework. It is only called by the default implementation of master_submit() method.

Therefore if the implementation of master_submit() is able to cope with submission of individual jobs, then submit() is redundant.

Transition from Ganga 4.0.x:

  • subjobconfig is equvalent to jobconfig in the older interface.
  • jobid is an obsolte parameter which will be removed in the future
Overrides: GPIDev.Adapters.IBackend.IBackend.submit
(inherited documentation)

timedetails(self)

source code 

Return all available timestamps from this backend.

Overrides: GPIDev.Adapters.IBackend.IBackend.timedetails

updateMonitoringInformation(jobs)
Static Method

source code 

Update monitoring information for individual jobs: jobs is a list which may contain subjobs as well as the non-split jobs. This method is never called by the framework directly. It may only be called by the default implementation of master_updateMonitoringInformation().

Overrides: GPIDev.Adapters.IBackend.IBackend.updateMonitoringInformation
(inherited documentation)

Class Variable Details [hide private]

_GUIAdvancedPrefs

Value:
[{'attribute': 'nice', 'widget': 'String'},
 {'attribute': 'exitcode', 'widget': 'String'}]

_GUIPrefs

Value:
[{'attribute': 'nice', 'widget': 'String'},
 {'attribute': 'id', 'widget': 'Int'},
 {'attribute': 'status', 'widget': 'String'},
 {'attribute': 'exitcode', 'widget': 'String'}]

_schema

Value:
<Ganga.GPIDev.Schema.Schema.Schema instance at 0x2fe87e8>

actualCE

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec710>

exitcode

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec850>

status

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fe2f90>

workdir

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec790>

wrapper_pid

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x2fec810>

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Jun 25 10:35:21 2012 http://epydoc.sourceforge.net