Config loaders

lib/taurus/qt/qtgui/taurusgui/config_loader/__init__.py

@@ -0,0 +1,27 @@
+#############################################################################
+##
+# This file is part of Taurus
+##
+# http://taurus-scada.org
+##
+# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
+##
+# Taurus 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.
+##
+# Taurus 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 Taurus.  If not, see <http://www.gnu.org/licenses/>.
+##
+###########################################################################
+
+"""
+"""
+
+from .util import getLoaders

lib/taurus/qt/qtgui/taurusgui/config_loader/__main__.py

@@ -0,0 +1,18 @@
+import sys
+from pprint import pprint
+
+from .util import getLoaders
+
+
+def main(conf):
+    cfg = {}
+    loaders = getLoaders(conf)
+    for loader in loaders:
+        cfg.update(loader.load())
+
+    cfg = loaders[0].to_dict(cfg)
+
+    pprint(cfg)
+
+
+main(sys.argv[1])

lib/taurus/qt/qtgui/taurusgui/config_loader/abstract.py

@@ -0,0 +1,94 @@
+#############################################################################
+##
+# This file is part of Taurus
+##
+# http://taurus-scada.org
+##
+# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
+##
+# Taurus 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.
+##
+# Taurus 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 Taurus.  If not, see <http://www.gnu.org/licenses/>.
+##
+###########################################################################
+
+""""""
+import abc
+
+from taurus.qt.qtgui.taurusgui.utils import (
+    AppletDescription,
+    ExternalApp,
+    PanelDescription,
+    ToolBarDescription,
+)
+
+# Python 2/3 compatibility
+if not hasattr(abc, "ABC"):
+    setattr(abc, "ABC", abc.ABCMeta("ABC", (object,), {}))
+
+
+__all__ = ["AbstractConfigLoader"]
+
+
+class AbstractConfigLoader(abc.ABC):
+    """
+    Abstract class for config loaders.
+    It defines interface which has to be implemneted by subclass in
+    order for it to be ConfigLoader
+    """
+
+    CONFIG_VALUES = [
+        "GUI_NAME",
+        "ORGANIZATION",
+        "CUSTOM_LOGO",
+        "ORGANIZATION_LOGO",
+        "SINGLE_INSTANCE",
+        "MANUAL_URI",
+        "INIFILE",
+        "EXTRA_CATALOG_WIDGETS",
+    ]
+
+    DESCRIPTIONS = [
+        (AppletDescription, "AppletDescriptions"),
+        (ExternalApp, "ExternalApps"),
+        (PanelDescription, "PanelDescriptions"),
+        (ToolBarDescription, "ToolBarDescriptions"),
+    ]
+
+    def __init__(self, confname):
+        self._confname = confname
+
+    @abc.abstractmethod
+    def supports(self, confname):
+        """
+        Return True or False for support of specific configuration passed
+        """
+        return None
+
+    @abc.abstractmethod
+    def load(self):
+        """
+        This method is meant to load actual data from file on disk.
+        Return dictionary with configuration.
+        """
+        return {}
+
+    def to_dict(self, conf):
+        """
+        Generate pure Python dictionary from conf
+        """
+
+        for _, section in self.DESCRIPTIONS:
+            objs = [o.to_dict() for o in conf.get(section, [])]
+            conf[section] = objs
+
+        return conf

lib/taurus/qt/qtgui/taurusgui/config_loader/examples/config.json

@@ -0,0 +1,69 @@
+{
+	"GUI_NAME": "EXAMPLE 01",
+	"ORGANIZATION": "Taurus",
+	"MANUAL_URI": "http://www.taurus-scada.org",
+	"SYNOPTIC": ["images/example01.jdw", "images/syn2.jdw"],
+	"INSTRUMENTS_FROM_POOL": false,
+	"PanelDescriptions": [
+		{
+			"name": "NeXus Browser",
+			"classname": "taurus.qt.qtgui.extra_nexus.TaurusNeXusBrowser"
+		},
+		{
+			"name": "BigInstrument",
+			"classname": "taurus.qt.qtgui.panel.TaurusAttrForm",
+			"model": "sys/tg_test/1"
+		},
+		{
+			"name": "NeXus Browser",
+			"classname": "taurus.qt.qtgui.extra_nexus.TaurusNeXusBrowser"
+		},
+		{
+			"name": "instrument1",
+			"classname": "taurus.qt.qtgui.panel.TaurusForm",
+			"model": [
+				"sys/tg_test/1/double_scalar",
+				"sys/tg_test/1/short_scalar_ro",
+				"sys/tg_test/1/float_spectrum_ro",
+				"sys/tg_test/1/double_spectrum"
+			]
+		},
+		{
+			"name": "instrument2",
+			"classname": "taurus.qt.qtgui.panel.TaurusForm",
+			"model": [
+				"sys/tg_test/1/wave",
+				"sys/tg_test/1/boolean_scalar"
+			]
+		},
+		{
+			"name": "Selected Instrument",
+			"classname": "taurus.external.qt.Qt.QLineEdit",
+		    "sharedDataRead": {
+		    	"SelectedInstrument": "setText"
+		    },
+		    "sharedDataWrite": {
+		    	"SelectedInstrument": "textEdited"
+		    }
+		}
+	],
+	"ToolBarDescriptions": [
+		{
+			"name": "Empty Toolbar",
+			"classname": "taurus.external.qt.Qt.QToolBar"
+		}
+	],
+	"ExternalApps": [
+		{
+			"name": "xterm",
+			"cmdargs": ["xterm", "spock"],
+			"text": "Spock",
+			"icon": "utilities-terminal"
+		}
+	],
+	"EXTRA_CATALOG_WIDGETS": [
+		["taurus.external.qt.Qt.QLineEdit", "logos:taurus.png"],
+		["taurus.external.qt.Qt.QSpinBox", "images/syn2.jpg"],
+		["taurus.external.qt.Qt.QLabel", null]
+	]
+}

lib/taurus/qt/qtgui/taurusgui/config_loader/examples/config.py

@@ -0,0 +1,70 @@
+
+
+from taurus.qt.qtgui.taurusgui.utils import PanelDescription, ExternalApp, ToolBarDescription, AppletDescription
+
+GUI_NAME = 'EXAMPLE 01'
+ORGANIZATION = 'Taurus'
+
+MANUAL_URI = 'http://www.taurus-scada.org'
+
+SYNOPTIC = ['images/example01.jdw', 'images/syn2.jdw']
+
+
+INSTRUMENTS_FROM_POOL = False
+
+
+nxbrowser = PanelDescription(
+    'NeXus Browser',
+    classname='taurus.qt.qtgui.extra_nexus.TaurusNeXusBrowser'
+)
+
+i0 = PanelDescription(
+    'BigInstrument',
+    classname='taurus.qt.qtgui.panel.TaurusAttrForm',
+    model='sys/tg_test/1'
+)
+
+i1 = PanelDescription(
+    'instrument1',
+    classname='taurus.qt.qtgui.panel.TaurusForm',
+    model=['sys/tg_test/1/double_scalar',
+           'sys/tg_test/1/short_scalar_ro',
+           'sys/tg_test/1/float_spectrum_ro',
+           'sys/tg_test/1/double_spectrum']
+)
+
+i2 = PanelDescription(
+    'instrument2',
+    classname='taurus.qt.qtgui.panel.TaurusForm',
+    model=['sys/tg_test/1/wave',
+           'sys/tg_test/1/boolean_scalar']
+)
+
+trend = PanelDescription(
+    'Trend',
+    classname='taurus.qt.qtgui.plot.TaurusTrend',
+    model=['sys/tg_test/1/double_scalar']
+)
+
+connectionDemo = PanelDescription(
+    'Selected Instrument',
+    classname='taurus.external.qt.Qt.QLineEdit',  # A pure Qt widget!
+    sharedDataRead={'SelectedInstrument': 'setText'},
+    sharedDataWrite={'SelectedInstrument': 'textEdited'}
+)
+
+dummytoolbar = ToolBarDescription(
+    'Empty Toolbar',
+    classname='taurus.external.qt.Qt.QToolBar'
+)
+
+xterm = ExternalApp(
+    cmdargs=['xterm', 'spock'], text="Spock", icon='utilities-terminal')
+hdfview = ExternalApp(["hdfview"])
+pymca = ExternalApp(['pymca'])
+
+EXTRA_CATALOG_WIDGETS = [
+    ('taurus.external.qt.Qt.QLineEdit', 'logos:taurus.png'),  # a resource
+    ('taurus.external.qt.Qt.QSpinBox', 'images/syn2.jpg'),  # relative
+    # ('taurus.external.Qt.QTextEdit','/tmp/foo.png'),  # absolute
+    ('taurus.external.qt.Qt.QLabel', None)]                # none

lib/taurus/qt/qtgui/taurusgui/config_loader/jsonconf.py

@@ -0,0 +1,93 @@
+#############################################################################
+##
+# This file is part of Taurus
+##
+# http://taurus-scada.org
+##
+# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
+##
+# Taurus 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.
+##
+# Taurus 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 Taurus.  If not, see <http://www.gnu.org/licenses/>.
+##
+###########################################################################
+
+""""""
+
+import json
+import os
+
+from taurus.qt.qtgui.taurusgui.config_loader.abstract import (
+    AbstractConfigLoader,
+)
+from taurus.qt.qtgui.taurusgui.config_loader.util import ConfigLoaderError
+
+__all__ = ["JsonConfigLoader"]
+
+
+class JsonConfigLoader(AbstractConfigLoader):
+    """
+    Loads configuration for TaurusGui from JSON file
+    """
+
+    def __init__(self, confname):
+        super(JsonConfigLoader, self).__init__(confname)
+        self._data = {}
+
+    def _get_objects(self, klass, section):
+        """
+        Helper function to get list of Python objects from dictionary
+        """
+        objs = []
+        for o in self._data.get(section, []):
+            if isinstance(o, dict):
+                objs.append(klass(**o))
+        return objs
+
+    @staticmethod
+    def supports(confname):
+        if os.path.isfile(confname):
+            ext = os.path.splitext(confname)[-1]
+            if ext == ".json":
+                return True
+        return False
+
+    def _get_data(self):
+        try:
+            with open(self._confname, "r") as fp:
+                self._data = json.load(fp)
+        except IOError as e:
+            raise ConfigLoaderError(
+                "Problem with accessing config file: " + str(e)
+            )
+        except ValueError as e:
+            raise ConfigLoaderError(
+                "Problem with config file decoding: " + str(e)
+            )
+
+    def load(self):
+        self._get_data()
+
+        tmp = {}
+
+        for v in self.CONFIG_VALUES:
+            if v in self._data:
+                tmp[v] = self._data[v]
+
+        for klass, section in self.DESCRIPTIONS:
+            tmp[section] = self._get_objects(klass, section)
+
+        tmp["CONF_DIR"] = os.path.abspath(
+            os.path.dirname(self._confname)
+        )
+
+        return tmp