Collaboration diagram for python.TriggerConfigAccessBase.TriggerConfigAccess:

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

Public Attributes
ConfigLoader	loader

Static Protected Member Functions
dict[str, str]	_isCrestConnection (str dbalias, bool useCrest, str crestServer)
ConfigLoader	_getLoader (*, configType, str filename="", str jsonString="", str dbalias="", int dbkey=0, bool useCrest=False, str crestServer="")

Protected Attributes
	_mainkey = mainkey
ConfigLoader	_config = None

Detailed Description

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

Definition at line 419 of file TriggerConfigAccessBase.py.

Constructor & Destructor Documentation

◆ init()

python.TriggerConfigAccessBase.TriggerConfigAccess.__init__	(		self,
		ConfigType	configType,
		str	mainkey,
		str	filename = "",
		str	jsonString = "",
		str	dbalias = "",
		int	dbkey = 0,
		bool	useCrest = False,
		str	crestServer = "" )

Definition at line 424 of file TriggerConfigAccessBase.py.

                 dbalias: str = "", dbkey: int = 0, useCrest: bool = False, crestServer: str = ""):
        self.loader: ConfigLoader = TriggerConfigAccess._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()

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

Definition at line 479 of file TriggerConfigAccessBase.py.

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

◆ iter()

python.TriggerConfigAccessBase.TriggerConfigAccess.__iter__ ( self )

Definition at line 476 of file TriggerConfigAccessBase.py.

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

◆ len()

python.TriggerConfigAccessBase.TriggerConfigAccess.__len__ ( self )

Definition at line 482 of file TriggerConfigAccessBase.py.

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

◆ str()

python.TriggerConfigAccessBase.TriggerConfigAccess.__str__ ( self )

Definition at line 473 of file TriggerConfigAccessBase.py.

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

◆ _getLoader()

ConfigLoader python.TriggerConfigAccessBase.TriggerConfigAccess._getLoader	(	*	,
			configType,
		str	filename = "",
		str	jsonString = "",
		str	dbalias = "",
		int	dbkey = 0,
		bool	useCrest = False,
		str	crestServer = "" )

staticprotected

Definition at line 455 of file TriggerConfigAccessBase.py.

                   useCrest: bool = False, crestServer: str = "") -> ConfigLoader:
 
        if filename:
            return ConfigFileLoader(configType, filename )
        elif dbalias and dbkey>0:
            if (connParams := TriggerConfigAccess._isCrestConnection(dbalias, useCrest, crestServer)):
                return ConfigCrestLoader(configType=configType, dbname=connParams["dbname"], dbkey=dbkey, crestServer=connParams["crest_server"])
            else:
                return ConfigDBLoader(configType, dbalias, dbkey)
        elif jsonString:
            return ConfigDirectLoader(configType, jsonString )
        else:
            raise RuntimeError("Neither input file, nor JSON nor db alias and key provided")
 

◆ _isCrestConnection()

dict[str, str] python.TriggerConfigAccessBase.TriggerConfigAccess._isCrestConnection	(	str	dbalias,
		bool	useCrest,
		str	crestServer )

staticprotected

 Determine whether the connection is a CREST connection

Definition at line 432 of file TriggerConfigAccessBase.py.

    def _isCrestConnection(dbalias: str, useCrest: bool, crestServer: str) -> dict[str, str]:
        """ Determine whether the connection is a CREST connection
        """
        connParams: dict[str, str] = {}
        if dbalias.startswith("http://") or dbalias.startswith("https://"):
            # expect a complete crest connection string, consisting of server and dbname
            if (match := re.match(r'^(http[s]?://[^/]+/api-v\d+\.\d+)/(.+)$', dbalias)):
                connParams["crest_server"] = match.group(1)
                connParams["dbname"] = match.group(2)
            else:
                raise RuntimeError(f"Invalid CREST connection string: {dbalias}")
        elif dbalias in TriggerCrestUtil.allCrestConnections():
            connParams["crest_server"] = crestServer
            connParams["dbname"] = dbalias
        elif useCrest:
            connParams["crest_server"] = crestServer
            if (dbname := TriggerCrestUtil.getCrestConnection(dbalias)) is not None:
                connParams["dbname"] = dbname
            else:
                raise RuntimeError(f"Cannot resolve CREST connection '{dbalias}'")
        return connParams
 

◆ config()

python.TriggerConfigAccessBase.TriggerConfigAccess.config ( self )

returns the configuration

Definition at line 485 of file TriggerConfigAccessBase.py.

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

◆ filetype()

python.TriggerConfigAccessBase.TriggerConfigAccess.filetype ( self )

Definition at line 496 of file TriggerConfigAccessBase.py.

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

◆ load()

None python.TriggerConfigAccessBase.TriggerConfigAccess.load ( self )

Definition at line 470 of file TriggerConfigAccessBase.py.

    def load(self) -> None:
        self._config = self.loader.load()
 

◆ name()

python.TriggerConfigAccessBase.TriggerConfigAccess.name ( self )

Definition at line 493 of file TriggerConfigAccessBase.py.

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

◆ prettyPrint()

python.TriggerConfigAccessBase.TriggerConfigAccess.prettyPrint ( self )

Definition at line 489 of file TriggerConfigAccessBase.py.

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

◆ printSummary()

python.TriggerConfigAccessBase.TriggerConfigAccess.printSummary ( self )

print summary info, should be overwritten by derived classes

Definition at line 499 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()

python.TriggerConfigAccessBase.TriggerConfigAccess.writeFile	(		self,
		str \| None	filename = None )

Definition at line 504 of file TriggerConfigAccessBase.py.

    def writeFile(self, filename: str | None = None):
        if filename is None:
            filename = 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 = None

protected

Definition at line 429 of file TriggerConfigAccessBase.py.

◆ _mainkey

python.TriggerConfigAccessBase.TriggerConfigAccess._mainkey = mainkey

protected

Definition at line 428 of file TriggerConfigAccessBase.py.

◆ loader

ConfigLoader python.TriggerConfigAccessBase.TriggerConfigAccess.loader

Initial value:

= TriggerConfigAccess._getLoader(configType = configType, filename = filename, jsonString = jsonString, dbalias = dbalias, dbkey = dbkey,

useCrest=useCrest, crestServer=crestServer)

Definition at line 426 of file TriggerConfigAccessBase.py.

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

TriggerConfigAccessBase.py

Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes