GaudiConfig2._configurables.Configurable Class Reference

Inheritance diagram for GaudiConfig2._configurables.Configurable:

Collaboration diagram for GaudiConfig2._configurables.Configurable:

Public Member Functions
def	__init__ (self, name=None, **kwargs)
def	getInstance (cls, name)
def	name (self)
def	name (self, value)
def	name (self)
def	__repr__ (self)
def	__getstate__ (self)
def	__setstate__ (self, state)
def	__opt_value__ (self)
def	__opt_properties__ (self, explicit_defaults=False)
def	is_property_set (self, propname)
def	getGaudiType (cls)
def	getType (cls)
def	getName (self)
def	getFullJobOptName (self)
def	toStringProperty (self)
def	getDefaultProperties (cls)
def	getDefaultProperty (cls, name)
def	clone (self, newname=None)
def	merge (self, other)

Public Attributes
	name

Static Public Attributes
	instances

Private Attributes
	_name
	_properties
	__cpp_type__

Detailed Description

Base class for all configurable instances.

Definition at line 145 of file _configurables.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 152 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 = "{}.{}".format(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__()

def GaudiConfig2._configurables.Configurable.__getstate__

(

self

)

Definition at line 217 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__()

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

Definition at line 235 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__()

def GaudiConfig2._configurables.Configurable.__opt_value__

(

self

)

Definition at line 230 of file _configurables.py.

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

__repr__()

def GaudiConfig2._configurables.Configurable.__repr__

(

self

)

Definition at line 208 of file _configurables.py.

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

__setstate__()

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

Definition at line 225 of file _configurables.py.

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

clone()

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

Clone instance with all its properties.

Definition at line 273 of file _configurables.py.

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

getDefaultProperties()

def GaudiConfig2._configurables.Configurable.getDefaultProperties

(

cls

)

Definition at line 266 of file _configurables.py.

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

getDefaultProperty()

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

Definition at line 270 of file _configurables.py.

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

getFullJobOptName()

def GaudiConfig2._configurables.Configurable.getFullJobOptName

(

self

)

Definition at line 259 of file _configurables.py.

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

getGaudiType()

def GaudiConfig2._configurables.Configurable.getGaudiType

(

cls

)

Definition at line 249 of file _configurables.py.

    def getGaudiType(cls):
        return cls.__component_type__
 

getInstance()

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

Definition at line 170 of file _configurables.py.

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

getName()

def GaudiConfig2._configurables.Configurable.getName

(

self

)

Definition at line 256 of file _configurables.py.

    def getName(self):
        return self.name
 

getType()

def GaudiConfig2._configurables.Configurable.getType

(

cls

)

Definition at line 253 of file _configurables.py.

    def getType(cls):
        return cls.__cpp_type__
 

is_property_set()

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

Definition at line 245 of file _configurables.py.

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

merge()

def 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 277 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(
                "cannot merge instance of {} into an instance of {}".format(
                    type(other).__name__, 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(
                "cannot merge configurables with different names ({} and {})".format(
                    self.name, other.name
                )
            )
 
        for name in other._properties:
            if (
                name in self._properties
                and self._properties[name] == other._properties[name]
            ):
                continue
            try:
                setattr(
                    self,
                    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]

def GaudiConfig2._configurables.Configurable.name

(

self

)

Definition at line 174 of file _configurables.py.

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

name() [2/3]

def GaudiConfig2._configurables.Configurable.name

(

self

)

Definition at line 200 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]

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

Definition at line 182 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(
                "expected string, got {} instead".format(type(value).__name__)
            )
        if _GLOBAL_INSTANCES:
            if value in self.instances:
                raise ValueError("name {!r} already used".format(value))
            if self._name in self.instances:
                del self.instances[self._name]
            self._name = value
            self.instances[value] = self
        else:
            self._name = value
 

toStringProperty()

def GaudiConfig2._configurables.Configurable.toStringProperty

(

self

)

Definition at line 262 of file _configurables.py.

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

Member Data Documentation

__cpp_type__

GaudiConfig2._configurables.Configurable.__cpp_type__

private

Definition at line 231 of file _configurables.py.

_name

GaudiConfig2._configurables.Configurable._name

private

Definition at line 153 of file _configurables.py.

_properties

GaudiConfig2._configurables.Configurable._properties

private

Definition at line 154 of file _configurables.py.

instances

GaudiConfig2._configurables.Configurable.instances

static

Definition at line 150 of file _configurables.py.

name

GaudiConfig2._configurables.Configurable.name

Definition at line 163 of file _configurables.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/_configurables.py