Belle II Software  release-06-01-15
Local.LocalResult Class Reference
Inheritance diagram for Local.LocalResult:
Collaboration diagram for Local.LocalResult:

Public Member Functions

def __init__ (self, job, result)
 
def update_status (self)
 
def ready (self)
 
def get_exit_code_from_file (self)
 

Public Attributes

 result
 The underlying result from the backend.
 
 job
 Job object for result.
 
 time_to_wait_for_exit_code_file
 After our first attempt to view the exit code file once the job is 'finished', how long should we wait for it to exist before timing out?
 
 exit_code_file_initial_time
 Time we started waiting for the exit code file to appear.
 

Private Member Functions

def _update_result_status (self)
 

Private Attributes

 _is_ready
 Quicker way to know if it's ready once it has already been found. More...
 

Detailed Description

Result class to help monitor status of jobs submitted by Local backend.

Definition at line 919 of file backends.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  job,
  result 
)
Pass in the job object and the multiprocessing result to allow the result to do monitoring and perform
post processing of the job.

Definition at line 924 of file backends.py.

Member Function Documentation

◆ get_exit_code_from_file()

def get_exit_code_from_file (   self)
inherited
Read the exit code file to discover the exit status of the job command. Useful falback if the job is no longer
known to the job database (batch system purged it for example). Since some backends may take time to download
the output files of the job back to the working directory we use a time limit on how long to wait.

Definition at line 879 of file backends.py.

◆ ready()

def ready (   self)
inherited
Returns whether or not this job result is known to be ready. Doesn't actually change the job status. Just changes
the 'readiness' based on the known job status.

Definition at line 858 of file backends.py.

◆ update_status()

def update_status (   self)
Update the job's (or subjobs') status by calling the result object.

Reimplemented from Result.

Definition at line 941 of file backends.py.

Member Data Documentation

◆ _is_ready

_is_ready
privateinherited

Quicker way to know if it's ready once it has already been found.

Saves a lot of calls to batch system commands.

Definition at line 851 of file backends.py.


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