python.TriggerConfigAccessBase.TriggerConfigAccess Class Reference

Collaboration diagram for python.TriggerConfigAccessBase.TriggerConfigAccess:

Public Member Functions
def	__init__ (self, configType, mainkey, filename=None, jsonString=None, dbalias=None, dbkey=None, useCrest=False, crestServer="")
def	load (self)
def	__str__ (self)
def	__iter__ (self)
def	__getitem__ (self, item)
def	__len__ (self)
def	config (self)
def	prettyPrint (self)
def	name (self)
def	filetype (self)
def	printSummary (self)
def	writeFile (self, filename=None)

Public Attributes
	loader

Private Member Functions
def	_getLoader (self, *configType, filename=None, jsonString=None, dbalias=None, dbkey=None, bool useCrest=False, str crestServer="")

Private Attributes
	_mainkey
	_config

Detailed Description

base class to hold the configuration (OrderedDict) 
and provides basic functions to access and print

Definition at line 425 of file TriggerConfigAccessBase.py.

Constructor & Destructor Documentation

__init__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__init__	(		self,
			configType,
			mainkey,
			filename = None,
			jsonString = None,
			dbalias = None,
			dbkey = None,
			useCrest = False,
			crestServer = ""
	)

Definition at line 430 of file TriggerConfigAccessBase.py.

    def __init__(self, configType, mainkey, filename = None, jsonString = None, dbalias = None, dbkey = None, useCrest=False, crestServer=""):
        self._getLoader(configType = configType, filename = filename, jsonString = jsonString, dbalias = dbalias, dbkey = dbkey, 
                        useCrest=useCrest, crestServer=crestServer)
        self._mainkey = mainkey
        self._config = None
 

Member Function Documentation

__getitem__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__getitem__	(		self,
			item
	)

Definition at line 459 of file TriggerConfigAccessBase.py.

    def __getitem__(self, item):
        return self._config[item]
 

__iter__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__iter__

(

self

)

Definition at line 456 of file TriggerConfigAccessBase.py.

    def __iter__(self):
        return iter(self[self._mainkey])
 

__len__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__len__

(

self

)

Definition at line 462 of file TriggerConfigAccessBase.py.

    def __len__(self):
        return len(self[self._mainkey])
 

__str__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__str__

(

self

)

Definition at line 453 of file TriggerConfigAccessBase.py.

    def __str__(self):
        return str(self._config)
 

_getLoader()

def python.TriggerConfigAccessBase.TriggerConfigAccess._getLoader (   self, *  configType,   filename = None,   jsonString = None,   dbalias = None,   dbkey = None, bool   useCrest = False, str   crestServer = ""  )

private

Definition at line 436 of file TriggerConfigAccessBase.py.

    def _getLoader(self, *, configType, filename = None, jsonString = None, dbalias = None, dbkey = None,
                   useCrest:bool = False, crestServer:str = ""):
        if filename:
            self.loader = ConfigFileLoader( configType, filename )
        elif dbalias and dbkey:
            if useCrest:
                self.loader = ConfigCrestLoader(configType=configType, dbalias=dbalias, dbkey=dbkey, crestServer=crestServer)
            else:
                self.loader = ConfigDBLoader( configType, dbalias, dbkey)
        elif jsonString:
            self.loader = ConfigDirectLoader( configType, jsonString )
        else:
            raise RuntimeError("Neither input file, nor JSON nor db alias and key provided")
 

config()

def python.TriggerConfigAccessBase.TriggerConfigAccess.config

(

self

)

returns the configuration 

Definition at line 465 of file TriggerConfigAccessBase.py.

    def config(self):
        """ returns the configuration """
        return self._config
 

filetype()

def python.TriggerConfigAccessBase.TriggerConfigAccess.filetype

(

self

)

Definition at line 476 of file TriggerConfigAccessBase.py.

    def filetype(self):
        return self["filetype"]
 

load()

def python.TriggerConfigAccessBase.TriggerConfigAccess.load

(

self

)

Definition at line 450 of file TriggerConfigAccessBase.py.

    def load(self):
        self._config = self.loader.load()
 

name()

def python.TriggerConfigAccessBase.TriggerConfigAccess.name

(

self

)

Definition at line 473 of file TriggerConfigAccessBase.py.

    def name(self):
        return self["name"]
 

prettyPrint()

def python.TriggerConfigAccessBase.TriggerConfigAccess.prettyPrint

(

self

)

Definition at line 469 of file TriggerConfigAccessBase.py.

    def prettyPrint(self):
        if self._config:
            print(json.dumps(self._config, indent = 4, separators=(',', ': ')))
    

printSummary()

def python.TriggerConfigAccessBase.TriggerConfigAccess.printSummary

(

self

)

print summary info, should be overwritten by derived classes 

Definition at line 479 of file TriggerConfigAccessBase.py.

    def printSummary(self):
        """ print summary info, should be overwritten by derived classes """
        log.info("Configuration name: {0}".format(self.name()))
        log.info("Configuration size: {0}".format(len(self)))
 

writeFile()

def python.TriggerConfigAccessBase.TriggerConfigAccess.writeFile	(		self,
			filename = None
	)

Definition at line 484 of file TriggerConfigAccessBase.py.

    def writeFile(self, filename = None):
        if filename is None:
            filename: str = self.loader.getWriteFilename()
        with open(filename, 'w') as fh:
            json.dump(self.config(), fh, indent = 4, separators=(',', ': '))
            log.info("Wrote file %s", filename)

Member Data Documentation

_config

python.TriggerConfigAccessBase.TriggerConfigAccess._config

private

Definition at line 434 of file TriggerConfigAccessBase.py.

_mainkey

python.TriggerConfigAccessBase.TriggerConfigAccess._mainkey

private

Definition at line 433 of file TriggerConfigAccessBase.py.

loader

python.TriggerConfigAccessBase.TriggerConfigAccess.loader

Definition at line 438 of file TriggerConfigAccessBase.py.

---

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

• TriggerConfigAccessBase.py