GaudiKernel.PropertyProxy.PropertyProxy Class Reference

Inheritance diagram for GaudiKernel.PropertyProxy.PropertyProxy:

Collaboration diagram for GaudiKernel.PropertyProxy.PropertyProxy:

Public Member Functions
def	__init__ (self, descr, docString=None, default=None)
def	setDefault (self, value)
def	getDefault (self)
def	fullPropertyName (self, obj)
def	__get__ (self, obj, type=None)
def	__set__ (self, obj, value)
def	__delete__ (self, obj)

Public Attributes
	history
	descr
	deprecated

Properties
	default = property(getDefault, setDefault)

Private Attributes
	__doc__
	__default

Detailed Description

Definition at line 80 of file PropertyProxy.py.

Constructor & Destructor Documentation

__init__()

def GaudiKernel.PropertyProxy.PropertyProxy.__init__	(		self,
			descr,
			docString = None,
			default = None
	)

Reimplemented in GaudiKernel.PropertyProxy.DataHandlePropertyProxy, GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy, and GaudiKernel.PropertyProxy.GaudiHandlePropertyProxy.

Definition at line 81 of file PropertyProxy.py.

    def __init__(self, descr, docString=None, default=None):
        self.history = {}
        self.descr = descr
        self.deprecated = False
        if docString:
            self.__doc__ = docString
            if "[[deprecated]]" in docString:
                self.deprecated = True
        if default is not None:
            self.default = default
 

Member Function Documentation

__delete__()

def GaudiKernel.PropertyProxy.PropertyProxy.__delete__	(		self,
			obj
	)

Definition at line 178 of file PropertyProxy.py.

    def __delete__(self, obj):
        if obj in self.history:
            del self.history[obj]
        self.descr.__delete__(obj)
 
 

__get__()

def GaudiKernel.PropertyProxy.PropertyProxy.__get__	(		self,
			obj,
			type = None
	)

Reimplemented in GaudiKernel.PropertyProxy.DataHandlePropertyProxy, and GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.

Definition at line 103 of file PropertyProxy.py.

    def __get__(self, obj, type=None):
        try:
            return self.descr.__get__(obj, type)
        except AttributeError:
            # special case for builtin collections
            # allow default to work with on +=, [], etc.
            if isinstance(self.__default, (list, dict, set)):
                self.descr.__set__(obj, self.__default.__class__(self.__default))
                return self.descr.__get__(obj, type)
            else:
                # for non lists (or dicts) return a reference to the default
                # return self.__default
                raise
 

__set__()

def GaudiKernel.PropertyProxy.PropertyProxy.__set__	(		self,
			obj,
			value
	)

Reimplemented in GaudiKernel.PropertyProxy.DataHandlePropertyProxy, and GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.

Definition at line 117 of file PropertyProxy.py.

    def __set__(self, obj, value):
        # check if deprecated
        if self.deprecated and not obj._unpickling:
            log.warning(
                "Property %s is deprecated: %s",
                self.fullPropertyName(obj),
                self.__doc__,
            )
 
        # check value/property compatibility if possible
        proptype, allowcompat = None, False
        if hasattr(self, "default"):
            proptype = type(self.default)
            if self.descr.__name__ == "OutputLevel":  # old-style compat for Btag
                allowcompat = True
        elif obj in self.history:
            proptype = type(self.history[obj][0])
            allowcompat = True
 
        # check if type known; allow special initializer for typed instances
        # Do not perform the check for PropertyReference, should be delayed until
        # binding (if ever done)
        if (
            proptype
            and not isinstance(None, proptype)
            and not derives_from(value, "PropertyReference")
        ):
            try:
                # check value itself
                value = _isCompatible(proptype, value)
 
                # check element in case of list
                if proptype == list:
                    try:
                        oldvec = self.descr.__get__(obj, type)
                        if oldvec:
                            tpo = type(oldvec[0])
                            for v in value:
                                _isCompatible(tpo, v)
                    except AttributeError:
                        # value not yet set
                        pass
            except ValueError as e:
                if allowcompat:
                    log.error(
                        "inconsistent value types for %s.%s (%s)"
                        % (obj.getName(), self.descr.__name__, str(e))
                    )
                else:
                    raise
 
        # allow a property to be set if we're in non-default mode, or if it
        # simply hasn't been set before
        if not obj._isInSetDefaults() or obj not in self.history:
            # by convention, 'None' for default is used to designate objects setting
            if hasattr(self, "default") and self.default is None:
                obj.__iadd__(value, self.descr)  # to establish hierarchy
            else:
                self.descr.__set__(obj, value)
            self.history.setdefault(obj, []).append(value)
 

fullPropertyName()

def GaudiKernel.PropertyProxy.PropertyProxy.fullPropertyName	(		self,
			obj
	)

Definition at line 100 of file PropertyProxy.py.

    def fullPropertyName(self, obj):
        return (obj.getJobOptName() or obj.getName()) + "." + self.descr.__name__
 

getDefault()

def GaudiKernel.PropertyProxy.PropertyProxy.getDefault

(

self

)

Definition at line 95 of file PropertyProxy.py.

    def getDefault(self):
        return self.__default
 

setDefault()

def GaudiKernel.PropertyProxy.PropertyProxy.setDefault	(		self,
			value
	)

Definition at line 92 of file PropertyProxy.py.

    def setDefault(self, value):
        self.__default = value
 

Member Data Documentation

__default

GaudiKernel.PropertyProxy.PropertyProxy.__default

private

Definition at line 93 of file PropertyProxy.py.

__doc__

GaudiKernel.PropertyProxy.PropertyProxy.__doc__

private

Definition at line 86 of file PropertyProxy.py.

deprecated

GaudiKernel.PropertyProxy.PropertyProxy.deprecated

Definition at line 84 of file PropertyProxy.py.

descr

GaudiKernel.PropertyProxy.PropertyProxy.descr

Definition at line 83 of file PropertyProxy.py.

history

GaudiKernel.PropertyProxy.PropertyProxy.history

Definition at line 82 of file PropertyProxy.py.

Property Documentation

default

GaudiKernel.PropertyProxy.PropertyProxy.default = property(getDefault, setDefault)

static

Definition at line 98 of file PropertyProxy.py.

---

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

• GaudiKernel/python/GaudiKernel/PropertyProxy.py