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 (self)
def	getName (self)
def	merge (self, other)

Public Attributes
	name

Static Public Attributes
dictionary	instances = {}

Private Attributes
	_name
	_properties
	__cpp_type__

Detailed Description

Base class for all configurable instances.

Definition at line 138 of file _configurables.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 144 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,
                          basestring if sys.version_info[0] == 2 else 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 210 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 226 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 221 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 200 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 218 of file _configurables.py.

    def __setstate__(self, state):
        self.__init__(state.get('name'), **state['properties'])

getGaudiType()

def GaudiConfig2._configurables.Configurable.getGaudiType

(

self

)

Definition at line 238 of file _configurables.py.

    def getGaudiType(self):
        return self.__component_type__

getInstance()

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

Definition at line 163 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 241 of file _configurables.py.

    def getName(self):
        return self.name

is_property_set()

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

Definition at line 235 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 244 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 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._descriptors:
            if not other.is_property_set(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 167 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,
			value
	)

Definition at line 174 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, basestring
                          if sys.version_info[0] == 2 else 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

name() [3/3]

def GaudiConfig2._configurables.Configurable.name

(

self

)

Definition at line 192 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')

Member Data Documentation

__cpp_type__

GaudiConfig2._configurables.Configurable.__cpp_type__

private

Definition at line 222 of file _configurables.py.

_name

GaudiConfig2._configurables.Configurable._name

private

Definition at line 145 of file _configurables.py.

_properties

GaudiConfig2._configurables.Configurable._properties

private

Definition at line 146 of file _configurables.py.

instances

dictionary GaudiConfig2._configurables.Configurable.instances = {}

static

Definition at line 142 of file _configurables.py.

name

GaudiConfig2._configurables.Configurable.name

Definition at line 156 of file _configurables.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/_configurables.py