GaudiPython.Bindings Namespace Reference

Classes
class	AppMgr
class	CallbackStreamBuf
class	iAlgorithm
class	iAlgTool
class	iDataSvc
class	iEventSelector
class	iHistogramSvc
class	Interface
class	InterfaceCast
class	iNTupleSvc
class	iProperty
class	iService
class	iToolSvc
class	PropertyEntry
class	PyAlgorithm

Functions
def	toArray (typ)
def	deprecation (message)
def	loaddict (dict)
def	getClass (name, libs=[])
def	_getFIDandEvents (pfn)
def	getComponentProperties (name)
def	_copyFactoriesFromList (factories)

Variables
	__all__
	(c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE". More...
	gbl
	Gaudi
	_gaudi
	Helper
	StringProperty
	StringPropertyRef
	GaudiHandleProperty
	GaudiHandleArrayProperty
	DataObject
	SUCCESS
	FAILURE
	nullptr
	ROOT
	makeNullPointer
	setOwnership
	_CallbackStreamBufBase
	_PyAlgorithm

Function Documentation

_copyFactoriesFromList()

def GaudiPython.Bindings._copyFactoriesFromList (   factories )

private

Definition at line 1416 of file Bindings.py.

def _copyFactoriesFromList(factories):
    result = []
    for i in range(factories.size()):
        factory = factories.front()
        result.append(factory)
        factories.pop_front()
    for factory in result:
        factories.push_back(factory)
    return result
 
 
# ----CallbackStreamBuf--------------------------------------------------------
#    Used for redirecting C++ messages to python

_getFIDandEvents()

def GaudiPython.Bindings._getFIDandEvents (   pfn )

private

Definition at line 1349 of file Bindings.py.

def _getFIDandEvents(pfn):
    tfile = gbl.TFile.Open(pfn)
    if not tfile:
        raise IOError("Cannot open ROOT file {0}".format(pfn))
    tree = tfile.Get("##Params")
    tree.GetEvent(0)
    text = tree.db_string
    if "NAME=FID" in text:
        fid = text[text.rfind("VALUE=") + 6 : -1]
    nevt = tfile.Get("_Event").GetEntries()
    tfile.Close()
    return fid, nevt
 
 
# -----------------------------------------------------------------------------
 
 

deprecation()

def GaudiPython.Bindings.deprecation

(

message

)

Definition at line 133 of file Bindings.py.

def deprecation(message):
    warnings.warn("GaudiPython: " + message, DeprecationWarning, stacklevel=3)
 
 
# ----InterfaceCast class -----------------------------------------------------
 
 

getClass()

def GaudiPython.Bindings.getClass	(		name,
			libs = []
	)

Function to retrieve a certain C++ class by name and to load dictionary if requested

Usage:

from gaudimodule import getClass
# one knows that class is already loaded
AppMgr     = getClass( 'ApplicationMgr'           )
# one knows where to look for class, if not loaded yet
MCParticle = getClass( 'MCParticle' , 'EventDict' )
# one knows where to look for class, if not loaded yet
Vertex     = getClass( 'Vertex' , ['EventDict', 'PhysEventDict'] )

Definition at line 204 of file Bindings.py.

def getClass(name, libs=[]):
    """
    Function to retrieve a certain C++ class by name and to load dictionary if requested
 
    Usage:
 
    from gaudimodule import getClass
    # one knows that class is already loaded
    AppMgr     = getClass( 'ApplicationMgr'           )
    # one knows where to look for class, if not loaded yet
    MCParticle = getClass( 'MCParticle' , 'EventDict' )
    # one knows where to look for class, if not loaded yet
    Vertex     = getClass( 'Vertex' , ['EventDict', 'PhysEventDict'] )
    """
    # see if class is already loaded
    if hasattr(gbl, name):
        return getattr(gbl, name)
    # try to load dictionaries and  look for the required class
    if type(libs) is not list:
        libs = [libs]
    for lib in libs:
        loaddict(lib)
        if hasattr(gbl, name):
            return getattr(gbl, name)
    # return None ( or raise exception? I do not know...  )
    return None
 
 
# ----PropertyEntry class------------------------------------------------------
 
 

getComponentProperties()

def GaudiPython.Bindings.getComponentProperties

(

name

)

Get all the properties of a component as a Python dictionary.
The component is instantiated using the component library

Definition at line 1366 of file Bindings.py.

def getComponentProperties(name):
    """Get all the properties of a component as a Python dictionary.
    The component is instantiated using the component library
    """
    properties = {}
    if name == "GaudiCoreSvc":
        if Helper.loadDynamicLib(name) != 1:
            raise ImportError("Error loading component library " + name)
        factorylist = gbl.FactoryTable.instance().getEntries()
        factories = _copyFactoriesFromList(factorylist)
        _ = AppMgr(outputlevel=7)
    else:
        _ = AppMgr(outputlevel=7)
        if Helper.loadDynamicLib(name) != 1:
            raise ImportError("Error loading component library " + name)
        factorylist = gbl.FactoryTable.instance().getEntries()
        factories = _copyFactoriesFromList(factorylist)
    svcloc = gbl.Gaudi.svcLocator()
    dummysvc = gbl.Service("DummySvc", svcloc)
    for factory in factories:
        if InterfaceCast(gbl.IAlgFactory)(factory):
            ctype = "Algorithm"
        elif InterfaceCast(gbl.ISvcFactory)(factory):
            ctype = "Service"
        elif InterfaceCast(gbl.IToolFactory)(factory):
            ctype = "AlgTool"
        elif factory.ident() == "ApplicationMgr":
            ctype = "ApplicationMgr"
        else:
            ctype = "Unknown"
        cname = factory.ident().split()[-1]
        if ctype in ("Algorithm", "Service", "AlgTool", "ApplicationMgr"):
            try:
                if ctype == "AlgTool":
                    obj = factory.instantiate(dummysvc)
                else:
                    obj = factory.instantiate(svcloc)
            except RuntimeError as text:
                print("Error instantiating", cname, " from ", name)
                print(text)
                continue
            prop = iProperty("dummy", obj)
            properties[cname] = [ctype, prop.properties()]
            try:
                obj.release()
            except Exception:
                pass
    return properties
 
 

loaddict()

def GaudiPython.Bindings.loaddict

(

dict

)

Load an LCG dictionary

Definition at line 191 of file Bindings.py.

def loaddict(dict):
    """Load an LCG dictionary"""
    loadlib_return_code = Helper.loadDynamicLib(dict)
    if loadlib_return_code == 1:
        return
    raise RuntimeError(
        f"Failed to load dictionary library {dict} (return code {loadlib_return_code})"
    )
 
 
# ---get a class (by loading modules if needed)--------------------------------
 
 

toArray()

def GaudiPython.Bindings.toArray

(

typ

)

Definition at line 114 of file Bindings.py.

    def toArray(typ):
        return getattr(Helper, "toArray")
 
else:

Variable Documentation

__all__

GaudiPython.Bindings.__all__

private

(c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations # # This software is distributed under the terms of the Apache version 2 licence, # copied verbatim in the file "LICENSE".

# # In applying this licence, CERN does not waive the privileges and immunities # granted to it by virtue of its status as an Intergovernmental Organization # or submit itself to any jurisdiction. #

File: GaudiPython/Bindings.py Author: Pere Mato (pere..nosp@m.mato.nosp@m.@cern.nosp@m..ch)

Definition at line 19 of file Bindings.py.

_CallbackStreamBufBase

GaudiPython.Bindings._CallbackStreamBufBase

private

Definition at line 1429 of file Bindings.py.

_gaudi

GaudiPython.Bindings._gaudi

private

Definition at line 73 of file Bindings.py.

_PyAlgorithm

GaudiPython.Bindings._PyAlgorithm

private

Definition at line 1446 of file Bindings.py.

DataObject

GaudiPython.Bindings.DataObject

Definition at line 82 of file Bindings.py.

FAILURE

GaudiPython.Bindings.FAILURE

Definition at line 84 of file Bindings.py.

Gaudi

GaudiPython.Bindings.Gaudi

Definition at line 71 of file Bindings.py.

GaudiHandleArrayProperty

GaudiPython.Bindings.GaudiHandleArrayProperty

Definition at line 81 of file Bindings.py.

GaudiHandleProperty

GaudiPython.Bindings.GaudiHandleProperty

Definition at line 80 of file Bindings.py.

gbl

GaudiPython.Bindings.gbl

Definition at line 70 of file Bindings.py.

Helper

GaudiPython.Bindings.Helper

Definition at line 77 of file Bindings.py.

makeNullPointer

GaudiPython.Bindings.makeNullPointer

Definition at line 129 of file Bindings.py.

nullptr

GaudiPython.Bindings.nullptr

Definition at line 87 of file Bindings.py.

ROOT

GaudiPython.Bindings.ROOT

Definition at line 126 of file Bindings.py.

setOwnership

GaudiPython.Bindings.setOwnership

Definition at line 130 of file Bindings.py.

StringProperty

GaudiPython.Bindings.StringProperty

Definition at line 78 of file Bindings.py.

StringPropertyRef

GaudiPython.Bindings.StringPropertyRef

Definition at line 79 of file Bindings.py.

SUCCESS

GaudiPython.Bindings.SUCCESS

Definition at line 83 of file Bindings.py.