Result Class Reference

Inheritance diagram for Result:

Public Member Functions
	__init__ (self, job)
	ready (self)
	update_status (self)
	get_exit_code_from_file (self)

Public Attributes
	job = job
	Job object for result.
	time_to_wait_for_exit_code_file = timedelta(minutes=5)
	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 = None
	Time we started waiting for the exit code file to appear.

Protected Attributes
bool	_is_ready = False
	Quicker way to know if it's ready once it has already been found.

Detailed Description

Base class for Result objects. A Result is created for each `Job` (or `Job.SubJob`) object
submitted to a backend. It provides a way to query a job's status to find out if it's ready.

Definition at line 867 of file backends.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			job )

Pass in the job object to allow the result to access the job's properties and do post-processing.

Definition at line 873 of file backends.py.

    def __init__(self, job):
        """
        Pass in the job object to allow the result to access the job's properties and do post-processing.
        """
        
        self.job = job
        
        self._is_ready = False
        
        self.time_to_wait_for_exit_code_file = timedelta(minutes=5)
        
        self.exit_code_file_initial_time = None
 

Member Function Documentation

get_exit_code_from_file()

get_exit_code_from_file

(

self

)

Read the exit code file to discover the exit status of the job command. Useful fallback 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 908 of file backends.py.

    def get_exit_code_from_file(self):
        """
        Read the exit code file to discover the exit status of the job command. Useful fallback 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.
        """
        if not self.exit_code_file_initial_time:
            self.exit_code_file_initial_time = datetime.now()
        exit_code_path = Path(self.job.working_dir, Backend.exit_code_file)
        with open(exit_code_path) as f:
            exit_code = int(f.read().strip())
            B2DEBUG(29, f"Exit code from file for {self.job} was {exit_code}")
            return exit_code
 
 

ready()

ready

(

self

)

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 887 of file backends.py.

    def ready(self):
        """
        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.
        """
        B2DEBUG(29, f"Calling {self.job}.result.ready()")
        if self._is_ready:
            return True
        elif self.job.status in self.job.exit_statuses:
            self._is_ready = True
            return True
        else:
            return False
 

update_status()

update_status

(

self

)

Update the job's (and subjobs') status so that `Result.ready` will return the up to date status. This call will have to
actually look up the job's status from some database/exit code file.

Reimplemented in HTCondor.HTCondorResult, Local.LocalResult, LSF.LSFResult, and PBS.PBSResult.

Definition at line 901 of file backends.py.

    def update_status(self):
        """
        Update the job's (and subjobs') status so that `Result.ready` will return the up to date status. This call will have to
        actually look up the job's status from some database/exit code file.
        """
        raise NotImplementedError
 

Member Data Documentation

_is_ready

bool _is_ready = False

protected

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 880 of file backends.py.

exit_code_file_initial_time

exit_code_file_initial_time = None

Time we started waiting for the exit code file to appear.

Definition at line 885 of file backends.py.

job

job = job

Job object for result.

Definition at line 878 of file backends.py.

time_to_wait_for_exit_code_file

time_to_wait_for_exit_code_file = timedelta(minutes=5)

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?

Definition at line 883 of file backends.py.

---

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

• calibration/scripts/caf/backends.py