/usr/lib/python2.7/dist-packages/sardana/sardanacontainer.py is in python-sardana 1.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | #!/usr/bin/env python
##############################################################################
##
## This file is part of Sardana
##
## http://www.tango-controls.org/static/sardana/latest/doc/html/index.html
##
## Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
## Sardana is free software: you can redistribute it and/or modify
## it under the terms of the GNU Lesser General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Sardana is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU Lesser General Public License for more details.
##
## You should have received a copy of the GNU Lesser General Public License
## along with Sardana. If not, see <http://www.gnu.org/licenses/>.
##
##############################################################################
"""This module is part of the Python Pool libray. It defines the base classes
for a pool container element"""
__all__ = ["SardanaContainer"]
__docformat__ = 'restructuredtext'
from taurus.core.util import CaselessDict
from sardanadefs import InvalidId, ElementType
class SardanaContainer(object):
"""A container class for sardana elements"""
def __init__(self):
# map of all elements
# key - element ID
# value - pointer to the element object
self._element_ids = {}
# map of all elements by name
# key - element name
# value - pointer to the element object
self._element_names = CaselessDict()
# map of all elements by name
# key - element full name
# value - pointer to the element object
self._element_full_names = CaselessDict()
# map of all elements by type
# key - element type
# value - map where:
# key - element ID
# value - pointer to the element object
self._element_types = {}
def add_element(self, e):
"""Adds a new :class:`pool.PoolObject` to this container
:param e: the pool element to be added
:type e: :class:`pool.PoolObject`
"""
name, full_name, id = e.get_name(), e.get_full_name(), e.get_id()
elem_type = e.get_type()
self._element_ids[id] = e
self._element_names[name] = e
self._element_full_names[full_name] = e
type_elems = self._element_types.get(elem_type)
if type_elems is None:
self._element_types[elem_type] = type_elems = {}
type_elems[id] = e
return e
def remove_element(self, e):
"""Removes the :class:`pool.PoolObject` from this container
:param e: the pool object to be removed
:type e: :class:`pool.PoolObject`
:throw: KeyError
"""
name, full_name, id = e.get_name(), e.get_full_name(), e.get_id()
elem_type = e.get_type()
del self._element_ids[id]
del self._element_names[name]
del self._element_full_names[full_name]
type_elems = self._element_types.get(elem_type)
del type_elems[id]
def get_element_id_map(self):
"""Returns a reference to the internal pool object ID map
:return: the internal pool object ID map
:rtype: dict<id, pool.PoolObject>
"""
return self._element_ids
def get_element_name_map(self):
"""Returns a reference to the internal pool object name map
:return: the internal pool object name map
:rtype: dict<str, pool.PoolObject>
"""
return self._element_names
def get_element_type_map(self):
"""Returns a reference to the internal pool object type map
:return: the internal pool object type map
:rtype: dict<pool.ElementType, dict<id, pool.PoolObject>>
"""
return self._element_types
def get_element(self, **kwargs):
"""Returns a reference to the requested pool object
:param kwargs: if key 'id' given: search by ID
else if key 'full_name' given: search by full name
else if key 'name' given: search by name
:return: the pool object
:rtype: pool.PoolObject
:throw: KeyError
"""
if kwargs.has_key("id"):
id = kwargs.pop("id")
return self.get_element_by_id(id, **kwargs)
if kwargs.has_key("full_name"):
full_name = kwargs.pop("full_name")
return self.get_element_by_full_name(full_name, **kwargs)
name = kwargs.pop("name")
return self.get_element_by_name(name, **kwargs)
def get_element_by_name(self, name, **kwargs):
"""Returns a reference to the requested pool object
:param name: pool object name
:type name: str
:return: the pool object
:rtype: pool.PoolObject
:throw: KeyError
"""
ret = self._element_names.get(name)
if ret is None:
raise KeyError("There is no element with name '%s'" % name)
return ret
def get_element_by_full_name(self, full_name, **kwargs):
"""Returns a reference to the requested pool object
:param name: pool object full name
:type name: str
:return: the pool object
:rtype: pool.PoolObject
:throw: KeyError
"""
ret = self._element_full_names.get(full_name)
if ret is None:
raise KeyError("There is no element with full name '%s'" % full_name)
return ret
def get_element_by_id(self, id, **kwargs):
"""Returns a reference to the requested pool object
:param id: pool object ID
:type id: int
:return: the pool object
:rtype: pool.PoolObject
:throw: KeyError
"""
ret = self._element_ids.get(id)
if ret is None:
raise KeyError("There is no element with ID '%d'" % id)
return ret
def get_elements_by_type(self, t):
"""Returns a list of all pool objects of the given type
:param t: element type
:type t: pool.ElementType
:return: list of pool objects
:rtype: seq<pool.PoolObject>
"""
elem_types_dict = self._element_types.get(t)
if elem_types_dict is None:
return []
return elem_types_dict.values()
def get_element_names_by_type(self, t):
"""Returns a list of all pool object names of the given type
:param t: element type
:type t: pool.ElementType
:return: list of pool object names
:rtype: seq<str>
"""
return [ elem.get_name() for elem in self.get_elements_by_type(t) ]
def rename_element(self, old_name, new_name):
"""Rename a pool object
:param old_name: old pool object name
:type old_name: str
:param new_name: new pool object name
:type new_name: str
"""
raise NotImplementedError
def check_element(self, name, full_name):
raise_element_name = True
try:
elem = self.get_element(name=name)
except:
raise_element_name = False
if raise_element_name:
elem_type = ElementType[elem.get_type()]
raise Exception("A %s with name '%s' already exists"
% (elem_type, name))
raise_element_full_name = True
try:
elem = self.get_element(full_name=full_name)
except:
raise_element_full_name = False
if raise_element_full_name:
elem_type = ElementType[elem.get_type()]
raise Exception("A %s with full name '%s' already exists"
% (elem_type, full_name))
|