GaudiConfig2._configurables.Configurable Class Reference

Inheritance diagram for GaudiConfig2._configurables.Configurable:

Collaboration diagram for GaudiConfig2._configurables.Configurable:

Public Member Functions
	__init__ (self, name=None, **kwargs)
	getInstance (cls, name)
	name (self)
	name (self, value)
	name (self)
	__repr__ (self)
	__getstate__ (self)
	__setstate__ (self, state)
	__opt_value__ (self)
	__opt_properties__ (self, explicit_defaults=False)
	is_property_set (self, propname)
	getGaudiType (cls)
	getType (cls)
	getName (self)
	getFullJobOptName (self)
	toStringProperty (self)
	getDefaultProperties (cls)
	getDefaultProperty (cls, name)
	clone (self, newname=None)
	merge (self, other)
Public Member Functions inherited from GaudiConfig2._configurables.ConfigurableMeta
	__new__ (cls, name, bases, namespace, **kwds)

Public Attributes
	name = name

Static Public Attributes
dict	instances = {}

Protected Attributes
	_name = None
dict	_properties = {}

Private Attributes
	__cpp_type__ = self.name:

Detailed Description

Base class for all configurable instances.

Definition at line 131 of file _configurables.py.

Constructor & Destructor Documentation

__init__()

GaudiConfig2._configurables.Configurable.__init__	(		self,
			name = None,
		**	kwargs )

Definition at line 138 of file _configurables.py.

    def __init__(self, name=None, **kwargs):
        self._name = None
        self._properties = {}
        if "parent" in kwargs:
            parent = kwargs.pop("parent")
            if isinstance(parent, str):
                parent = self.instances[parent]
            if not name:
                raise TypeError("name is needed when a parent is specified")
            name = f"{parent.name}.{name}"
        if name:
            self.name = name
        elif not _GLOBAL_INSTANCES:
            self.name = self.__cpp_type__
        for key, value in kwargs.items():
            setattr(self, key, value)
 

Member Function Documentation

__getstate__()

GaudiConfig2._configurables.Configurable.__getstate__

(

self

)

Definition at line 201 of file _configurables.py.

    def __getstate__(self):
        state = {"properties": self._properties}
        try:
            state["name"] = self.name
        except AttributeError:
            pass  # no name
        return state
 

__opt_properties__()

GaudiConfig2._configurables.Configurable.__opt_properties__	(		self,
			explicit_defaults = False )

Definition at line 219 of file _configurables.py.

    def __opt_properties__(self, explicit_defaults=False):
        name = self.name
        out = {}
        for p in self._descriptors.values():
            if explicit_defaults or p.__is_set__(self, type(self)):
                out[".".join([name, p.name])] = opt_repr(
                    p.__opt_value__(self, type(self))
                )
        return out
 

__opt_value__()

GaudiConfig2._configurables.Configurable.__opt_value__

(

self

)

Definition at line 214 of file _configurables.py.

    def __opt_value__(self):
        if self.__cpp_type__ == self.name:
            return self.__cpp_type__
        return f"{self.__cpp_type__}/{self.name}"
 

__repr__()

GaudiConfig2._configurables.Configurable.__repr__

(

self

)

Definition at line 192 of file _configurables.py.

    def __repr__(self):
        args = []
        try:
            args.append(repr(self.name))
        except AttributeError:
            pass  # no name
        args.extend(f"{k}={repr(v)}" for k, v in self._properties.items())
        return "{}({})".format(type(self).__name__, ", ".join(args))
 

__setstate__()

GaudiConfig2._configurables.Configurable.__setstate__	(		self,
			state )

Definition at line 209 of file _configurables.py.

    def __setstate__(self, state):
        self._name = None
        self.name = state.get("name")
        self._properties = state["properties"]
 

clone()

GaudiConfig2._configurables.Configurable.clone	(		self,
			newname = None )

Clone instance with all its properties.

Definition at line 257 of file _configurables.py.

    def clone(self, newname=None):
        """Clone instance with all its properties."""
        return self.__class__(newname, **self._properties)
 

getDefaultProperties()

GaudiConfig2._configurables.Configurable.getDefaultProperties

(

cls

)

Definition at line 250 of file _configurables.py.

    def getDefaultProperties(cls):
        return {k: v.default for k, v in cls._descriptors.items()}
 

getDefaultProperty()

GaudiConfig2._configurables.Configurable.getDefaultProperty	(		cls,
			name )

Definition at line 254 of file _configurables.py.

    def getDefaultProperty(cls, name):
        return cls._descriptors[name].default
 

getFullJobOptName()

GaudiConfig2._configurables.Configurable.getFullJobOptName

(

self

)

Definition at line 243 of file _configurables.py.

    def getFullJobOptName(self):
        return f"{self.__cpp_type__}/{self.name}"
 

getGaudiType()

GaudiConfig2._configurables.Configurable.getGaudiType

(

cls

)

Definition at line 233 of file _configurables.py.

    def getGaudiType(cls):
        return cls.__component_type__
 

getInstance()

GaudiConfig2._configurables.Configurable.getInstance	(		cls,
			name )

Definition at line 156 of file _configurables.py.

    def getInstance(cls, name):
        return cls.instances.get(name) or cls(name)
 

getName()

GaudiConfig2._configurables.Configurable.getName

(

self

)

Definition at line 240 of file _configurables.py.

    def getName(self):
        return self.name
 

getType()

GaudiConfig2._configurables.Configurable.getType

(

cls

)

Definition at line 237 of file _configurables.py.

    def getType(cls):
        return cls.__cpp_type__
 

is_property_set()

GaudiConfig2._configurables.Configurable.is_property_set	(		self,
			propname )

Definition at line 229 of file _configurables.py.

    def is_property_set(self, propname):
        return self._descriptors[propname].__is_set__(self, type(self))
 

merge()

GaudiConfig2._configurables.Configurable.merge	(		self,
			other )

Merge the properties of the other instance into the current one.

The two instances have to be of the same type, have the same name
(or both unnamed) and the settings must be mergable (according to
their semantics).

Definition at line 261 of file _configurables.py.

    def merge(self, other):
        """
        Merge the properties of the other instance into the current one.
 
        The two instances have to be of the same type, have the same name
        (or both unnamed) and the settings must be mergable (according to
        their semantics).
        """
        if self is other:
            return self
        if type(self) is not type(other):
            raise TypeError(
                f"cannot merge instance of {type(other).__name__} into an instance of { type(self).__name__}"
            )
        if hasattr(self, "name") != hasattr(other, "name"):
            raise ValueError("cannot merge a named configurable with an unnamed one")
        if hasattr(self, "name") and (self.name != other.name):
            raise ValueError(
                f"cannot merge configurables with different names ({self.name} and {other.name})"
            )
 
        for name in other._properties:
            if (
                name in self._properties
                and self._properties[name] == other._properties[name]
            ):
                continue
            try:
                self._properties[name] = self._descriptors[name].__merge__(
                    self, type(self), getattr(other, name)
                )
            except ValueError as err:
                raise ValueError(
                    "conflicting settings for property {} of {}: {}".format(
                        name,
                        self.name if hasattr(self, "name") else type(self).__name__,
                        str(err),
                    )
                )
 
        return self
 
 

name() [1/3]

GaudiConfig2._configurables.Configurable.name

(

self

)

Definition at line 160 of file _configurables.py.

    def name(self):
        if not self._name:
            raise AttributeError(
                f"{repr(type(self).__name__)} instance was not named yet"
            )
        return self._name
 

name() [2/3]

GaudiConfig2._configurables.Configurable.name

(

self

)

Definition at line 184 of file _configurables.py.

    def name(self):
        if _GLOBAL_INSTANCES:
            # check if it was set
            del self.instances[self.name]
            self._name = None
        else:
            raise TypeError("name attribute cannot be deleted")
 

name() [3/3]

GaudiConfig2._configurables.Configurable.name	(		self,
			value )

Definition at line 168 of file _configurables.py.

    def name(self, value):
        if value == self._name:
            return  # it's already the name of the instance, nothing to do
        if not isinstance(value, str) or not value:
            raise TypeError(f"expected string, got {type(value).__name__} instead")
        if _GLOBAL_INSTANCES:
            if value in self.instances:
                raise ValueError(f"name {repr(value)} already used")
            if self._name in self.instances:
                del self.instances[self._name]
            self._name = value
            self.instances[value] = self
        else:
            self._name = value
 

toStringProperty()

GaudiConfig2._configurables.Configurable.toStringProperty

(

self

)

Definition at line 246 of file _configurables.py.

    def toStringProperty(self):
        return f"{self.__cpp_type__}/{self.name}"
 

Member Data Documentation

__cpp_type__

GaudiConfig2._configurables.Configurable.__cpp_type__ = self.name:

private

Definition at line 215 of file _configurables.py.

_name

GaudiConfig2._configurables.Configurable._name = None

protected

Definition at line 139 of file _configurables.py.

_properties

GaudiConfig2._configurables.Configurable._properties = {}

protected

Definition at line 140 of file _configurables.py.

instances

dict GaudiConfig2._configurables.Configurable.instances = {}

static

Definition at line 136 of file _configurables.py.

name

GaudiConfig2._configurables.Configurable.name = name

Definition at line 149 of file _configurables.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/_configurables.py