python.trfUtils.Job Class Reference

Job: a set of pieces of information relevant to a given work function. More...

Inheritance diagram for python.trfUtils.Job:

Collaboration diagram for python.trfUtils.Job:

Public Member Functions
def	__init__ (self, workFunction=None, workFunctionKeywordArguments={}, workFunctionTimeout=None, name=None)
	initialisation method More...
def	name (self)
def	__str__ (self)
	return an object self description string More...
def	printout (self)
	print in a human-readable way the items of the object self More...

Public Attributes
	workFunction
	workFunctionKeywordArguments
	workFunctionTimeout
	className
	resultGetter

Private Attributes
	_name

Detailed Description

Job: a set of pieces of information relevant to a given work function.

A Job object is a set of pieces of information relevant to a given work function. A Job object comprises a name, a work function, work function arguments, the work function timeout specification, a multiprocessing.Pool.apply_async() object and, ultimately, a result object.

Parameters

name	the Job object name
workFunction	the work function object
workFunctionArguments	the work function keyword arguments dictionary
workFunctionTimeout	the work function timeout specification in seconds

Definition at line 723 of file trfUtils.py.

Constructor & Destructor Documentation

__init__()

def python.trfUtils.Job.__init__	(		self,
			workFunction = None,
			workFunctionKeywordArguments = {},
			workFunctionTimeout = None,
			name = None
	)

initialisation method

Definition at line 726 of file trfUtils.py.

    def __init__(
        self,
        workFunction = None,
        workFunctionKeywordArguments = {},
        workFunctionTimeout = None,
        name = None,
        ):
        self.workFunction = workFunction
        self.workFunctionKeywordArguments = workFunctionKeywordArguments
        self.workFunctionTimeout = workFunctionTimeout
        self.className = self.__class__.__name__
        self.resultGetter = None
        if name is None:
            self._name = uniqueIdentifier()
        else:
            self._name = name
        if self.workFunction is None:
            exceptionMessage = "work function not specified"
            msg.error("{notifier}: exception message: {exceptionMessage}".format(
                notifier = self.className,
                exceptionMessage = exceptionMessage
            ))
            raise trfExceptions.TransformInternalException(
                trfExit.nameToCode('TRF_INTERNAL'),
                exceptionMessage
            )
 

Member Function Documentation

__str__()

def python.trfUtils.Job.__str__

(

self

)

return an object self description string

This method returns an object description string consisting of a listing of the items of the object self.

Returns

object description string

Definition at line 761 of file trfUtils.py.

    def __str__(self):
        descriptionString = ""
        for key, value in sorted(vars(self).items()):
            descriptionString += str("{key}:{value} ".format(
                key = key,
                value = value)
            )
        return descriptionString
 

name()

def python.trfUtils.Job.name

(

self

)

Definition at line 754 of file trfUtils.py.

    def name(self):
        return self._name
 

printout()

def python.trfUtils.Job.printout

(

self

)

print in a human-readable way the items of the object self

This function prints in a human-readable way the items of the object self.

Definition at line 773 of file trfUtils.py.

    def printout(self):
        printHR(vars(self))
 
 

Member Data Documentation

_name

python.trfUtils.Job._name

private

Definition at line 733 of file trfUtils.py.

className

python.trfUtils.Job.className

Definition at line 730 of file trfUtils.py.

resultGetter

python.trfUtils.Job.resultGetter

Definition at line 731 of file trfUtils.py.

workFunction

python.trfUtils.Job.workFunction

Definition at line 727 of file trfUtils.py.

workFunctionKeywordArguments

python.trfUtils.Job.workFunctionKeywordArguments

Definition at line 728 of file trfUtils.py.

workFunctionTimeout

python.trfUtils.Job.workFunctionTimeout

Definition at line 729 of file trfUtils.py.

---

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

• trfUtils.py