GaudiKernel.GaudiHandles.GaudiHandleArray Class Reference

Inheritance diagram for GaudiKernel.GaudiHandles.GaudiHandleArray:

Collaboration diagram for GaudiKernel.GaudiHandles.GaudiHandleArray:

Public Member Functions
	__init__ (self, typesAndNames=None)
	__len__ (self)
	__eq__ (self, other)
	__repr__ (self)
	__str__ (self)
	__opt_value__ (self)
	__copy__ (self)
	__setitem__ (self, index, value)
	__getitem__ (self, index)
	__iter__ (self)
	__delitem__ (self, index)
	__contains__ (self, value)
	__add__ (self, other)
	index (self, value, *args)
	insert (self, index, value)
	isPublic (self)
	toStringProperty (self)

Static Public Attributes
	handleType = None

Protected Member Functions
	_indexToKey (self, index)

Protected Attributes
dict	_items = {}

Static Private Attributes
tuple	__slots__ = ("_items",)

Detailed Description

A unique list of GaudiHandles. Only handles of one type are allowed,
as specified by self.__class__.handleType

Definition at line 129 of file GaudiHandles.py.

Constructor & Destructor Documentation

__init__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__init__	(		self,
			typesAndNames = None )

Definition at line 136 of file GaudiHandles.py.

    def __init__(self, typesAndNames=None):
        # Use of dictionary as storage for faster duplicate finding
        self._items = {}  # name : handle
 
        # check the type
        if typesAndNames is None:
            typesAndNames = []
        elif not isinstance(typesAndNames, list):
            raise TypeError(
                f"Argument to {self.__class__.__name__} must be a list. Got a {type(typesAndNames).__name__} instead"
            )
        # add entries to list
        self.extend(typesAndNames)
 

Member Function Documentation

__add__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__add__	(		self,
			other )

Definition at line 227 of file GaudiHandles.py.

    def __add__(self, other):
        return self.__class__(list(self) + list(other))
 

__contains__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__contains__	(		self,
			value )

Definition at line 221 of file GaudiHandles.py.

    def __contains__(self, value):
        if isinstance(value, str):
            return value in self._items
        else:
            return value.getName() in self._items
 

__copy__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__copy__

(

self

)

Definition at line 180 of file GaudiHandles.py.

    def __copy__(self):
        inst = self.__class__.__new__(self.__class__)
        inst._items = self._items.copy()
        return inst
 

__delitem__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__delitem__	(		self,
			index )

Definition at line 214 of file GaudiHandles.py.

    def __delitem__(self, index):
        if isinstance(index, slice):
            for k in self._indexToKey(index):
                self._items.pop(k)
        else:
            self._items.pop(self._indexToKey(index))
 

__eq__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__eq__	(		self,
			other )

Definition at line 153 of file GaudiHandles.py.

    def __eq__(self, other):
        try:
            return self._items == other._items
        except AttributeError:
            # other is e.g. plain list
            return list(self._items.values()) == other
 

__getitem__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__getitem__	(		self,
			index )

Definition at line 196 of file GaudiHandles.py.

    def __getitem__(self, index):
        if isinstance(index, str):
            # search by instance name
            try:
                return self._items[index]
            except KeyError:
                raise IndexError(
                    f"{self.__class__.__name__} does not have a {self.handleType.componentType} with instance name {index}"
                )
        else:
            if isinstance(index, slice):
                return [self._items[k] for k in self._indexToKey(index)]
            else:
                return self._items[self._indexToKey(index)]
 

__iter__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__iter__

(

self

)

Definition at line 211 of file GaudiHandles.py.

    def __iter__(self):
        yield from self._items.values()
 

__len__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__len__

(

self

)

Definition at line 150 of file GaudiHandles.py.

    def __len__(self):
        return len(self._items)
 

__opt_value__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__opt_value__

(

self

)

Definition at line 173 of file GaudiHandles.py.

    def __opt_value__(self):
        return self.toStringProperty()
 

__repr__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__repr__

(

self

)

Return class name with list of type/name strings as argument

Definition at line 160 of file GaudiHandles.py.

    def __repr__(self):
        """Return class name with list of type/name strings as argument"""
        return (
            self.__class__.__name__
            + "(["
            + ",".join(repr(h.toStringProperty()) for h in self._items.values())
            + "])"
        )
 

__setitem__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__setitem__	(		self,
			index,
			value )

Definition at line 185 of file GaudiHandles.py.

    def __setitem__(self, index, value):
        try:
            self._items[self._indexToKey(index)] = value
        except TypeError as e:
            if isinstance(index, slice):
                raise TypeError(
                    f"Setting elements of {self.__class__.__name__} via slice is not supported"
                )
            else:
                raise e
 

__str__()

GaudiKernel.GaudiHandles.GaudiHandleArray.__str__

(

self

)

Print in a form which can be parsed

Definition at line 169 of file GaudiHandles.py.

    def __str__(self):
        """Print in a form which can be parsed"""
        return self.toStringProperty()
 

_indexToKey()

GaudiKernel.GaudiHandles.GaudiHandleArray._indexToKey ( self, index )

protected

Convert list index to dictionary key

Definition at line 176 of file GaudiHandles.py.

    def _indexToKey(self, index):
        """Convert list index to dictionary key"""
        return list(self._items.keys())[index]
 

index()

GaudiKernel.GaudiHandles.GaudiHandleArray.index	(		self,
			value,
		*	args )

Definition at line 230 of file GaudiHandles.py.

    def index(self, value, *args):
        return list(self._items.keys()).index(
            value if isinstance(value, str) else value.getName(), *args
        )
 

insert()

GaudiKernel.GaudiHandles.GaudiHandleArray.insert	(		self,
			index,
			value )

Only allow inserting compatible types. It accepts a string, a handle or a configurable.

Definition at line 235 of file GaudiHandles.py.

    def insert(self, index, value):
        """Only allow inserting compatible types. It accepts a string, a handle or a configurable."""
        if isinstance(value, str):
            # convert string to handle
            value = self.__class__.handleType(value)
        elif isinstance(value, self.__class__.handleType):
            pass  # leave handle as-is
        elif isinstance(value, GaudiHandle):
            # do not allow different type of handles
            raise TypeError(
                f"Can not add a {value.__class__.__name__} to a {self.__class__.__name__}"
            )
        elif value.getGaudiType() != self.__class__.handleType.componentType:
            # assume it is a configurable: allow only correct types
            raise TypeError(
                f"Can not append {value.__class__.__name__} ({value.getGaudiType()}) to a {self.__class__.__name__}"
            )
        elif hasattr(value, "isPublic"):
            # check public vs private if applicable for this configurable
            pop = value.isPublic() and "Public" or "Private"
            if value.isPublic() != self.__class__.handleType.isPublic:
                raise TypeError(
                    f"Can not append {value.__class__.__name__} ({pop} {value.getGaudiType()}) to a {self.__class__.__name__}"
                )
 
        # check that an instance name appears only once in the list
        if value.getName() not in self._items:
            if index == len(self._items):  # append
                self._items[value.getName()] = value
            else:
                # for `insert` we need to rebuild the dictionary in the correct order
                values = list(self._items.items())
                values.insert(index, (value.getName(), value))
                self._items = dict(values)
        else:
            oldValue = self._items[value.getName()]
            _log.warning(
                "%r with instance name %r already in %s. Not adding %r.",
                oldValue,
                oldValue.getName(),
                self.__class__.__name__,
                value,
            )
 

isPublic()

GaudiKernel.GaudiHandles.GaudiHandleArray.isPublic

(

self

)

Definition at line 279 of file GaudiHandles.py.

    def isPublic(self):
        return self.__class__.handleType.isPublic
 

toStringProperty()

GaudiKernel.GaudiHandles.GaudiHandleArray.toStringProperty

(

self

)

Definition at line 285 of file GaudiHandles.py.

    def toStringProperty(self):
        return (
            "["
            + ",".join(repr(v.toStringProperty()) for v in self._items.values())
            + "]"
        )
 
 

Member Data Documentation

__slots__

tuple GaudiKernel.GaudiHandles.GaudiHandleArray.__slots__ = ("_items",)

staticprivate

Definition at line 133 of file GaudiHandles.py.

_items

GaudiKernel.GaudiHandles.GaudiHandleArray._items = {}

protected

Definition at line 138 of file GaudiHandles.py.

handleType

GaudiKernel.GaudiHandles.GaudiHandleArray.handleType = None

static

Definition at line 134 of file GaudiHandles.py.

---

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

• GaudiKernel/python/GaudiKernel/GaudiHandles.py