GaudiPython.Bindings.iProperty Class Reference

Inheritance diagram for GaudiPython.Bindings.iProperty:

Public Member Functions
	__init__ (self, name, ip=cppyy.nullptr)
	getInterface (self)
	retrieveInterface (self)
	__call_interface_method__ (self, ifname, method, *args)
	__setattr__ (self, name, value)
	__getattr__ (self, name)
	properties (self)
	name (self)

Protected Attributes
	_ip
	_svcloc
	_name

Detailed Description

Python equivalent to the C++ Property interface

Definition at line 281 of file Bindings.py.

Constructor & Destructor Documentation

__init__()

GaudiPython.Bindings.iProperty.__init__	(		self,
			name,
			ip = cppyy.nullptr )

Definition at line 284 of file Bindings.py.

    def __init__(self, name, ip=cppyy.nullptr):
        self.__dict__["_ip"] = InterfaceCast(gbl.IProperty)(ip)
        self.__dict__["_svcloc"] = gbl.Gaudi.svcLocator()
        self.__dict__["_name"] = name
 

Member Function Documentation

__call_interface_method__()

GaudiPython.Bindings.iProperty.__call_interface_method__	(		self,
			ifname,
			method,
		*	args )

Definition at line 297 of file Bindings.py.

    def __call_interface_method__(self, ifname, method, *args):
        if not getattr(self, ifname):
            self.retrieveInterface()
        return getattr(getattr(self, ifname), method)(*args)
 

__getattr__()

GaudiPython.Bindings.iProperty.__getattr__	(		self,
			name )

The method which returns the value for the given property
- In the case of the valid instance it returns the valid property value through IProperty interface
- In the case of placeholder the property value is retrieved from JobOptionsCatalogue

Definition at line 329 of file Bindings.py.

    def __getattr__(self, name):
        """
        The method which returns the value for the given property
        - In the case of the valid instance it returns the valid property value through IProperty interface
        - In the case of placeholder the property value is retrieved from JobOptionsCatalogue
        """
        ip = self.getInterface()
        if ip:
            if not gbl.Gaudi.Utils.hasProperty(ip, name):
                raise AttributeError(f"property {name} does not exist")
            prop = ip.getProperty(name)
            if isinstance(prop, StringProperty):
                return prop.value()
            elif isinstance(prop, StringPropertyRef):
                return prop.value()
            try:
                return eval(prop.toString(), {}, {})
            except Exception:
                return prop.value()
        else:
            opts = self._svcloc.getOptsSvc()
            if opts.has(f"{self._name}.{name}"):
                # from JobOptionsSvc we always have only strings
                return eval(opts.get(f"{self._name}.{name}"), {}, {})
            raise AttributeError(f"property {name} does not exist")
 

__setattr__()

GaudiPython.Bindings.iProperty.__setattr__	(		self,
			name,
			value )

The method which is used for setting the property from the given value.
- In the case of the valid instance it sets the property through IProperty interface
- In the case of placeholder the property is added to JobOptionsCatalogue

Definition at line 302 of file Bindings.py.

    def __setattr__(self, name, value):
        """
        The method which is used for setting the property from the given value.
        - In the case of the valid instance it sets the property through IProperty interface
        - In the case of placeholder the property is added to JobOptionsCatalogue
        """
        if hasattr(value, "toStringProperty"):
            # user defined behaviour
            value = str(value.toStringProperty())
        elif hasattr(value, "toString"):
            value = str(value.toString())
        elif isinstance(value, set) and value:
            # We want a reproducible (sorted) representation in the catalogue
            value = "{" + repr(sorted(value))[1:-1] + "}"
        else:
            value = str(value)
 
        ip = self.getInterface()
        if ip:
            if not gbl.Gaudi.Utils.hasProperty(ip, name):
                raise AttributeError(f"property {name} does not exist")
            ip.setPropertyRepr(name, value)
        else:
            gbl.GaudiPython.Helpers.setProperty(
                self._svcloc, ".".join([self._name, name]), value
            )
 

getInterface()

GaudiPython.Bindings.iProperty.getInterface

(

self

)

Definition at line 289 of file Bindings.py.

    def getInterface(self):
        if not self._ip:
            self.retrieveInterface()
        return self._ip
 

name()

GaudiPython.Bindings.iProperty.name

(

self

)

Reimplemented in GaudiPython.Bindings.iAlgTool.

Definition at line 376 of file Bindings.py.

    def name(self):
        return self._name
 
 
# ----iService class-----------------------------------------------------------
 
 

properties()

GaudiPython.Bindings.iProperty.properties

(

self

)

Definition at line 355 of file Bindings.py.

    def properties(self):
        dct = {}
        props = None
        ip = self.getInterface()
        if ip:
            props = ip.getProperties()
            propsFrom = self._name  # "interface"
        else:
            raise NotImplementedError("rely on IJobOptionsSvc")
            props = self._optsvc.getProperties(self._name)
            propsFrom = "jobOptionsSvc"
        if props:
            for p in props:
                try:
                    dct[p.name()] = PropertyEntry(p)
                except (ValueError, TypeError) as e:
                    raise ValueError(
                        f"gaudimodule.iProperty.properties(): {e.__class__.__name__}{e.args} processing property {propsFrom}.{p.name()} = {p.value()}"
                    )
        return dct
 

retrieveInterface()

GaudiPython.Bindings.iProperty.retrieveInterface

(

self

)

Reimplemented in GaudiPython.Bindings.iAlgorithm, GaudiPython.Bindings.iAlgTool, and GaudiPython.Bindings.iService.

Definition at line 294 of file Bindings.py.

    def retrieveInterface(self):
        pass
 

Member Data Documentation

_ip

GaudiPython.Bindings.iProperty._ip

protected

Definition at line 290 of file Bindings.py.

_name

GaudiPython.Bindings.iProperty._name

protected

Definition at line 326 of file Bindings.py.

_svcloc

GaudiPython.Bindings.iProperty._svcloc

protected

Definition at line 326 of file Bindings.py.

---

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

• GaudiPython/python/GaudiPython/Bindings.py