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
list	__all__
	long = int
	gbl = cppyy.gbl
	Gaudi = gbl.Gaudi
	_gaudi = None
	Helper = gbl.GaudiPython.Helper
	StringProperty = gbl.Gaudi.Property("std::string")
	StringPropertyRef = gbl.Gaudi.Property("std::string&")
	GaudiHandleProperty = gbl.GaudiHandleProperty
	GaudiHandleArrayProperty = gbl.GaudiHandleArrayProperty
	DataObject = gbl.DataObject
	SUCCESS = gbl.StatusCode(gbl.StatusCode.SUCCESS)
	FAILURE = gbl.StatusCode(gbl.StatusCode.FAILURE)
	nullptr = cppyy.nullptr
	ROOT = cppyy.libPyROOT
	makeNullPointer = ROOT.MakeNullPointer
	setOwnership = ROOT.SetOwnership
	_CallbackStreamBufBase = gbl.GaudiPython.CallbackStreamBuf
	_PyAlgorithm = gbl.GaudiPython.PyAlgorithm

Function Documentation

_copyFactoriesFromList()

def GaudiPython.Bindings._copyFactoriesFromList (   factories )

private

Definition at line 1402 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 1335 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 139 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 210 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 1352 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)
        g = AppMgr(outputlevel=7)
    else:
        g = 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:
                pass
    return properties
 
 

loaddict()

def GaudiPython.Bindings.loaddict

(

dict

)

Load an LCG dictionary

Definition at line 197 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 120 of file Bindings.py.

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

Variable Documentation

__all__

list GaudiPython.Bindings.__all__

private

Initial value:

=  [
    "gbl",
    "InterfaceCast",
    "Interface",
    "PropertyEntry",
    "AppMgr",
    "PyAlgorithm",
    "CallbackStreamBuf",
    "iAlgorithm",
    "iDataSvc",
    "iHistogramSvc",
    "iNTupleSvc",
    "iService",
    "iAlgTool",
    "Helper",
    "SUCCESS",
    "FAILURE",
    "toArray",
    "ROOT",
    "makeNullPointer",
    "setOwnership",
    "getClass",
    "loaddict",
    "deprecation",
]

Definition at line 20 of file Bindings.py.

_CallbackStreamBufBase

GaudiPython.Bindings._CallbackStreamBufBase = gbl.GaudiPython.CallbackStreamBuf

private

Definition at line 1415 of file Bindings.py.

_gaudi

GaudiPython.Bindings._gaudi = None

private

Definition at line 79 of file Bindings.py.

_PyAlgorithm

GaudiPython.Bindings._PyAlgorithm = gbl.GaudiPython.PyAlgorithm

private

Definition at line 1432 of file Bindings.py.

DataObject

GaudiPython.Bindings.DataObject = gbl.DataObject

Definition at line 88 of file Bindings.py.

FAILURE

GaudiPython.Bindings.FAILURE = gbl.StatusCode(gbl.StatusCode.FAILURE)

Definition at line 90 of file Bindings.py.

Gaudi

GaudiPython.Bindings.Gaudi = gbl.Gaudi

Definition at line 77 of file Bindings.py.

GaudiHandleArrayProperty

GaudiPython.Bindings.GaudiHandleArrayProperty = gbl.GaudiHandleArrayProperty

Definition at line 87 of file Bindings.py.

GaudiHandleProperty

GaudiPython.Bindings.GaudiHandleProperty = gbl.GaudiHandleProperty

Definition at line 86 of file Bindings.py.

gbl

GaudiPython.Bindings.gbl = cppyy.gbl

Definition at line 76 of file Bindings.py.

Helper

GaudiPython.Bindings.Helper = gbl.GaudiPython.Helper

Definition at line 83 of file Bindings.py.

long

GaudiPython.Bindings.long = int

Definition at line 61 of file Bindings.py.

makeNullPointer

GaudiPython.Bindings.makeNullPointer = ROOT.MakeNullPointer

Definition at line 135 of file Bindings.py.

nullptr

GaudiPython.Bindings.nullptr = cppyy.nullptr

Definition at line 93 of file Bindings.py.

ROOT

GaudiPython.Bindings.ROOT = cppyy.libPyROOT

Definition at line 132 of file Bindings.py.

setOwnership

GaudiPython.Bindings.setOwnership = ROOT.SetOwnership

Definition at line 136 of file Bindings.py.

StringProperty

GaudiPython.Bindings.StringProperty = gbl.Gaudi.Property("std::string")

Definition at line 84 of file Bindings.py.

StringPropertyRef

GaudiPython.Bindings.StringPropertyRef = gbl.Gaudi.Property("std::string&")

Definition at line 85 of file Bindings.py.

SUCCESS

GaudiPython.Bindings.SUCCESS = gbl.StatusCode(gbl.StatusCode.SUCCESS)

Definition at line 89 of file Bindings.py.