nxsconfigserver 2.16.0__py3-none-any.whl → 2.18.0__py3-none-any.whl

nxsconfigserver/Merger.py

@@ -131,9 +131,18 @@ class Merger(object):
         #: (:obj:`list` <:obj:`str`> ) aliased to add links
         self.linkdatasources = []
 
+        #: (:obj:`list` <:obj:`str`> ) aliased to add extralinks
+        self.extralinkdatasources = []
+
         #: (:obj:`list` <:obj:`str`> ) aliased to switch to CanFial mode
         self.canfaildatasources = []
 
+        #: (:obj:`list` <:obj:`str`> ) extra link path
+        self.extralinkpath = []
+
+        #: (:obj:`list` <:obj:`str`> ) data link path
+        self.linkpath = [("data", "NXdata")]
+
         #: (:obj:`str`) datasource label
         self.__dsvars = "$datasources."
 
@@ -155,6 +164,8 @@ class Merger(object):
 
         :param node: dom node
         :type node: :obj:`xml.etree.ElementTree.Element`
+        :param ancestors: list with NeXus path nodes (tag, name, type)
+        :type ancestors: :obj:`list`< (:obj:`str`,:obj:`str`,:obj:`str`) >
         :returns: xml path
         :rtype: :obj:`str`
         """
@@ -178,6 +189,8 @@ class Merger(object):
         :type elem1: :obj:`xml.etree.ElementTree.Element`
         :param elem2: second element
         :type elem2: :obj:`xml.etree.ElementTree.Element`
+        :param ancestors: list with NeXus path nodes (tag, name, type)
+        :type ancestors: :obj:`list`< (:obj:`str`,:obj:`str`,:obj:`str`) >
         :returns: bool varaible if two elements are mergeable
         :rtype: :obj:`bool`
         """
@@ -244,6 +257,8 @@ class Merger(object):
         :type elem1: :obj:`xml.etree.ElementTree.Element`
         :param elem2: second element
         :type elem2: :obj:`xml.etree.ElementTree.Element`
+        :param parent: the given parent node
+        :type parent: :obj:`xml.etree.ElementTree.Element`
         """
         attr2 = elem2.attrib
         texts = []
@@ -283,11 +298,20 @@ class Merger(object):
 
         parent.remove(elem2)
 
-    def __mergeChildren(self, node, ancestors, entrynode=None):
+    def __mergeChildren(self, node, ancestors, entrynode=None,
+                        datanode=None, linknode=None):
         """ merge the given node
 
         :param node: the given node
         :type node: :obj:`xml.etree.ElementTree.Element`
+        :param ancestors: list with NeXus path nodes (tag, name, type)
+        :type ancestors: :obj:`list`< (:obj:`str`,:obj:`str`,:obj:`str`) >
+        :param entrynode: entry node
+        :type entrynode: :class:`xml.etree.ElementTree.Element`
+        :param datanode: data node
+        :type datanode: :class:`xml.etree.ElementTree.Element`
+        :param linknode: link node
+        :type linknode: :class:`xml.etree.ElementTree.Element`
         """
         if node is not None and node.tag != "definition":
             newancestors = tuple(
@@ -328,11 +352,18 @@ class Merger(object):
                                self.__getAncestors(child, newancestors)),
                             [child])
 
-                self.__mergeChildren(child, newancestors, entrynode)
+                self.__mergeChildren(child, newancestors, entrynode,
+                                     datanode, linknode)
                 if cName in self.switchable and self.switchdatasources:
                     self.__switch(child)
                 if cName in self.linkable and self.linkdatasources:
-                    self.__addlink(child, newancestors, entrynode)
+                    datanode = self.__addlink(
+                        child, newancestors, entrynode, datanode,
+                        self.linkdatasources, self.linkpath)
+                if cName in self.linkable and self.extralinkdatasources:
+                    linknode = self.__addlink(
+                        child, newancestors, entrynode, linknode,
+                        self.extralinkdatasources, self.extralinkpath)
                 if cName in self.switchable and self.canfaildatasources:
                     self.__canfail(child)
 
@@ -465,27 +496,38 @@ class Merger(object):
             if stnode is not None and dsnode is not None:
                 stnode.attrib["canfail"] = "true"
 
-    def __addlink(self, node, ancestors, entrynode):
+    def __addlink(self, node, ancestors, entrynode, linknode, linkdatasources,
+                  linkpath=None):
         """ add link in NXdata group
 
         :param node: the given node
         :type node: :obj:`xml.etree.ElementTree.Element`
+        :param ancestors: list with NeXus path nodes (tag, name, type)
+        :type ancestors: :obj:`list`< (:obj:`str`,:obj:`str`,:obj:`str`) >
+        :param entrynode: root node
+        :type entrynode: :class:`xml.etree.ElementTree.Element`
+        :param linknode: the given link node
+        :type linknode: :obj:`xml.etree.ElementTree.Element`
+        :param linkpath: list with NeXus path (name, type)
+        :type linkpath: :obj:`list` < (:obj:`str`,:obj:`str`) >
+        :returns: the current link node
+        :rtype: :obj:`xml.etree.ElementTree.Element`
         """
         if node is not None:
             dsname = None
             dsnode = None
 
             dsname, dsnode = self.__getTextDataSource(
-                node, self.linkdatasources)
+                node, linkdatasources)
             for child in node:
                 cName = unicode(child.tag)
                 if cName == 'datasource':
                     dsname = child.get("name")
-                    if dsname in self.linkdatasources:
+                    if dsname in linkdatasources:
                         dsnode = child
                     else:
                         dsname, dsnode = self.__getTextDataSource(
-                            child, self.linkdatasources)
+                            child, linkdatasources)
                 if dsnode is not None:
                     break
             if dsnode is not None:
@@ -494,46 +536,76 @@ class Merger(object):
                 for anc in reversed(ancestors):
                     path.append((anc[1], anc[2]))
                 linkfound = False
-                datanode = None
                 if entrynode is not None:
-                    for gchild in entrynode:
-                        if gchild.get("name") == 'data' \
-                           and gchild.get("type") == 'NXdata':
-                            datanode = gchild
-                            for dchild in datanode:
-                                if dchild.get("name") == dsname:
-                                    linkfound = True
+                    if linknode is None:
+                        # found linknode
+                        parent = entrynode
+                        for nm, tp in linkpath:
+                            node = None
+                            for gchild in parent:
+                                if gchild.get("name") == nm \
+                                   and gchild.get("type") == tp:
+                                    node = gchild
                                     break
+                            if node is None:
+                                break
+                            else:
+                                parent = node
+                        else:
+                            linknode = parent
+
+                    if linknode is not None:
+                        for dchild in linknode:
+                            if dchild.get("name") == dsname:
+                                linkfound = True
+                                break
                     if not linkfound:
-                        self.__createLink(entrynode, datanode, path)
+                        linknode = self.__createLink(
+                            entrynode, linknode, path, linkpath)
+        return linknode
 
-    def __createLink(self, entry, data, path):
+    def __createLink(self, entrynode, linknode, path, linkpath=None):
         """ create link on given node
 
-        :param root: root node
-        :type root: :class:`xml.etree.ElementTree.Element`
-        :param node: the given node
-        :type node: :obj:`xml.etree.ElementTree.Element`
+        :param entrynode: root node
+        :type entrynode: :class:`xml.etree.ElementTree.Element`
+        :param linknode: the given link node
+        :type linknode: :obj:`xml.etree.ElementTree.Element`
         :param path: list with NeXus path (name, type)
-        :type node: :obj:`list` < (:obj:`str`,:obj:`str`) >
+        :type path: :obj:`list` < (:obj:`str`,:obj:`str`) >
+        :param linkpath: list with NeXus path (name, type)
+        :type linkpath: :obj:`list` < (:obj:`str`,:obj:`str`) >
+        :returns: the current link node
+        :rtype: :obj:`xml.etree.ElementTree.Element`
         """
-
         if path:
             target, dsname = path[0]
             if target:
-                if data is None:
-                    data = etree.Element("group")
-                    entry.append(data)
-                    data.attrib["type"] = "NXdata"
-                    data.attrib["name"] = "data"
+                if linknode is None:
+                    linknode = entrynode
+                    if linkpath is None:
+                        linkpath = [("data", "NXdata")]
+                    for nm, tp in linkpath:
+                        for gchild in linknode:
+                            if gchild.get("name") == nm \
+                                  and gchild.get("type") == tp:
+                                linknode = gchild
+                                break
+                        else:
+                            node = etree.Element("group")
+                            linknode.append(node)
+                            linknode = node
+                            linknode.attrib["type"] = tp
+                            linknode.attrib["name"] = nm
                 for gname, gtype in path[1:]:
                     target = "%s:%s/" % (gname, gtype) + target
                 target = "/" + target
                 if dsname:
                     link = etree.Element("link")
-                    data.append(link)
+                    linknode.append(link)
                     link.attrib["target"] = "%s" % target
                     link.attrib["name"] = dsname
+        return linknode
 
     def collect(self, components):
         """ collects the given components in one DOM tree

nxsconfigserver/NXSConfigServer.py

@@ -89,6 +89,7 @@ class NXSConfigServer(tango.LatestDeviceImpl):
         self.set_state(tango.DevState.ON)
         self.get_device_properties(self.get_device_class())
         self.xmlc.versionLabel = self.VersionLabel
+        self.xmlc.extraLinkPath = self.ExtraLinkPath
 
     def always_executed_hook(self):
         """ Always excuted hook method
@@ -263,6 +264,39 @@ class NXSConfigServer(tango.LatestDeviceImpl):
             return False
         return True
 
+    def read_ExtraLinkDataSources(self, attr):
+        """ Read ExtraLinkDataSources attribute
+
+        :param attr: extra link datasources attribute
+        :type attr: :class:`tango.Attribute`
+        """
+        self.debug_stream("In read_ExtraLinkDataSources()")
+        attr.set_value(self.xmlc.extralinkdatasources or "")
+
+    def write_ExtraLinkDataSources(self, attr):
+        """ Write ExtraLinkDataSources attribute
+
+        :param attr: extra link datasources attribute
+        :type attr: :class:`tango.Attribute`
+        """
+        self.debug_stream("In write_ExtraLinkDataSources()")
+        if self.is_ExtraLinkDataSources_write_allowed():
+            self.xmlc.extralinkdatasources = attr.get_write_value() or ""
+        else:
+            self.warn_stream("To change the settings please close the server.")
+            raise Exception(
+                "To change the settings please close the server.")
+
+    def is_ExtraLinkDataSources_write_allowed(self):
+        """ ExtraLinkDataSources attribute Write State Machine
+
+        :returns: True if the operation allowed
+        :rtype: :obj:`bool`
+        """
+        if self.get_state() in [tango.DevState.RUNNING]:
+            return False
+        return True
+
     def read_CanFailDataSources(self, attr):
         """ Read CanFailDataSources attribute
 
@@ -488,6 +522,38 @@ class NXSConfigServer(tango.LatestDeviceImpl):
             return False
         return True
 
+    def InstantiatedDataSources(self, argin):
+        """ InstantiatedDataSources command
+
+        :brief: Returns a list of required components
+
+        :param argin:  DevVarStringArray    list of component names
+        :type argin: :obj:`list` <:obj:`str`>
+        :returns: DevVarStringArray    list of instantiated components
+        :rtype: :obj:`list` <:obj:`str`>
+        """
+        self.debug_stream("In InstantiateDataSources()")
+        try:
+            self.set_state(tango.DevState.RUNNING)
+            argout = self.xmlc.instantiatedDataSources(argin)
+            self.set_state(tango.DevState.OPEN)
+        finally:
+            if self.get_state() == tango.DevState.RUNNING:
+                self.set_state(tango.DevState.OPEN)
+
+        return argout
+
+    def is_InstantiatedDataSources_allowed(self):
+        """ DataSources command State Machine
+
+        :returns: True if the operation allowed
+        :rtype: :obj:`bool`
+        """
+        if self.get_state() in [tango.DevState.ON,
+                                tango.DevState.RUNNING]:
+            return False
+        return True
+
     def DataSources(self, argin):
         """ DataSources command
 
@@ -1135,6 +1201,11 @@ class NXSConfigServerClass(tango.DeviceClass):
         [tango.DevString,
          "version label",
          ["XCS"]],
+        'ExtraLinkPath':
+        [tango.DevString,
+         "extra link NeXus path below NXentry. "
+         "Default: instrument:NXinstrument/collection:NXcollection",
+         ["instrument:NXinstrument/collection:NXcollection"]],
     }
 
     #: (:obj:`dict` <:obj:`str`, \
@@ -1156,6 +1227,9 @@ class NXSConfigServerClass(tango.DeviceClass):
         'InstantiatedComponents':
             [[tango.DevVarStringArray, "list of component names"],
              [tango.DevVarStringArray, "list of instantiated components"]],
+        'InstantiatedDataSources':
+            [[tango.DevVarStringArray, "list of component names"],
+             [tango.DevVarStringArray, "list of instantiated datasources"]],
         'DataSources':
             [[tango.DevVarStringArray, "list of DataSource names"],
              [tango.DevVarStringArray, "list of required DataSources"]],
@@ -1299,6 +1373,15 @@ class NXSConfigServerClass(tango.DeviceClass):
              'description': "JSON list of datasources"
              "to which links will be added",
         }],
+        'ExtraLinkDataSources':
+        [[tango.DevString,
+          tango.SCALAR,
+          tango.READ_WRITE],
+         {
+             'label': "Datasources to which extra links will be added",
+             'description': "JSON list of datasources"
+             "to which extra links will be added",
+        }],
         'CanFailDataSources':
         [[tango.DevString,
           tango.SCALAR,

nxsconfigserver/Release.py

@@ -20,4 +20,4 @@
 """ release version module """
 
 #: version number
-__version__ = "2.16.0"
+__version__ = "2.18.0"

nxsconfigserver/XMLConfigurator.py

@@ -94,6 +94,8 @@ class XMLConfigurator(object):
         self.__stepdatasources = "[]"
         #: (:obj:`str`) datasources to which links will be added
         self.__linkdatasources = "[]"
+        #: (:obj:`str`) datasources to which extra links will be added
+        self.__extralinkdatasources = "[]"
         #: (:obj:`str`) datasources to be switched into CanFail mode
         self.__canfaildatasources = "[]"
 
@@ -125,6 +127,9 @@ class XMLConfigurator(object):
         #: (:obj:`str`) version label
         self.versionLabel = "XCS"
 
+        #: (:obj:`str`) extra link path
+        self.extraLinkPath = "instrument:NXinstrument/collection:NXcollection"
+
         #: (:class:`tango.LatestDeviceImpl`) Tango server
         self.__server = server
 
@@ -207,6 +212,35 @@ class XMLConfigurator(object):
         __setLinkDatSources,
         doc='link datasource list')
 
+    def __getExtraLinkDatSources(self):
+        """ get method for dataSourceGroup attribute
+
+        :returns: names of EXTRA LINK dataSources
+        :rtype: :obj:`str`
+        """
+        try:
+            lad = json.loads(self.__extralinkdatasources)
+            assert isinstance(lad, list)
+            return self.__extralinkdatasources
+        except Exception:
+            return '[]'
+
+    def __setExtraLinkDatSources(self, names):
+        """ set method for dataSourceGroup attribute
+
+        :param names: of EXTRA LINK dataSources
+        :type names: :obj:`str`
+        """
+        jnames = self.__stringToListJson(names)
+        #: administator data
+        self.__extralinkdatasources = jnames
+
+    #: (:obj:`str`) the json data string
+    extralinkdatasources = property(
+        __getExtraLinkDatSources,
+        __setExtraLinkDatSources,
+        doc='extra link datasource list')
+
     def __getCanFailDatSources(self):
         """ get method for dataSourceGroup attribute
 
@@ -319,6 +353,20 @@ class XMLConfigurator(object):
             comps = [self.__instantiate(cp) for cp in comps]
         return comps
 
+    def instantiatedDataSources(self, names):
+        """ instantiates the required datasources
+
+        :param names: list of datasource names
+        :type names: :obj:`list` <:obj:`str`>
+        :returns: list of instantiated datasources
+        :rtype: :obj:`list` <:obj:`str`>
+        """
+        comps = []
+        if self.__mydb:
+            comps = self.__mydb.dataSources(names)
+            comps = [self.__instantiate(ds) for ds in comps]
+        return comps
+
     def __instantiate(self, xmlcp):
         """ instantiates the xml component
 
@@ -933,11 +981,40 @@ class XMLConfigurator(object):
         mgr = Merger()
         mgr.switchdatasources = json.loads(self.stepdatasources)
         mgr.linkdatasources = json.loads(self.linkdatasources)
+        mgr.extralinkdatasources = json.loads(self.extralinkdatasources)
         mgr.canfaildatasources = json.loads(self.canfaildatasources)
+        mgr.extralinkpath = self.__splitExtraPath(self.extraLinkPath)
         mgr.collect(xmls)
         mgr.merge()
         return mgr.toString()
 
+    def __splitExtraPath(self, extrapath):
+        """ split extra path to names and types
+
+        :param extrapath: extra link path
+        :type extrapath: :obj:`str`
+        :returns: list of name an type of extra link path groups
+        :rtype: :obj:`list` <[:obj:`str`, :obj:`str`]>
+        """
+        epath = []
+        if extrapath:
+            path = extrapath.split("/")
+            for nd in path:
+                if ":" in nd:
+                    snd = nd.split(":")
+                    if snd[0] and snd[1]:
+                        epath.append([snd[0], snd[1]])
+                    elif snd[1] and len(snd[1]) > 2:
+                        epath.append([snd[0][2:], snd[1]])
+                    else:
+                        epath.append([snd[0], "NX" + snd[0]])
+
+                elif nd.startswith("NX") and len(nd) > 2:
+                    epath.append([nd[0][2:], nd[1]])
+                else:
+                    epath.append([nd[0], "NX" + nd[0]])
+        return epath
+
     def createConfiguration(self, names):
         """ creates the final configuration string in the xmlstring attribute
 

{nxsconfigserver-2.16.0.dist-info → nxsconfigserver-2.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nxsconfigserver
-Version: 2.16.0
+Version: 2.18.0
 Summary: Configuration Server for Nexus Data Writer
 Home-page: http://github.com/jkotan/nexdatas/nxsconfigserver
 Author: Jan Kotanski, Eugen Wintersberger , Halil Pasic
@@ -21,6 +21,9 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: lxml
 
 ======================================================
@@ -96,7 +99,7 @@ with proper privileges.
 Debian packages
 ^^^^^^^^^^^^^^^
 
-Debian Bookworm, Bullseye, Buster and as well as Ubuntu Lunar, Jammy  packages can be found in the HDRI repository.
+Debian Bookworm, Bullseye, Buster and as well as Ubuntu Plucky, Noble, Jammy  packages can be found in the HDRI repository.
 
 To install the debian packages, add the PGP repository key
 

nxsconfigserver-2.18.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+nxsconfigserver/ComponentParser.py,sha256=oUEy3_0Q77992pAxR3k8CxzF5UP4hwc2beHYh9v-mJU,7745
+nxsconfigserver/Errors.py,sha256=zFZlQNbZV6UlbGGBV149j1DQbPXAkTmYVgaR1QRIXP8,1956
+nxsconfigserver/MYSQLDataBase.py,sha256=54bFG4KFLMkVYMme3bcybve24qgsxKTvCo7vP6RDjTI,22755
+nxsconfigserver/Merger.py,sha256=t6xX2ETUIy1FYIXvmcEstTwKf9oq_jDtvXIDV6c4kV0,25327
+nxsconfigserver/NXSConfigServer.py,sha256=kxHx0vugHEin9j5c0iizvIbbi0Z5S6E8MoMDY7csN6k,47113
+nxsconfigserver/Release.py,sha256=9ewpv_XVl0c_YuOvqi-Ntvm7H_HchEUOXi0bWKva8I8,895
+nxsconfigserver/StreamSet.py,sha256=sSvXJxoDufmt9_Xu5rFaQsp_4x9gww_zMv0NTiiyLlg,5799
+nxsconfigserver/XMLConfigurator.py,sha256=7EzAsnoD5WLzgdEfcq9u7ITNQKZ5Car9I2jxj2DI3hI,36899
+nxsconfigserver/__init__.py,sha256=dAvNwdxRsIARsH--JgJBAxzyaX3KPzZNStQ6B7SLbjI,1718
+nxsconfigserver-2.18.0.data/scripts/NXSConfigServer,sha256=VEAkby0R6UyckF-OofkVDPx3Mkn6rjPrl2xMbbBXqwo,986
+nxsconfigserver-2.18.0.dist-info/METADATA,sha256=DsbF-BxvE5W8TpwyM_GnNx3_l6s0D-knin0jYLuHr7Y,14440
+nxsconfigserver-2.18.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+nxsconfigserver-2.18.0.dist-info/top_level.txt,sha256=TFz-xXdq3yV2iwY44R0uY1F-zqwYDnOmcJlN9kdo1S8,16
+nxsconfigserver-2.18.0.dist-info/RECORD,,

nxsconfigserver-2.16.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-nxsconfigserver/ComponentParser.py,sha256=oUEy3_0Q77992pAxR3k8CxzF5UP4hwc2beHYh9v-mJU,7745
-nxsconfigserver/Errors.py,sha256=zFZlQNbZV6UlbGGBV149j1DQbPXAkTmYVgaR1QRIXP8,1956
-nxsconfigserver/MYSQLDataBase.py,sha256=54bFG4KFLMkVYMme3bcybve24qgsxKTvCo7vP6RDjTI,22755
-nxsconfigserver/Merger.py,sha256=v8jtDGi1NYugNpcYyyxFRP8XZQcbye8cKbYtj8iQaBM,21686
-nxsconfigserver/NXSConfigServer.py,sha256=g894NApWFK3RS8MCuZd4HR6K8DCbs0sE-gYLZ9Q0OoI,44001
-nxsconfigserver/Release.py,sha256=ZF7Wt1GNsab9PoJiL5ZtBBAebQx-PCT1f3rpwwmZaOo,895
-nxsconfigserver/StreamSet.py,sha256=sSvXJxoDufmt9_Xu5rFaQsp_4x9gww_zMv0NTiiyLlg,5799
-nxsconfigserver/XMLConfigurator.py,sha256=XitDApCprP0Em17Gi2w8J_XFm8RiH3VlyOvc7vlYeiA,34163
-nxsconfigserver/__init__.py,sha256=dAvNwdxRsIARsH--JgJBAxzyaX3KPzZNStQ6B7SLbjI,1718
-nxsconfigserver-2.16.0.data/scripts/NXSConfigServer,sha256=VEAkby0R6UyckF-OofkVDPx3Mkn6rjPrl2xMbbBXqwo,986
-nxsconfigserver-2.16.0.dist-info/METADATA,sha256=QWzKAoM0loUyCa95t6oiJdRNwZzq37B4gm21WTl74pg,14279
-nxsconfigserver-2.16.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-nxsconfigserver-2.16.0.dist-info/top_level.txt,sha256=TFz-xXdq3yV2iwY44R0uY1F-zqwYDnOmcJlN9kdo1S8,16
-nxsconfigserver-2.16.0.dist-info/RECORD,,