ATLAS Offline Software
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
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 (dict)
and provides basic functions to access and print


Definition at line 423 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 428 of file TriggerConfigAccessBase.py.

428  def __init__(self, configType, mainkey, filename = None, jsonString = None, dbalias = None, dbkey = None, useCrest=False, crestServer=""):
429  self._getLoader(configType = configType, filename = filename, jsonString = jsonString, dbalias = dbalias, dbkey = dbkey,
430  useCrest=useCrest, crestServer=crestServer)
431  self._mainkey = mainkey
432  self._config = None
433 

Member Function Documentation

◆ __getitem__()

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

Definition at line 457 of file TriggerConfigAccessBase.py.

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

◆ __iter__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__iter__ (   self)

Definition at line 454 of file TriggerConfigAccessBase.py.

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

◆ __len__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__len__ (   self)

Definition at line 460 of file TriggerConfigAccessBase.py.

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

◆ __str__()

def python.TriggerConfigAccessBase.TriggerConfigAccess.__str__ (   self)

Definition at line 451 of file TriggerConfigAccessBase.py.

451  def __str__(self):
452  return str(self._config)
453 

◆ _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 434 of file TriggerConfigAccessBase.py.

434  def _getLoader(self, *, configType, filename = None, jsonString = None, dbalias = None, dbkey = None,
435  useCrest:bool = False, crestServer:str = ""):
436  if filename:
437  self.loader = ConfigFileLoader( configType, filename )
438  elif dbalias and dbkey:
439  if useCrest:
440  self.loader = ConfigCrestLoader(configType=configType, dbalias=dbalias, dbkey=dbkey, crestServer=crestServer)
441  else:
442  self.loader = ConfigDBLoader( configType, dbalias, dbkey)
443  elif jsonString:
444  self.loader = ConfigDirectLoader( configType, jsonString )
445  else:
446  raise RuntimeError("Neither input file, nor JSON nor db alias and key provided")
447 

◆ config()

def python.TriggerConfigAccessBase.TriggerConfigAccess.config (   self)
returns the configuration 

Definition at line 463 of file TriggerConfigAccessBase.py.

463  def config(self):
464  """ returns the configuration """
465  return self._config
466 

◆ filetype()

def python.TriggerConfigAccessBase.TriggerConfigAccess.filetype (   self)

Definition at line 474 of file TriggerConfigAccessBase.py.

474  def filetype(self):
475  return self["filetype"]
476 

◆ load()

def python.TriggerConfigAccessBase.TriggerConfigAccess.load (   self)

Definition at line 448 of file TriggerConfigAccessBase.py.

448  def load(self):
449  self._config = self.loader.load()
450 

◆ name()

def python.TriggerConfigAccessBase.TriggerConfigAccess.name (   self)

Definition at line 471 of file TriggerConfigAccessBase.py.

471  def name(self):
472  return self["name"]
473 

◆ prettyPrint()

def python.TriggerConfigAccessBase.TriggerConfigAccess.prettyPrint (   self)

Definition at line 467 of file TriggerConfigAccessBase.py.

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

◆ printSummary()

def python.TriggerConfigAccessBase.TriggerConfigAccess.printSummary (   self)
print summary info, should be overwritten by derived classes 

Definition at line 477 of file TriggerConfigAccessBase.py.

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

◆ writeFile()

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

Definition at line 482 of file TriggerConfigAccessBase.py.

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

Member Data Documentation

◆ _config

python.TriggerConfigAccessBase.TriggerConfigAccess._config
private

Definition at line 432 of file TriggerConfigAccessBase.py.

◆ _mainkey

python.TriggerConfigAccessBase.TriggerConfigAccess._mainkey
private

Definition at line 431 of file TriggerConfigAccessBase.py.

◆ loader

python.TriggerConfigAccessBase.TriggerConfigAccess.loader

Definition at line 436 of file TriggerConfigAccessBase.py.


The documentation for this class was generated from the following file:
createLinkingScheme.iter
iter
Definition: createLinkingScheme.py:62
vtune_athena.format
format
Definition: vtune_athena.py:14
python.base_data.config
config
Definition: base_data.py:20
python.Bindings.__iter__
__iter__
Definition: Control/AthenaPython/python/Bindings.py:794
print
void print(char *figname, TCanvas *c1)
Definition: TRTCalib_StrawStatusPlots.cxx:25
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
python.processes.powheg.ZZ.ZZ.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ZZ.py:18
Trk::open
@ open
Definition: BinningType.h:40
str
Definition: BTagTrackIpAccessor.cxx:11
python.root_pickle.load
def load(f, use_proxy=1, key=None)
Definition: root_pickle.py:476
python.Bindings.__getitem__
__getitem__
Definition: Control/AthenaPython/python/Bindings.py:782