GaudiKernel.PropertyProxy Namespace Reference

Classes
class	DataHandlePropertyProxy
class	GaudiHandleArrayPropertyProxy
class	GaudiHandlePropertyProxy
class	GaudiHandlePropertyProxyBase
class	PropertyProxy

Functions
	derives_from (derived, base)
	_isCompatible (tp, value, name)
	_registerConfigurables (allConfigurables, c)
	PropertyProxyFactory (descr, doc, default)

Variables
list	__all__ = ["PropertyProxy", "GaudiHandlePropertyProxy", "GaudiHandleArrayPropertyProxy"]
	(c) Copyright 1998-2025 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".
	log = logging.getLogger("PropertyProxy")

Function Documentation

_isCompatible()

GaudiKernel.PropertyProxy._isCompatible ( tp, value, name )

protected

Definition at line 43 of file PropertyProxy.py.

def _isCompatible(tp, value, name):
    errmsg = (
        f"received an instance of {type(value)}, but {tp} expected for property {name}"
    )
 
    if derives_from(value, "PropertyReference"):
        # TODO: implement type checking for references
        return value  # references are valid
    if tp is str:
        if isinstance(value, str) or derives_from(value, "Configurable"):
            # we can set string properties only from strings or configurables
            return value
        elif isinstance(value, DataHandle):
            # Implicitly convert DataHandle to str for backward
            # compatiblity in cases like B.Input (str) = A.Output (handle)
            return str(value)
        else:
            raise ValueError(errmsg)
    elif tp in (list, tuple, dict, set):
        if type(value) is tp:
            # Check that the types match for collections (GAUDI-207)
            return value
        elif tp is set and isinstance(value, list):
            # Fall-through to implicit conversion for backwards compatibility
            pass
        else:
            raise ValueError(errmsg)
    elif derives_from(tp, "Configurable"):
        return value
 
    # all other types: accept if conversion allowed
    try:
        dummy = tp(value)
    except (TypeError, ValueError):
        raise ValueError(errmsg)
 
    return dummy  # in case of e.g. classes with __int__, __iter__, etc. implemented
 
 

_registerConfigurables()

GaudiKernel.PropertyProxy._registerConfigurables ( allConfigurables, c )

protected

Definition at line 82 of file PropertyProxy.py.

def _registerConfigurables(allConfigurables, c):
    allConfigurables[c.name()] = c
    for cc in c.getAllChildren():
        _registerConfigurables(allConfigurables, cc)
    return
 
 

derives_from()

GaudiKernel.PropertyProxy.derives_from	(		derived,
			base )

A string version of isinstance().
<derived> is either an object instance, or a type
<base>    is a string containing the name of the base class (or <derived> class)

Definition at line 28 of file PropertyProxy.py.

def derives_from(derived, base):
    """A string version of isinstance().
    <derived> is either an object instance, or a type
    <base>    is a string containing the name of the base class (or <derived> class)"""
    if not isinstance(derived, type):
        derived = type(derived)
    if derived.__name__ == base:
        return True
    for b in derived.__bases__:
        if derives_from(b, base):
            return True
 
    return False
 
 

PropertyProxyFactory()

GaudiKernel.PropertyProxy.PropertyProxyFactory	(		descr,
			doc,
			default )

Definition at line 479 of file PropertyProxy.py.

def PropertyProxyFactory(descr, doc, default):
    #   print "PropertyProxyFactory( %s, %r )" % (descr.__name__,default)
 
    if isinstance(default, GaudiHandleArray):
        return GaudiHandleArrayPropertyProxy(descr, doc, default)
 
    if isinstance(default, GaudiHandle):
        return GaudiHandlePropertyProxy(descr, doc, default)
 
    if isinstance(default, DataHandle):
        return DataHandlePropertyProxy(descr, doc, default)
 
    return PropertyProxy(descr, doc, default)

Variable Documentation

__all__

list GaudiKernel.PropertyProxy.__all__ = ["PropertyProxy", "GaudiHandlePropertyProxy", "GaudiHandleArrayPropertyProxy"]

private

(c) Copyright 1998-2025 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: AthenaCommon/python/PropertyProxy.py Author: Wim Lavrijsen (WLavr.nosp@m.ijse.nosp@m.n@lbl.nosp@m..gov) Author: Martin Woudstra (Marti.nosp@m.n.Wo.nosp@m.udstr.nosp@m.a@ce.nosp@m.rn.ch)

Definition at line 16 of file PropertyProxy.py.

log

GaudiKernel.PropertyProxy.log = logging.getLogger("PropertyProxy")

Definition at line 25 of file PropertyProxy.py.