Inheritance diagram for GaudiKernel.Configurable.ConfigurableUser:

Collaboration diagram for GaudiKernel.Configurable.ConfigurableUser:

Public Member Functions
	__init__ (self, name=Configurable.DefaultName, _enabled=True, **kwargs)
	getGaudiType (cls)
	getDlls (self)
	getHandle (self)
	__detach_used__ (self)
	propagateProperty (self, name, others=None, force=True)
	propagateProperties (self, names=None, others=None, force=True)
	__apply_configuration__ (self)
	applyConf (self)
	getUsedInstance (self, name)
	isApplicable (self)
Public Member Functions inherited from GaudiKernel.Configurable.Configurable
	__new__ (cls, args, *kwargs)
	__init__ (self, name=DefaultName)
	__getstate__ (self)
	__getnewargs__ (self)
	__setstate__ (self, dict)
	__len__ (self)
	__iter__ (self)
	__deepcopy__ (self, memo)
	__iadd__ (self, configs, descr=None)
	__getattr__ (self, attr)
	__setattr__ (self, name, value)
	__delattr__ (self, attr)
	__bool__ (self)
	remove (self, items)
	removeAll (self)
	copyChild (self, child)
	setParent (self, parentName)
	getParent (self)
	hasParent (self, parent)
	copyChildAndSetParent (self, cfg, parent)
	getChildren (self)
	getTools (self)
	children (self)
	getAllChildren (self)
	getSequence (self)
	setup (self)
	getProperties (self)
	getPropertiesWithDescription (self)
	getValuedProperties (self)
	properties (self)
	getDefaultProperties (cls)
	getDefaultProperty (cls, name)
	getProp (self, name)
	setProp (self, name, value)
	isPropertySet (self, name)
	getType (cls)
	getName (self)
	name (self)
	getJobOptName (self)
	isPublic (self)
	jobOptName (self)
	getFullName (self)
	getFullJobOptName (self)
	getPrintTitle (self)
	getTitleName (self)
	setDefaults (cls, handle)
	clone (self, name=None, **kwargs)
	splitName (self)
	addTool (self, tool, name=None)
	__repr__ (self)
	__str__ (self, indent=0, headerLastIndentUnit=indentUnit)
Public Member Functions inherited from GaudiKernel.ConfigurableMeta.ConfigurableMeta
	__new__ (self, name, bases, dct)
	__call__ (cls, args, *kwargs)

Protected Member Functions
	_instanceName (self, cls)
Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
	_isInSetDefaults (self)

Protected Attributes
	_enabled = _enabled
bool	_applied = False
Protected Attributes inherited from GaudiKernel.Configurable.Configurable
	_name = self.__class__.DefaultedName
bool	_inSetDefaults = False
bool	_initok = True
bool	_setupok = False
bool	_unpickling = False
	_properties

Private Member Functions
	__addActiveUseOf (self, other)
	__addPassiveUseOf (self, other)

Private Attributes
list	__users__ = []
list	__used_instances__ = []

Static Private Attributes
dict	__slots__
list	__used_configurables__ = []
list	__queried_configurables__ = []

Additional Inherited Members
Public Attributes inherited from GaudiKernel.Configurable.Configurable
	configurables
Static Public Attributes inherited from GaudiKernel.Configurable.Configurable
	propertyNoValue
str	indentUnit = "\| "
int	printHeaderWidth = 100
int	printHeaderPre = 5
dict	allConfigurables = {}
dict	configurableServices = {}
Static Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
	_printHeader (indentStr, title)
	_printFooter (indentStr, title)
Static Protected Attributes inherited from GaudiKernel.Configurable.Configurable
bool	_configurationLocked = False

Detailed Description

Definition at line 1348 of file Configurable.py.

Constructor & Destructor Documentation

◆ init()

GaudiKernel.Configurable.ConfigurableUser.__init__	(		self,
			name = Configurable.DefaultName,
			_enabled = True,
		**	kwargs )

Definition at line 1368 of file Configurable.py.

    def __init__(self, name=Configurable.DefaultName, _enabled=True, **kwargs):
        super().__init__(name)
        for n, v in kwargs.items():
            setattr(self, n, v)
        self._enabled = _enabled
        self.__users__ = []
        self._applied = False
 
        # Needed to retrieve the actual class if the declaration in __used_configurables__
        # and  __queried_configurables__ is done with strings.
        from GaudiKernel.ConfigurableDb import getConfigurable as confDbGetConfigurable
 
        # Set the list of users of the used configurables
        #
        self.__used_instances__ = []
        for used in self.__used_configurables__:
            # By default we want to use the default name of the instances
            # for the used configurables
            used_name = Configurable.DefaultName
            # If the entry in the list is a tuple, we need a named instance
            if isinstance(used, tuple):
                used, used_name = used  # we re-set used to re-use the code below
                if not used_name:
                    used_name = self._instanceName(used)
            # Check is 'used' is a string or not
            if isinstance(used, str):
                used_class = confDbGetConfigurable(used)
            else:
                used_class = used
            # Instantiate the configurable that we are going to use
            try:
                inst = used_class(name=used_name, _enabled=False)
            except AttributeError:
                # This cover the case where the used configurable is not a
                # ConfigurableUser instance, i.e. id doesn't have the attribute
                # '_enabled'.
                inst = used_class(name=used_name)
            self.__addActiveUseOf(inst)
        for queried in self.__queried_configurables__:
            try:
                if isinstance(queried, str):
                    queried = confDbGetConfigurable(queried)
                inst = queried(_enabled=False)
            except AttributeError:
                inst = queried()
            self.__addPassiveUseOf(inst)
 

Member Function Documentation

◆ __addActiveUseOf()

GaudiKernel.Configurable.ConfigurableUser.__addActiveUseOf	(		self,
			other )

private

Declare that we are going to modify the Configurable 'other' in our
__apply_configuration__.

Definition at line 1415 of file Configurable.py.

    def __addActiveUseOf(self, other):
        """
        Declare that we are going to modify the Configurable 'other' in our
        __apply_configuration__.
        """
        self.__used_instances__.append(other)
        if hasattr(other, "__users__"):  # allow usage of plain Configurables
            other.__users__.append(self)
 

◆ __addPassiveUseOf()

GaudiKernel.Configurable.ConfigurableUser.__addPassiveUseOf	(		self,
			other )

private

Declare that we are going to retrieve property values from the
ConfigurableUser 'other' in our __apply_configuration__.

Definition at line 1424 of file Configurable.py.

    def __addPassiveUseOf(self, other):
        """
        Declare that we are going to retrieve property values from the
        ConfigurableUser 'other' in our __apply_configuration__.
        """
        if not isinstance(other, ConfigurableUser):
            raise Error(
                f"'{self.name()}': Cannot make passive use of '{other.name()}', it is not a ConfigurableUser"
            )
        other.__addActiveUseOf(self)
 

◆ __apply_configuration__()

GaudiKernel.Configurable.ConfigurableUser.__apply_configuration__ ( self )

Function to be overridden to convert the high level configuration into a
low level one.
The default implementation calls applyConf, which is the method defined
in some ConfigurableUser implementations.

Definition at line 1515 of file Configurable.py.

    def __apply_configuration__(self):
        """
        Function to be overridden to convert the high level configuration into a
        low level one.
        The default implementation calls applyConf, which is the method defined
        in some ConfigurableUser implementations.
        """
        return self.applyConf()
 

◆ __detach_used__()

GaudiKernel.Configurable.ConfigurableUser.__detach_used__ ( self )

Remove this ConfigurableUser instance from the users list of the used
instances.

Definition at line 1445 of file Configurable.py.

    def __detach_used__(self):
        """
        Remove this ConfigurableUser instance from the users list of the used
        instances.
        """
        for used in self.__used_instances__:
            if hasattr(used, "__users__"):  # allow usage of plain Configurables
                used.__users__.remove(self)
 

◆ _instanceName()

GaudiKernel.Configurable.ConfigurableUser._instanceName	(		self,
			cls )

protected

Function used to define the name of the private instance of a given class
name.
This method is used when the __used_configurables_property__ declares the
need of a private used configurable without specifying the name.

Definition at line 1531 of file Configurable.py.

    def _instanceName(self, cls):
        """
        Function used to define the name of the private instance of a given class
        name.
        This method is used when the __used_configurables_property__ declares the
        need of a private used configurable without specifying the name.
        """
        if isinstance(cls, str):
            clName = cls
        else:
            clName = cls.__name__
        return f"{self.name()}_{clName}"
 

◆ applyConf()

GaudiKernel.Configurable.ConfigurableUser.applyConf ( self )

Function to be overridden to convert the high level configuration into a
low level one.

Definition at line 1524 of file Configurable.py.

    def applyConf(self):
        """
        Function to be overridden to convert the high level configuration into a
        low level one.
        """
        pass
 

◆ getDlls()

GaudiKernel.Configurable.ConfigurableUser.getDlls ( self )

Definition at line 1439 of file Configurable.py.

    def getDlls(self):
        return None
 

◆ getGaudiType()

GaudiKernel.Configurable.ConfigurableUser.getGaudiType ( cls )

Definition at line 1436 of file Configurable.py.

    def getGaudiType(cls):
        return "User"
 

◆ getHandle()

GaudiKernel.Configurable.ConfigurableUser.getHandle ( self )

Definition at line 1442 of file Configurable.py.

    def getHandle(self):
        return None
 

◆ getUsedInstance()

GaudiKernel.Configurable.ConfigurableUser.getUsedInstance	(		self,
			name )

Return the used instance with a given name.

Definition at line 1544 of file Configurable.py.

    def getUsedInstance(self, name):
        """
        Return the used instance with a given name.
        """
        for i in self.__used_instances__:
            if i.name() == name:
                if hasattr(i, "_enabled"):
                    # ensure that the instances retrieved through the method are
                    # enabled
                    i._enabled = True
                return i
        raise KeyError(name)
 

◆ isApplicable()

GaudiKernel.Configurable.ConfigurableUser.isApplicable ( self )

Return True is the instance can be "applied".

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1557 of file Configurable.py.

    def isApplicable(self):
        """
        Return True is the instance can be "applied".
        """
        return (not self.__users__) and (not self._applied)
 
 
# list of callables to be called after all the __apply_configuration__ are called.

◆ propagateProperties()

GaudiKernel.Configurable.ConfigurableUser.propagateProperties	(	self,
		names = None,
		others = None,
		force = True )

Call propagateProperty for each property listed in 'names'.
If 'names' is None, all the properties are propagated.

Definition at line 1504 of file Configurable.py.

    def propagateProperties(self, names=None, others=None, force=True):
        """
        Call propagateProperty for each property listed in 'names'.
        If 'names' is None, all the properties are propagated.
        """
        if names is None:
            # use all the non-private slots
            names = [p for p in self.__slots__ if not p.startswith("_")]
        for n in names:
            self.propagateProperty(n, others, force)
 

◆ propagateProperty()

GaudiKernel.Configurable.ConfigurableUser.propagateProperty	(	self,
		name,
		others = None,
		force = True )

Propagate the property 'name' (if set) to other configurables (if possible).
'others' can be:
    None:
        propagate to all the entries in __used_configurables__
    a configurable instance:
        propagate only to it
    list of configurable instances:
        propagate to all of them.


The logic is:
- if the local property is set, the other property will be overwritten
- local property not set and other set => keep other
- local property not set and other not set => overwrite the default for
    ConfigurableUser instances and set the property for Configurables

Definition at line 1454 of file Configurable.py.

    def propagateProperty(self, name, others=None, force=True):
        """
        Propagate the property 'name' (if set) to other configurables (if possible).
        'others' can be:
            None:
                propagate to all the entries in __used_configurables__
            a configurable instance:
                propagate only to it
            list of configurable instances:
                propagate to all of them.
 
 
        The logic is:
        - if the local property is set, the other property will be overwritten
        - local property not set and other set => keep other
        - local property not set and other not set => overwrite the default for
            ConfigurableUser instances and set the property for Configurables
        """
        # transform 'others' to a list of configurable instances
        if others is None:
            others = self.__used_instances__
        elif type(others) not in [list, tuple]:
            others = [others]
        # these can be computed before the loop
        local_is_set = self.isPropertySet(name)
        value = self.getProp(name)
        # loop over the others that do have 'name' in their slots
        for other in [o for o in others if name in o.__slots__]:
            # If self property is set, use it
            if local_is_set:
                if other.isPropertySet(name):
                    log.warning(
                        "Property '{prop}' is set in both '{self}' and '{other}', using '{self}.{prop}'".format(
                            self=self.name(), other=other.name(), prop=name
                        )
                    )
                other.setProp(name, value)
            # If not, and other property also not set, propagate the default
            elif not other.isPropertySet(name):
                if isinstance(other, ConfigurableUser):
                    otherType = type(other._properties[name].getDefault())
                    other._properties[name].setDefault(value)
                    if otherType in (list, dict, set):
                        # Special case for list and dictionaries:
                        # also set the property to the same value of the default (copy)
                        other.setProp(name, otherType(value))
                else:
                    other.setProp(name, value)
            # If not set and other set, do nothing
 

Member Data Documentation

◆ __queried_configurables__

list GaudiKernel.Configurable.ConfigurableUser.__queried_configurables__ = []

staticprivate

Definition at line 1366 of file Configurable.py.

◆ slots

dict GaudiKernel.Configurable.ConfigurableUser.__slots__

staticprivate

Initial value:

=  {
        "__users__": [],
        "__used_instances__": [],
        "_enabled": True,
        "_applied": False,
    }

Definition at line 1349 of file Configurable.py.

◆ __used_configurables__

list GaudiKernel.Configurable.ConfigurableUser.__used_configurables__ = []

staticprivate

Definition at line 1363 of file Configurable.py.

◆ __used_instances__

list GaudiKernel.Configurable.ConfigurableUser.__used_instances__ = []

private

Definition at line 1382 of file Configurable.py.

◆ users

GaudiKernel.Configurable.ConfigurableUser.__users__ = []

private

Definition at line 1373 of file Configurable.py.

◆ _applied

GaudiKernel.Configurable.ConfigurableUser._applied = False

protected

Definition at line 1374 of file Configurable.py.

◆ _enabled

GaudiKernel.Configurable.ConfigurableUser._enabled = _enabled

protected

Definition at line 1372 of file Configurable.py.

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

GaudiKernel/python/GaudiKernel/Configurable.py

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __addActiveUseOf()

◆ __addPassiveUseOf()

◆ __apply_configuration__()

◆ __detach_used__()

◆ _instanceName()

◆ applyConf()

◆ getDlls()

◆ getGaudiType()

◆ getHandle()

◆ getUsedInstance()

◆ isApplicable()

◆ propagateProperties()

◆ propagateProperty()

Member Data Documentation

◆ __queried_configurables__

◆ __slots__

◆ __used_configurables__

◆ __used_instances__

◆ __users__

◆ _applied

◆ _enabled

◆ init()

◆ slots

◆ users