#!/usr/bin/env python
##############################################################################
##
# This file is part of Sardana
##
# http://www.sardana-controls.org/
##
# 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/>.
##
##############################################################################
import os
import re
import codecs
import logging.handlers
import time
from taurus import Device
from taurus.core import TaurusEventType
from taurus.core.util.log import Logger
from taurus.core.util.codecs import CodecFactory
from taurus.core.util.containers import CaselessDict
from taurus.core.taurusexception import TaurusException
from sardana import InvalidId, ElementType, Interface, sardanacustomsettings
from sardana.sardanaevent import EventType
from sardana.sardanamodulemanager import ModuleManager
from sardana.sardanamanager import SardanaElementManager, SardanaIDManager
from sardana.sardanathreadpool import get_thread_pool
from sardana.sardanautils import is_pure_str
from sardana.taurus.core.tango.sardana.motion import Motion, MotionGroup
from sardana.taurus.core.tango.sardana.pool import registerExtensions
from sardana.macroserver.msbase import MSObject
from sardana.macroserver.mscontainer import MSContainer
from sardana.macroserver.msdoor import MSDoor
from sardana.macroserver.msmacromanager import MacroManager
from sardana.macroserver.msrecordermanager import RecorderManager
from sardana.macroserver.mstypemanager import TypeManager
from sardana.macroserver.msenvmanager import EnvironmentManager
from sardana.macroserver.msparameter import ParamType
from sardana.macroserver.msexception import UnknownMacroLibrary, UnknownEnv
CHANGE_EVT_TYPES = TaurusEventType.Change, TaurusEventType.Periodic
ET = ElementType
#: dictionary dict<:data:`~sardana.ElementType`, :class:`tuple`>
#: where tuple is a sequence:
#:
#: #. type string representation
#: #. family
#: #. internal macro server class
#: #. automatic full name
TYPE_MAP = {
ET.Door: ("Door", "Door", MSDoor, "door/{macro_server.name}/{name}"),
}
class TypeData(object):
"""Information for a specific Element type"""
def __init__(self, **kwargs):
self.__dict__.update(kwargs)
#: dictionary
#: dict<:data:`~sardana.ElementType`, :class:`~sardana.macroserver.macroserver.TypeData`>
TYPE_MAP_OBJ = {}
for t, d in list(TYPE_MAP.items()):
o = TypeData(type=t, name=d[0], family=d[1], klass=d[2],
auto_full_name=d[3])
TYPE_MAP_OBJ[t] = o
class NonOverlappingTimedRotatingFileHandler(logging.handlers.TimedRotatingFileHandler):
def getNewFileName(self):
currentTime = int(time.time())
dstNow = time.localtime(currentTime)[-1]
t = self.rolloverAt - self.interval
if self.utc:
timeTuple = time.gmtime(t)
else:
timeTuple = time.localtime(t)
dstThen = timeTuple[-1]
if dstNow != dstThen:
if dstNow:
addend = 3600
else:
addend = -3600
timeTuple = time.localtime(t + addend)
dfn = self.baseFilename + "." + time.strftime(self.suffix, timeTuple)
# PY3K
if hasattr(self, 'rotation_filename'):
dfn = self.rotation_filename(dfn)
return dfn
def doRollover(self):
dfn = self.getNewFileName()
do_backup = os.path.isfile(dfn) and self.backupCount > 0
if do_backup:
dfn_backup = dfn + os.path.extsep + "backup"
os.rename(dfn, dfn_backup)
try:
super(NonOverlappingTimedRotatingFileHandler, self).doRollover()
finally:
if do_backup:
mode = self.mode
if 'a' not in mode:
mode = 'a' + mode
with codecs.open(dfn_backup, mode, self.encoding) as dest:
with codecs.open(dfn, 'r', self.encoding) as src:
dest.write(src.read())
os.remove(dfn)
os.rename(dfn_backup, dfn)
def _classify_elements(new_elements, old_elements, getter):
new, changed, deleted = [], [], []
if len(old_elements) == 0:
new = new_elements
else:
new_names = {elem.name for elem in new_elements}
old_names = {elem.name for elem in old_elements}
changed_names = set.intersection(new_names, old_names)
deleted_names = old_names.difference(new_names)
new_names = new_names.difference(old_names)
for new_name in new_names:
new.append(getter(new_name))
for changed_name in changed_names:
changed.append(getter(changed_name))
for deleted_name in deleted_names:
for old_elem in old_elements:
if old_elem.name == deleted_name:
deleted.append(old_elem)
break
return new, changed, deleted
[docs]class MacroServer(MSContainer, MSObject, SardanaElementManager, SardanaIDManager):
All = "All"
MaxParalellMacros = 5
logReportParams = dict(when='midnight', interval=1, backupCount=365)
logReportKlass = NonOverlappingTimedRotatingFileHandler
def __init__(self, full_name, name=None, macro_path=None,
environment_db=None, recorder_path=None):
self.use_numeric_element_ids = getattr(
sardanacustomsettings, "USE_NUMERIC_ELEMENT_IDS", True
)
# dict<str, Pool>
# key - device name (case insensitive)
# value - Pool object representing the device name
self._pools = CaselessDict()
self._max_parallel_macros = self.MaxParalellMacros
self._path_id = None
MSContainer.__init__(self)
if name is None:
name = full_name
MSObject.__init__(self, full_name=full_name, name=name, id=InvalidId,
macro_server=self, elem_type=ElementType.MacroServer)
registerExtensions()
self._type_manager = TypeManager(self)
self._environment_manager = EnvironmentManager(self,
environment_db=environment_db)
self._macro_manager = MacroManager(self, macro_path=macro_path)
self._recorder_manager = RecorderManager(self,
recorder_path=recorder_path)
def serialize(self, *args, **kwargs):
kwargs = MSObject.serialize(self, *args, **kwargs)
kwargs['type'] = self.__class__.__name__
kwargs['id'] = InvalidId
kwargs['parent'] = None
return kwargs
def add_job(self, job, callback=None, *args, **kw):
th_pool = get_thread_pool()
th_pool.add(job, callback, *args, **kw)
# --------------------------------------------------------------------------
# Environment DB related methods
# --------------------------------------------------------------------------
[docs] def set_environment_db(self, environment_db):
"""Sets the environment database.
:param env_db:
environment database name
:type env_db: :obj:`str`
"""
self.environment_manager.setEnvironmentDb(environment_db)
# --------------------------------------------------------------------------
# Python related methods
# --------------------------------------------------------------------------
def set_python_path(self, path):
mod_man = ModuleManager()
if self._path_id is not None:
mod_man.remove_python_path(self._path_id)
self._path_id = mod_man.add_python_path(path)
# --------------------------------------------------------------------------
# Macro path related methods
# --------------------------------------------------------------------------
[docs] def set_macro_path(self, macro_path):
"""Sets the macro path.
:param macro_path:
macro path
:type macro_path:
seq<str>
"""
old_libs = list(self.macro_manager.getMacroLibs().values())
old_macros = list(self.macro_manager.getMacros().values())
self.macro_manager.setMacroPath([p.rstrip(os.sep) for p in macro_path])
new_libs = list(self.macro_manager.getMacroLibs().values())
new_macros = list(self.macro_manager.getMacros().values())
new_libs, changed_libs, deleted_libs = _classify_elements(
new_libs, old_libs, self.macro_manager.getMacroLib)
new_elements = new_libs
changed_elements = changed_libs
deleted_elements = deleted_libs
new_macros, changed_macros, deleted_macros = _classify_elements(
new_macros, old_macros, self.macro_manager.getMacro)
new_elements.extend(new_macros)
changed_elements.extend(changed_macros)
deleted_macros.extend(deleted_macros)
evt = {
"new": new_elements,
"change": changed_elements,
"del": deleted_elements
}
self.fire_event(EventType("ElementsChanged"), evt)
# --------------------------------------------------------------------------
# Recorder path related methods
# --------------------------------------------------------------------------
[docs] def set_recorder_path(self, recorder_path):
"""Sets the recorder path.
:param recorder_path:
recorder path
:type recorder_path:
seq<str>
"""
old_libs = list(self.recorder_manager.getRecorderLibs().values())
old_recorders = list(self.recorder_manager.getRecorderMetaClasses().values())
self.recorder_manager.setRecorderPath(recorder_path)
new_libs = list(self.recorder_manager.getRecorderLibs().values())
new_recorders = list(self.recorder_manager.getRecorderMetaClasses().values())
new_libs, changed_libs, deleted_libs = _classify_elements(
new_libs, old_libs, self.recorder_manager.getRecorderLib)
new_elements = new_libs
changed_elements = changed_libs
deleted_elements = deleted_libs
new_recorders, changed_recorders, deleted_recorders = _classify_elements(
new_recorders, old_recorders, self.recorder_manager.getRecorderMetaClass)
new_elements.extend(new_recorders)
changed_elements.extend(changed_recorders)
deleted_recorders.extend(deleted_recorders)
evt = {
"new": new_elements,
"change": changed_elements,
"del": deleted_elements
}
self.fire_event(EventType("ElementsChanged"), evt)
# --------------------------------------------------------------------------
# Report related methods
# --------------------------------------------------------------------------
def set_log_report(self, filename=None, format=None):
log = self.get_report_logger()
# first check that the handler has not been initialized yet. If it has
# we remove previous handlers. We only allow one timed rotating file
# handler at a time
to_remove = []
for handler in log.handlers:
if isinstance(handler, logging.handlers.TimedRotatingFileHandler):
to_remove.append(handler)
for handler in to_remove:
handler.close()
log.removeHandler(handler)
if filename is None:
return
if format is None:
format = Logger.DftLogMessageFormat
formatter = logging.Formatter(format)
self.info("Reports are being stored in %s", filename)
klass = self.logReportKlass
handler = klass(filename, **self.logReportParams)
handler.setFormatter(formatter)
log.addHandler(handler)
def clear_log_report(self):
self.set_log_report()
def get_report_logger(self):
return logging.getLogger("Sardana.Report")
report_logger = property(get_report_logger)
[docs] def report(self, msg, *args, **kwargs):
"""
Record a log message in the sardana report (if enabled) with default
level **INFO**. The msg is the message format string, and the args are
the arguments which are merged into msg using the string formatting
operator. (Note that this means that you can use keywords in the
format string, together with a single dictionary argument.)
*kwargs* are the same as :meth:`logging.Logger.debug` plus an optional
level kwargs which has default value **INFO**
Example::
self.report("this is an official report!")
:param msg: the message to be recorded
:type msg: :obj:`str`
:param args: list of arguments
:param kwargs: list of keyword arguments"""
level = kwargs.pop('level', logging.INFO)
return self.report_logger.log(level, msg, *args, **kwargs)
# --------------------------------------------------------------------------
# Pool related methods
# --------------------------------------------------------------------------
[docs] def set_pool_names(self, pool_names):
"""Registers a new list of device pools in this manager
:param pool_names: sequence of pool names
:type pool_names: seq<str>"""
for pool in list(self._pools.values()):
elements_attr = pool.getAttribute("Elements")
elements_attr.removeListener(self.on_pool_elements_changed)
for name in pool_names:
self.debug("Creating pool %s", name)
try:
pool = Device(name)
except TaurusException as e:
self.error('Could not create Pool object for %s, see debug stream for more details' % name)
self.debug('Details',exc_info=True)
continue
self._pools[name] = pool
elements_attr = pool.getAttribute("Elements")
elements_attr.addListener(self.on_pool_elements_changed)
[docs] def get_pool_names(self):
"""Returns the list of names of the pools this macro server is connected
to.
:return:
the list of names of the pools this macro server is connected to
:rtype:
seq<str>"""
return list(self._pools.keys())
[docs] def get_pool(self, pool_name):
"""Returns the device pool object corresponding to the given device name
or None if no match is found.
:param pool_name: device pool name
:type pool_name: :obj:`str`
:return: Pool object or None if no match is found"""
pools = self._pools
if pool_name in pools:
return pools.get(pool_name)
for pool in pools.values():
if pool.name.lower() == pool_name.lower():
return pool
[docs] def get_pools(self):
"""Returns the list of pools this macro server is connected to.
:return: the list of pools this macro server is connected to
:rtype: seq<Pool>"""
return list(self._pools.values())
[docs] def get_default_pool(self):
"""Returns the pool defined in the DefaultPool environmental
variable"""
try:
poolName = self.get_env('DefaultPool')
poolObj = self.get_pool(poolName)
if poolObj is None:
raise RuntimeError(("{} defined in DefaultPool env var "
"not found".format(poolName)))
except UnknownEnv:
pools = self.get_pools()
if len(pools) > 1:
raise RuntimeError(
'DefaultPool environment variable not defined')
else:
poolObj = pools[0]
return poolObj
def on_pool_elements_changed(self, evt_src, evt_type, evt_value):
if evt_type not in CHANGE_EVT_TYPES:
return
try:
value = CodecFactory().decode(evt_value.rvalue)
except:
self.error("Could not decode pool elements info")
self.debug(
"Pool elements info: {}".format(evt_value.rvalue),
exc_info=True
)
return
self.fire_event(EventType("PoolElementsChanged"), value)
# --------------------------------------------------------------------------
# Door related methods
# --------------------------------------------------------------------------
def _fill_kwargs_with_id(self, kwargs, name=None):
if self.use_numeric_element_ids:
eid = kwargs.get('id')
if eid is None:
kwargs['id'] = eid = self.get_new_id()
else:
self.reserve_id(eid)
else:
kwargs['id'] = name
def create_element(self, **kwargs):
type = kwargs['type']
elem_type = ElementType[type]
name = kwargs['name']
kwargs['macro_server'] = self
td = TYPE_MAP_OBJ[elem_type]
klass = td.klass
auto_full_name = td.auto_full_name
full_name = kwargs.get("full_name", auto_full_name.format(**kwargs))
self.check_element(name, full_name)
self._fill_kwargs_with_id(kwargs, name)
elem = klass(**kwargs)
ret = self.add_element(elem)
self.fire_event(EventType("ElementCreated"), elem)
return ret
def create_door(self, **kwargs):
return self.create_element(type="Door", **kwargs)
# --------------------------------------------------------------------------
# General access to elements
# --------------------------------------------------------------------------
def get_elements_info(self):
return self.get_remote_elements_info() + self.get_local_elements_info()
def get_remote_elements_info(self):
return [elem.serialize()
for pool in self.get_pools()
for elem in pool.getElements()]
def get_local_elements_info(self):
# fill macro library info
ret = [macrolib.serialize()
for macrolib in list(self.get_macro_libs().values())]
# fill macro info
ret += [macro.serialize()
for macro in list(self.get_macros().values())]
# fill parameter type info
ret += [paramtype.serialize()
for paramtype in list(self.get_data_types().values())]
return ret
# --------------------------------------------------------------------------
# macro execution
# --------------------------------------------------------------------------
def set_max_parallel_macros(self, nb):
assert nb > 0, "max parallel macros number must be > 0"
th_pool = get_thread_pool()
if th_pool.size + 5 < nb:
th_pool.size = nb
self._max_parallel_macros = nb
def get_max_parallel_macros(self):
return self._max_parallel_macros
max_parallel_macros = property(get_max_parallel_macros,
set_max_parallel_macros, doc="maximum number of macros which can "
"execute at the same time")
@property
def macro_manager(self):
return self._macro_manager
@property
def recorder_manager(self):
return self._recorder_manager
@property
def environment_manager(self):
return self._environment_manager
@property
def type_manager(self):
return self._type_manager
# --------------------------------------------------------------------------
# (Re)load code
# --------------------------------------------------------------------------
def reload_lib(self, lib_name):
return self.macro_manager.reloadLib(lib_name)
[docs] def reload_macro_lib(self, lib_name):
manager = self.macro_manager
try:
old_lib = manager.getMacroLib(lib_name)
except UnknownMacroLibrary:
old_lib = None
new_elements, changed_elements, deleted_elements = [], [], []
new_lib = manager.reloadMacroLib(lib_name)
if new_lib.has_errors():
exc_type, exc_value, exc_traceback = new_lib.get_error()
raise exc_type(exc_value).with_traceback(exc_traceback)
if old_lib is None:
new_elements.extend(new_lib.get_macros())
new_elements.append(new_lib)
else:
changed_elements.append(new_lib)
new_names = {macro.name for macro in new_lib.get_macros()}
old_names = {macro.name for macro in old_lib.get_macros()}
changed_names = set.intersection(new_names, old_names)
deleted_names = old_names.difference(new_names)
new_names = new_names.difference(old_names)
for new_name in new_names:
new_elements.append(new_lib.get_macro(new_name))
for changed_name in changed_names:
changed_elements.append(new_lib.get_macro(changed_name))
for deleted_name in deleted_names:
deleted_elements.append(old_lib.get_macro(deleted_name))
evt = {"new": new_elements, "change": changed_elements,
"del": deleted_elements}
self.fire_event(EventType("ElementsChanged"), evt)
return new_lib
reload_macro_lib.__doc__ = MacroManager.reloadMacroLib.__doc__
def reload_macro_libs(self, lib_names):
for lib_name in lib_names:
self.reload_macro_lib(lib_name)
def reload_macro(self, macro_name):
macro_info = self.macro_manager.getMacro(macro_name)
lib_name = macro_info.module_name
return self.reload_macro_lib(lib_name)
def reload_macros(self, macro_names):
lib_names = set()
for macro_name in macro_names:
macro_info = self.macro_manager.getMacro(macro_name)
lib_names.add(macro_info.module_name)
self.reload_macro_libs(lib_names)
def get_macro_lib(self, lib_name):
return self.macro_manager.getMacroLib(lib_name)
get_macro_lib.__doc__ = MacroManager.getMacroLib.__doc__
def get_macro_libs(self, filter=None):
return self.macro_manager.getMacroLibs(filter=filter)
get_macro_libs.__doc__ = MacroManager.getMacroLibs.__doc__
def get_macro_lib_names(self):
return self.macro_manager.getMacroLibNames()
get_macro_lib_names.__doc__ = MacroManager.getMacroLibNames.__doc__
def get_macro(self, name):
return self.macro_manager.getMacro(name)
get_macro.__doc__ = MacroManager.getMacro.__doc__
[docs] def get_macros(self, filter=None):
return self.macro_manager.getMacros(filter=filter)
get_macros.__doc__ = MacroManager.getMacros.__doc__
def get_macro_names(self):
return self.macro_manager.getMacroNames()
get_macro_names.__doc__ = MacroManager.getMacroNames.__doc__
[docs] def get_macro_classes(self):
return self.macro_manager.getMacroClasses()
get_macro_classes.__doc__ = MacroManager.getMacroClasses.__doc__
[docs] def get_macro_functions(self):
return self.macro_manager.getMacroFunctions()
get_macro_functions.__doc__ = MacroManager.getMacroFunctions.__doc__
def get_macro_libs_summary_info(self):
libs = self.get_macro_libs()
ret = []
for module_name, macro_lib_info in list(libs.items()):
elem = "%s (%s)" % (macro_lib_info.name, macro_lib_info.file_path)
ret.append(elem)
return ret
def get_macro_classes_summary_info(self):
macros = self.get_macros()
ret = []
for macro_info in macros:
elem = "%s (%s)" % (macro_info.name, macro_info.file_path)
ret.append(elem)
return ret
[docs] def get_or_create_macro_lib(self, lib_name, macro_name=None):
"""Gets the exiting macro lib or creates a new macro lib file. If
name is not None, a macro template code for the given macro name is
appended to the end of the file.
:param lib_name:
module name, python file name, or full file name (with path)
:type lib_name: :obj:`str`
:param macro_name:
an optional macro name. If given a macro template code is appended
to the end of the file (default is None meaning no macro code is
added)
:type macro_name: :obj:`str`
:return:
a sequence with three items: full_filename, code, line number is 0
if no macro is created or n representing the first line of code for
the given macro name.
:rtype: seq<str, str, int>"""
return self.macro_manager.getOrCreateMacroLib(lib_name,
macro_name=macro_name)
get_or_create_macro_lib.__doc__ = MacroManager.getOrCreateMacroLib.__doc__
def set_macro_lib(self, lib_name, code, auto_reload=True):
module_name = self.macro_manager.setMacroLib(lib_name, code,
auto_reload=False)
if auto_reload:
self.reload_macro_lib(module_name)
set_macro_lib.__doc__ = MacroManager.setMacroLib.__doc__
# --------------------------------------------------------------------------
# Data types
# --------------------------------------------------------------------------
def get_data_types(self):
return self.type_manager.getTypes()
get_data_types.__doc__ = TypeManager.getTypes.__doc__
def get_data_type(self, type_name):
return self.type_manager.getTypeObj(type_name)
get_data_type.__doc__ = TypeManager.getTypeObj.__doc__
def get_data_type_names(self):
return self.type_manager.getTypeNames()
get_data_type_names.__doc__ = TypeManager.getTypeNames.__doc__
def get_data_type_names_with_asterisc(self):
return self.type_manager.getTypeListStr()
get_data_type_names_with_asterisc.__doc__ = TypeManager.getTypeListStr.__doc__
# --------------------------------------------------------------------------
# Doors
# --------------------------------------------------------------------------
def get_doors(self):
return self.get_elements_by_type(ElementType.Door)
def get_door_names(self):
return [door.full_name for door in self.get_doors()]
#-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-
# Environment access methods
#-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-
[docs] def get_env(self, key=None, door_name=None, macro_name=None):
"""Gets the environment matching the given parameters:
- door_name and macro_name define the context where to look for
the environment. If both are None, the global environment is
used. If door name is None but macro name not, the given macro
environment is used and so on...
- If key is None it returns the complete environment, otherwise
key must be a string containing the environment variable name.
:param key:
environment variable name [default: None, meaning all environment]
:type key: :obj:`str`
:param door_name:
local context for a given door [default: None, meaning no door
context is used]
:type door_name: :obj:`str`
:param macro_name:
local context for a given macro [default: None, meaning no macro
context is used]
:type macro_name: :obj:`str`
:return: a :obj:`dict` containing the environment
:rtype: :obj:`dict`
:raises: UnknownEnv"""
return self.environment_manager.getEnv(key=key, macro_name=macro_name,
door_name=door_name)
[docs] def set_env(self, key, value):
"""Sets the environment key to the new value and stores it persistently.
:param key: the key for the environment
:param value: the value for the environment
:return: a tuple with the key and value objects stored"""
env_man = self.environment_manager
if env_man.hasEnv(key):
evt_type = "change"
else:
evt_type = "new"
k, v = self.environment_manager.setEnv(key, value)
evt = {evt_type: {k: v}}
self.fire_event(EventType("EnvironmentChanged"), evt)
return k, v
[docs] def set_env_obj(self, data):
"""Sets the environment key to the new value and stores it persistently.
:param key: the key for the environment
:param value: the value for the environment
:return: a tuple with the key and value objects stored"""
env_man = self.environment_manager
new, change = {}, {}
for key, value in list(data.items()):
d = new
if env_man.hasEnv(key):
d = change
d[key] = value
ret = env_man.setEnvObj(data)
evt = dict(new=new, change=change)
self.fire_event(EventType("EnvironmentChanged"), evt)
return ret
def change_env(self, data):
env_man = self.environment_manager
new_change_env = data.get('new', {})
new_change_env.update(data.get('change', {}))
del_env = data.get('del', [])
new, change = {}, {}
for key, value in list(new_change_env.items()):
d = new
if env_man.hasEnv(key):
d = change
d[key] = value
del_keys = env_man.unsetEnv(del_env)
env_man.setEnvObj(new_change_env)
evt = dict(new=new, change=change)
evt['del'] = del_keys
self.fire_event(EventType("EnvironmentChanged"), evt)
[docs] def unset_env(self, key):
"""Unsets the environment for the given key.
:param key: the key for the environment to be unset"""
ret = self.environment_manager.unsetEnv(key)
# list is unhashable - convert to a tuple
if isinstance(key, list):
key = tuple(key)
evt = {'del': {key: None}}
self.fire_event(EventType("EnvironmentChanged"), evt)
return ret
def has_env(self, key, macro_name=None, door_name=None):
return self.environment_manager.hasEnv(key,
macro_name=macro_name, door_name=door_name)
#-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-
# General object access methods
#-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-
def get_object(self, name, type_class=All, subtype=All, pool=All):
objs = self.find_objects(name, type_class, subtype, pool)
if len(objs) == 0:
return None
if len(objs) > 1:
raise AttributeError(
'More than one object named "%s" found' % name)
return objs[0]
def get_objects(self, names, type_class=All, subtype=All, pool=All):
return self.find_objects(names, type_class=type_class, subtype=subtype,
pool=pool)
def find_objects(self, param, type_class=All, subtype=All, pool=All):
if is_pure_str(param):
param = param,
if type_class == MacroServer.All:
type_name_list = self.get_data_type_names()
else:
if is_pure_str(type_class):
type_name_list = type_class,
else:
type_name_list = type_class
obj_set = set()
param = ['^%s$' % x for x in param]
re_objs = list(map(re.compile, param, len(param) * (re.IGNORECASE,)))
re_subtype = re.compile(subtype, re.IGNORECASE)
for type_name in type_name_list:
type_class_name = type_name
if type_class_name.endswith('*'):
type_class_name = type_class_name[:-1]
type_inst = self.get_data_type(type_class_name)
if not type_inst.hasCapability(ParamType.ItemList):
continue
if self.is_macroserver_interface(type_class_name):
for name, obj in list(type_inst.getObjDict(pool=pool).items()):
for re_obj in re_objs:
if re_obj.match(name) is not None:
obj_type = ElementType[obj.get_type()]
if subtype is MacroServer.All or re_subtype.match(obj_type):
obj_set.add(obj)
else:
for name, obj in list(type_inst.getObjDict(pool=pool).items()):
for re_obj in re_objs:
if re_obj.match(name) is not None:
obj_type = obj.getType()
if (subtype is MacroServer.All or
re_subtype.match(obj.getType())) and \
obj_type != "MotorGroup":
obj_set.add(obj)
return list(obj_set)
def get_motion(self, elems, motion_source=None, read_only=False, cache=True,
decoupled=False):
if motion_source is None:
motion_source = self.get_pools()
motion_klass = Motion
if decoupled: # and len(elems)>1:
motion_klass = MotionGroup
return motion_klass(elems, motion_source)
_LOCAL_INTERFACES = {
Interface.MacroLibrary: get_macro_libs,
Interface.MacroCode: get_macros,
Interface.MacroClass: get_macro_classes,
Interface.MacroFunction: get_macro_functions,
}
def is_macroserver_interface(self, interface):
if is_pure_str(interface):
interface = Interface[interface]
return interface in self._LOCAL_INTERFACES
def get_elements_with_interface(self, interface):
ret = CaselessDict()
if is_pure_str(interface):
interface_str = interface
interface = Interface[interface_str]
else:
interface_str = Interface[interface]
if self.is_macroserver_interface(interface):
ret.update(self._LOCAL_INTERFACES.get(interface)(self))
else:
for pool in self.get_pools():
ret.update(pool.getElementsWithInterface(interface_str))
return ret
def get_element_with_interface(self, name, interface):
for pool in self.get_pools():
element = pool.getElementWithInterface(name, interface)
if element is not None:
return element
def get_controllers(self):
return self.get_elements_with_interface("Controller")
def get_moveables(self):
return self.get_elements_with_interface("Moveable")
def get_motors(self):
return self.get_elements_with_interface("Motor")
def get_pseudo_motors(self):
return self.get_elements_with_interface("PseudoMotor")
def get_io_registers(self):
return self.get_elements_with_interface("IORegister")
def get_measurement_groups(self):
return self.get_elements_with_interface("MeasurementGroup")
def get_exp_channels(self):
return self.get_elements_with_interface("ExpChannel")
def get_counter_timers(self):
return self.get_elements_with_interface("CTExpChannel")
def get_0d_exp_channels(self):
return self.get_elements_with_interface("ZeroDExpChannel")
def get_1d_exp_channels(self):
return self.get_elements_with_interface("OneDExpChannel")
def get_2d_exp_channels(self):
return self.get_elements_with_interface("TwoDExpChannel")
def get_pseudo_counters(self):
return self.get_elements_with_interface("PseudoCounter")
def get_instruments(self):
return self.get_elements_with_interface("Instrument")
def get_controller(self, name):
return self.get_element_with_interface(name, "Controller")
def get_moveable(self, name):
return self.get_element_with_interface(name, "Moveable")
def get_motor(self, name):
return self.get_element_with_interface(name, "Motor")
def get_pseudo_motor(self, name):
return self.get_element_with_interface(name, "PseudoMotor")
def get_io_register(self, name):
return self.get_element_with_interface(name, "IORegister")
def get_measurement_group(self, name):
return self.get_element_with_interface(name, "MeasurementGroup")
def get_exp_channel(self, name):
return self.get_element_with_interface(name, "ExpChannel")
def get_counter_timer(self, name):
return self.get_element_with_interface(name, "CTExpChannel")
def get_0d_exp_channel(self, name):
return self.get_element_with_interface(name, "ZeroDExpChannel")
def get_1d_exp_channel(self, name):
return self.get_element_with_interface(name, "OneDExpChannel")
def get_2d_exp_channel(self, name):
return self.get_element_with_interface(name, "TwoDExpChannel")
def get_pseudo_counter(self, name):
return self.get_element_with_interface(name, "PseudoCounter")
def get_instrument(self, name):
return self.get_element_with_interface(name, "Instrument")