python.trfReports.trfReport Class Reference

Base (almost virtual) report from which all real transform reports derive. More...

Inheritance diagram for python.trfReports.trfReport:

Collaboration diagram for python.trfReports.trfReport:

Public Member Functions
def	__init__ (self)
def	__str__ (self)
	String representation of the job report. More...
def	python (self, fast=False, fileReport=defaultFileReport)
	Method which returns a python representation of a report. More...
def	json (self, fast=False)
	Method which returns a JSON representation of a report. More...
def	classicEltree (self, fast=False)
	Method which returns an ElementTree.Element representation of the old POOLFILECATALOG report. More...
def	classicPython (self, fast=False)
	Method which returns a python representation of a report in classic Tier 0 style. More...
def	writeJSONReport (self, filename, sort_keys=True, indent=2, fast=False, fileReport=defaultFileReport)
def	writeTxtReport (self, filename, dumpEnv=True, fast=False, fileReport=defaultFileReport)
def	writeGPickleReport (self, filename, fast=False)
def	writeClassicXMLReport (self, filename, fast=False)
def	writePilotPickleReport (self, filename, fast=False, fileReport=defaultFileReport)

Private Attributes
	_dataDictionary

Detailed Description

Base (almost virtual) report from which all real transform reports derive.

Definition at line 39 of file trfReports.py.

Constructor & Destructor Documentation

__init__()

def python.trfReports.trfReport.__init__

(

self

)

Definition at line 40 of file trfReports.py.

    def __init__(self):
        self._dataDictionary = {}
        pass
 

Member Function Documentation

__str__()

def python.trfReports.trfReport.__str__

(

self

)

String representation of the job report.

Uses pprint module to output the python object as text

Note

This is a 'property', so no fast option is available

Definition at line 47 of file trfReports.py.

    def __str__(self):
        return pprint.pformat(self.python())
 

classicEltree()

def python.trfReports.trfReport.classicEltree	(		self,
			fast = False
	)

Method which returns an ElementTree.Element representation of the old POOLFILECATALOG report.

Parameters

fast	Boolean which forces the fastest possible report to be written

Reimplemented in python.trfReports.trfJobReport.

Definition at line 63 of file trfReports.py.

    def classicEltree(self, fast = False):
        return ElementTree.Element('POOLFILECATALOG')
 

classicPython()

def python.trfReports.trfReport.classicPython	(		self,
			fast = False
	)

Method which returns a python representation of a report in classic Tier 0 style.

Parameters

fast	Boolean which forces the fastest possible report to be written

Reimplemented in python.trfReports.trfJobReport.

Definition at line 68 of file trfReports.py.

    def classicPython(self, fast = False):
        return {}
 

json()

def python.trfReports.trfReport.json	(		self,
			fast = False
	)

Method which returns a JSON representation of a report.

Parameters

fast	Boolean which forces the fastest possible report to be written

Calls json.dumps on the python representation

Definition at line 58 of file trfReports.py.

    def json(self, fast = False):
        return json.dumps(self.python, type)
 

python()

def python.trfReports.trfReport.python	(		self,
			fast = False,
			fileReport = defaultFileReport
	)

Method which returns a python representation of a report.

Parameters

fast	Boolean which forces the fastest possible report to be written

Reimplemented in python.trfReports.trfJobReport.

Definition at line 52 of file trfReports.py.

    def python(self, fast = False, fileReport = defaultFileReport):
        return {}
 

writeClassicXMLReport()

def python.trfReports.trfReport.writeClassicXMLReport	(		self,
			filename,
			fast = False
	)

Definition at line 104 of file trfReports.py.

    def writeClassicXMLReport(self, filename, fast = False):
        with open(filename, 'w') as report:
            print(prettyXML(self.classicEltree(fast = fast), poolFileCatalogFormat = True), file=report)
 

writeGPickleReport()

def python.trfReports.trfReport.writeGPickleReport	(		self,
			filename,
			fast = False
	)

Definition at line 100 of file trfReports.py.

    def writeGPickleReport(self, filename, fast = False):
        with open(filename, 'wb') as report:
            pickle.dump(self.classicPython(fast = fast), report)
 

writeJSONReport()

def python.trfReports.trfReport.writeJSONReport	(		self,
			filename,
			sort_keys = True,
			indent = 2,
			fast = False,
			fileReport = defaultFileReport
	)

Definition at line 71 of file trfReports.py.

    def writeJSONReport(self, filename, sort_keys = True, indent = 2, fast = False, fileReport = defaultFileReport):
        with open(filename, 'w') as report:
            try:
                if not self._dataDictionary:
                    self._dataDictionary = self.python(fast=fast, fileReport=fileReport)
 
                json.dump(self._dataDictionary, report, sort_keys = sort_keys, indent = indent)
            except TypeError as e:
                # TypeError means we had an unserialisable object - re-raise as a trf internal
                message = 'TypeError raised during JSON report output: {0!s}'.format(e)
                msg.error(message)
                raise trfExceptions.TransformReportException(trfExit.nameToCode('TRF_INTERNAL_REPORT_ERROR'), message)
 

writePilotPickleReport()

def python.trfReports.trfReport.writePilotPickleReport	(		self,
			filename,
			fast = False,
			fileReport = defaultFileReport
	)

Definition at line 108 of file trfReports.py.

    def writePilotPickleReport(self, filename, fast = False, fileReport = defaultFileReport):
        with open(filename, 'w') as report:
            if not self._dataDictionary:
                self._dataDictionary = self.python(fast = fast, fileReport = fileReport)
 
            pickle.dump(self._dataDictionary, report)
 
 

writeTxtReport()

def python.trfReports.trfReport.writeTxtReport	(		self,
			filename,
			dumpEnv = True,
			fast = False,
			fileReport = defaultFileReport
	)

Definition at line 84 of file trfReports.py.

    def writeTxtReport(self, filename, dumpEnv = True, fast = False, fileReport = defaultFileReport):
        with open(filename, 'w') as report:
            if not self._dataDictionary:
                self._dataDictionary = self.python(fast = fast, fileReport = fileReport)
 
            print('# {0} file generated on'.format(self.__class__.__name__), isodate(), file=report)
            print(pprint.pformat(self._dataDictionary), file=report)
            if dumpEnv:
                print('# Environment dump', file=report)
                eKeys = list(os.environ)
                eKeys.sort()
                for k in eKeys:
                    print('%s=%s' % (k, os.environ[k]), file=report)
            print('# Machine report', file=report)
            print(pprint.pformat(machineReport().python(fast = fast)), file=report)
 

Member Data Documentation

_dataDictionary

python.trfReports.trfReport._dataDictionary

private

Definition at line 41 of file trfReports.py.

---

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

• trfReports.py