pytrms 0.9.2__py3-none-any.whl → 0.9.5__py3-none-any.whl

pytrms/clients/db_api.py

@@ -1,183 +1,200 @@
-import os
-import json
-
-import requests
-
-from . import _logging
-from .ssevent import SSEventListener
-from .._base import IoniClientBase
-
-log = _logging.getLogger(__name__)
-
-# TODO :: sowas waer auch ganz cool: die DBAPI bietes sich geradezu an,
-#  da mehr object-oriented zu arbeiten:
-#   currentVariable = get_component(currentComponentNameAction, ds)
-#   currentVariable.save_value({'value': currentValue})
-
-class IoniConnect(IoniClientBase):
-
-    @property
-    def is_connected(self):
-        '''Returns `True` if connection to IoniTOF could be established.'''
-        try:
-            self.get("/api/status")
-            return True
-        except:
-            return False
-
-    @property
-    def is_running(self):
-        '''Returns `True` if IoniTOF is currently acquiring data.'''
-        raise NotImplementedError("is_running")
-
-    def connect(self, timeout_s):
-        pass
-
-    def disconnect(self):
-        pass
-
-    def __init__(self, host='127.0.0.1', port=5066, session=None):
-        super().__init__(host, port)
-        self.url = f"http://{self.host}:{self.port}"
-        if session is None:
-            session = requests.sessions.Session()
-        self.session = session
-        # ??
-        self.current_avg_endpoint = None
-        self.comp_dict = dict()
-
-    def get(self, endpoint, **kwargs):
-        return self._get_object(endpoint, **kwargs).json()
-
-    def post(self, endpoint, data, **kwargs):
-        return self._create_object(endpoint, data, 'post', **kwargs).headers.get('Location')
-
-    def put(self, endpoint, data, **kwargs):
-        return self._create_object(endpoint, data, 'put', **kwargs).headers.get('Location')
-
-    def upload(self, endpoint, filename):
-        if not endpoint.startswith('/'):
-            endpoint = '/' + endpoint
-        with open(filename) as f:
-            # Note (important!): this is a "form-data" entry, where the server
-            #  expects the "name" to be 'file' and rejects it otherwise:
-            name = 'file'
-            r = self.session.post(self.url + endpoint, files=[(name, (filename, f, ''))])
-            r.raise_for_status()
-
-        return r
-
-    def _get_object(self, endpoint, **kwargs):
-        if not endpoint.startswith('/'):
-            endpoint = '/' + endpoint
-        if 'headers' not in kwargs:
-            kwargs['headers'] = {'content-type': 'application/hal+json'}
-        elif 'content-type' not in (k.lower() for k in kwargs['headers']):
-            kwargs['headers'].update({'content-type': 'application/hal+json'})
-        r = self.session.request('get', self.url + endpoint, **kwargs)
-        r.raise_for_status()
-        
-        return r
-
-    def _create_object(self, endpoint, data, method='post', **kwargs):
-        if not endpoint.startswith('/'):
-            endpoint = '/' + endpoint
-        if not isinstance(data, str):
-            data = json.dumps(data, ensure_ascii=False)  # default is `True`, escapes Umlaute!
-        if 'headers' not in kwargs:
-            kwargs['headers'] = {'content-type': 'application/hal+json'}
-        elif 'content-type' not in (k.lower() for k in kwargs['headers']):
-            kwargs['headers'].update({'content-type': 'application/hal+json'})
-        r = self.session.request(method, self.url + endpoint, data=data, **kwargs)
-        if not r.ok:
-            log.error(f"POST {endpoint}\n{data}\n\nreturned [{r.status_code}]: {r.content}")
-            r.raise_for_status()
-
-        return r
-
-    def sync(self, peaktable):
-        """Compare and upload any differences in `peaktable` to the database."""
-        from pytrms.peaktable import Peak, PeakTable
-        from operator import attrgetter
-
-        # Note: a `Peak` is a hashable object that serves as a key that
-        #  distinguishes between peaks as defined by PyTRMS:
-        make_key = lambda peak: Peak(center=peak['center'], label=peak['name'], shift=peak['shift'])
-
-        if isinstance(peaktable, str):
-            log.info(f"loading peaktable '{peaktable}'...")
-            peaktable = PeakTable.from_file(peaktable)
-
-        # get the PyTRMS- and IoniConnect-peaks on the same page:
-        conv = {
-            'name':   attrgetter('label'),
-            'center': attrgetter('center'),
-            'kRate':  attrgetter('k_rate'),
-            'low':    lambda p: p.borders[0],
-            'high':   lambda p: p.borders[1],
-            'shift':  attrgetter('shift'),
-            'multiplier': attrgetter('multiplier'),
-        }
-        # normalize the input argument and create a hashable set:
-        updates = dict()
-        for peak in peaktable:
-            payload = {k: conv[k](peak) for k in conv}
-            updates[make_key(payload)] = {'payload': payload}
-
-        log.info(f"fetching current peaktable from the server...")
-        # create a comparable collection of peaks already on the database by
-        # reducing the keys in the response to what we actually want to update:
-        db_peaks = {make_key(p): {
-                    'payload': {k: p[k] for k in conv.keys()},
-                    'self':   p['_links']['self'],
-                    'parent': p['_links'].get('parent'),
-                    } for p in self.get('/api/peaks')['_embedded']['peaks']}
-
-        to_update = updates.keys() & db_peaks.keys()
-        to_upload = updates.keys() - db_peaks.keys()
-        updated = 0
-        for key in sorted(to_update):
-            # check if an existing peak needs an update
-            if db_peaks[key]['payload'] == updates[key]['payload']:
-                # nothing to do..
-                log.debug(f"up-to-date: {key}")
-                continue
-
-            self.put(db_peaks[key]['self']['href'], updates[key]['payload'])
-            log.info(f"updated:    {key}")
-            updated += 1
-
-        if len(to_upload):
-            # Note: POSTing the embedded-collection is *miles faster*
-            #  than doing separate requests for each peak!
-            payload = {'_embedded': {'peaks': [updates[key]['payload'] for key in sorted(to_upload)]}}
-            self.post('/api/peaks', payload)
-            for key in sorted(to_upload): log.info(f"added new:  {key}")
-
-        # Note: this disregards the peak-parent-relationship, but in
-        #  order to implement this correctly, one would need to check
-        #  if the parent-peak with a specific 'parentID' is already
-        #  uploaded and search it.. there's an endpoint
-        #   'LINK /api/peaks/{parentID} Location: /api/peaks/{childID}'
-        #  to link a child to its parent, but it remains complicated.
-        # TODO :: maybe later implement parent-peaks!?
-
-        return {
-                'added': len(to_upload),
-                'updated': updated,
-                'up-to-date': len(to_update) - updated,
-        }
-
-    def iter_events(self, event_re=r".*"):
-        """Follow the server-sent-events (SSE) on the DB-API.
-
-        `event_re`  a regular expression to filter events (default: matches everything)
-
-        Note: This will block until a matching event is received.
-         Especially, it cannot be cancelled by KeyboardInterrupt (due to the `requests`
-         stream-implementation), unless the server sends a keep-alive at regular
-         intervals (as every well-behaved server should be doing)!
-        """
-        yield from SSEventListener(event_re, host_url=self.url, endpoint="/api/events",
-                session=self.session)
-
+import os
+import json
+
+import requests
+
+from . import _logging
+from .ssevent import SSEventListener
+from .._base import IoniClientBase
+
+log = _logging.getLogger(__name__)
+
+# TODO :: sowas waer auch ganz cool: die DBAPI bietes sich geradezu an,
+#  da mehr object-oriented zu arbeiten:
+#   currentVariable = get_component(currentComponentNameAction, ds)
+#   currentVariable.save_value({'value': currentValue})
+
+class IoniConnect(IoniClientBase):
+
+    @property
+    def is_connected(self):
+        '''Returns `True` if connection to IoniTOF could be established.'''
+        try:
+            self.get("/api/status")
+            return True
+        except:
+            return False
+
+    @property
+    def is_running(self):
+        '''Returns `True` if IoniTOF is currently acquiring data.'''
+        raise NotImplementedError("is_running")
+
+    def connect(self, timeout_s):
+        pass
+
+    def disconnect(self):
+        pass
+
+    def __init__(self, host='127.0.0.1', port=5066, session=None):
+        super().__init__(host, port)
+        self.url = f"http://{self.host}:{self.port}"
+        if session is None:
+            session = requests.sessions.Session()
+        self.session = session
+        # ??
+        self.current_avg_endpoint = None
+        self.comp_dict = dict()
+
+    def get(self, endpoint, **kwargs):
+        return self._get_object(endpoint, **kwargs).json()
+
+    def post(self, endpoint, data, **kwargs):
+        return self._create_object(endpoint, data, 'post', **kwargs).headers.get('Location')
+
+    def put(self, endpoint, data, **kwargs):
+        return self._create_object(endpoint, data, 'put', **kwargs).headers.get('Location')
+
+    def upload(self, endpoint, filename):
+        if not endpoint.startswith('/'):
+            endpoint = '/' + endpoint
+        with open(filename) as f:
+            # Note (important!): this is a "form-data" entry, where the server
+            #  expects the "name" to be 'file' and rejects it otherwise:
+            name = 'file'
+            r = self.session.post(self.url + endpoint, files=[(name, (filename, f, ''))])
+            r.raise_for_status()
+
+        return r
+
+    def _get_object(self, endpoint, **kwargs):
+        if not endpoint.startswith('/'):
+            endpoint = '/' + endpoint
+        if 'headers' not in kwargs:
+            kwargs['headers'] = {'content-type': 'application/hal+json'}
+        elif 'content-type' not in (k.lower() for k in kwargs['headers']):
+            kwargs['headers'].update({'content-type': 'application/hal+json'})
+        if 'timeout' not in kwargs:
+            # https://requests.readthedocs.io/en/latest/user/advanced/#timeouts
+            kwargs['timeout'] = (6.06, 27)
+        r = self.session.request('get', self.url + endpoint, **kwargs)
+        r.raise_for_status()
+        
+        return r
+
+    def _create_object(self, endpoint, data, method='post', **kwargs):
+        if not endpoint.startswith('/'):
+            endpoint = '/' + endpoint
+        if not isinstance(data, str):
+            data = json.dumps(data, ensure_ascii=False)  # default is `True`, escapes Umlaute!
+        if 'headers' not in kwargs:
+            kwargs['headers'] = {'content-type': 'application/hal+json'}
+        elif 'content-type' not in (k.lower() for k in kwargs['headers']):
+            kwargs['headers'].update({'content-type': 'application/hal+json'})
+        if 'timeout' not in kwargs:
+            # https://requests.readthedocs.io/en/latest/user/advanced/#timeouts
+            kwargs['timeout'] = (6.06, 27)
+        r = self.session.request(method, self.url + endpoint, data=data, **kwargs)
+        if not r.ok:
+            log.error(f"POST {endpoint}\n{data}\n\nreturned [{r.status_code}]: {r.content}")
+            r.raise_for_status()
+
+        return r
+
+    def sync(self, peaktable):
+        """Compare and upload any differences in `peaktable` to the database."""
+        from pytrms.peaktable import Peak, PeakTable
+        from operator import attrgetter
+
+        # Note: a `Peak` is a hashable object that serves as a key that
+        #  distinguishes between peaks as defined by PyTRMS:
+        make_key = lambda peak: Peak(center=peak['center'], label=peak['name'], shift=peak['shift'])
+
+        if isinstance(peaktable, str):
+            log.info(f"loading peaktable '{peaktable}'...")
+            peaktable = PeakTable.from_file(peaktable)
+
+        # get the PyTRMS- and IoniConnect-peaks on the same page:
+        conv = {
+            'name':   attrgetter('label'),
+            'center': attrgetter('center'),
+            'kRate':  attrgetter('k_rate'),
+            'low':    lambda p: p.borders[0],
+            'high':   lambda p: p.borders[1],
+            'shift':  attrgetter('shift'),
+            'multiplier': attrgetter('multiplier'),
+        }
+        # normalize the input argument and create a hashable set:
+        updates = dict()
+        for peak in peaktable:
+            payload = {k: conv[k](peak) for k in conv}
+            updates[make_key(payload)] = {'payload': payload}
+
+        log.info(f"fetching current peaktable from the server...")
+        # create a comparable collection of peaks already on the database by
+        # reducing the keys in the response to what we actually want to update:
+        db_peaks = {make_key(p): {
+                    'payload': {k: p[k] for k in conv.keys()},
+                    'self':   p['_links']['self'],
+                    'parent': p['_links'].get('parent'),
+                    } for p in self.get('/api/peaks')['_embedded']['peaks']}
+
+        to_update = updates.keys() & db_peaks.keys()
+        to_upload = updates.keys() - db_peaks.keys()
+        updated = 0
+        for key in sorted(to_update):
+            # check if an existing peak needs an update
+            if db_peaks[key]['payload'] == updates[key]['payload']:
+                # nothing to do..
+                log.debug(f"up-to-date: {key}")
+                continue
+
+            self.put(db_peaks[key]['self']['href'], updates[key]['payload'])
+            log.info(f"updated:    {key}")
+            updated += 1
+
+        if len(to_upload):
+            # Note: POSTing the embedded-collection is *miles faster*
+            #  than doing separate requests for each peak!
+            payload = {'_embedded': {'peaks': [updates[key]['payload'] for key in sorted(to_upload)]}}
+            self.post('/api/peaks', payload)
+            for key in sorted(to_upload):
+                log.info(f"added new:  {key}")
+
+        if len(peaktable.fitted):
+            # Note: until now, we disregarded the peak-parent-relationship, so
+            # make another request to the updated peak-table from the server...
+            db_peaks = {make_key(p): {
+                        'payload': {k: p[k] for k in conv.keys()},
+                        'self':   p['_links']['self'],
+                        'parent': p['_links'].get('parent'),
+                        } for p in self.get('/api/peaks')['_embedded']['peaks']}
+
+            for fitted in peaktable.fitted:
+                fitted_href = db_peaks[fitted]["self"]["href"]
+                parent_href = db_peaks[fitted.parent]["self"]["href"]
+                r = self.session.request('link', self.url + parent_href, headers={"location": fitted_href})
+                if not r.ok:
+                    log.error(f"LINK {parent_href} to Location: {fitted_href} failed\n\n[{r.status_code}]: {r.content}")
+                    r.raise_for_status()
+                log.debug(f"linked parent {parent_href} ~> {fitted_href}")
+
+        return {
+                'added': len(to_upload),
+                'updated': updated,
+                'up-to-date': len(to_update) - updated,
+        }
+
+    def iter_events(self, event_re=r".*"):
+        """Follow the server-sent-events (SSE) on the DB-API.
+
+        `event_re`  a regular expression to filter events (default: matches everything)
+
+        Note: This will block until a matching event is received.
+         Especially, it cannot be cancelled by KeyboardInterrupt (due to the `requests`
+         stream-implementation), unless the server sends a keep-alive at regular
+         intervals (as every well-behaved server should be doing)!
+        """
+        yield from SSEventListener(event_re, host_url=self.url, endpoint="/api/events",
+                session=self.session)
+

pytrms/clients/ioniclient.py

@@ -1,87 +1,87 @@
-#################################################
-#                                               #
-# Ionicon WebAPI - Python client                #
-#                                               #
-# this module requires the 'requests' package   #
-#                                               #
-# >> pip install --user requests                #
-#                                               #
-#################################################
-import ntpath
-import time
-
-import requests
-
-
-class IoniClient:
-    '''
-    Access the Ionicon WebAPI.
-
-    Usage:
-    > client = IoniClient()
-    > client.get('TPS_Pull_H')
-    {'TPS_Pull_H': 123.45, ... }
-
-    > client.set('TPS_Pull_H', 42)
-    {'TPS_Pull_H': 42.0, ... }
-
-    > client.start_measurement()
-    ACK
-
-    > client.host, client.port
-    ('localhost', 8002)
-    
-    '''
-    def __init__(self, host='localhost', port=8002):
-        self.host = host
-        self.port = port
-
-    @property
-    def baseurl(self):
-        return f'http://{self.host}:{self.port}/Ic_WebAPI'
-
-    def get(self, varname):
-        uri = self.baseurl + '/WebAPI_Get'
-        payload = {varname: '?'}
-        r = requests.get(uri, params=payload, timeout=10)
-
-        return r.text
-
-    def get_many(self, varnames):
-        uri = self.baseurl + '/WebAPI_Get'
-        payload = {varname: '?' for varname in varnames}
-        r = requests.get(uri, params=payload, timeout=10)
-
-        return r.text
-
-    def get_traces(self):
-        uri = self.baseurl + '/TRACES_WebAPI_Get' + '?'
-        r = requests.get(uri, timeout=10)
-
-        return r.text
-
-    def set(self, varname, value):
-        uri = self.baseurl + '/WebAPI_Set'
-        payload = {varname: value}
-        r = requests.post(uri, data=payload, timeout=10)
-
-        return r.text
-
-    def set_many(self, key_value_pairs):
-        uri = self.baseurl + '/WebAPI_Set'
-        payload = dict(key_value_pairs)
-        r = requests.post(uri, data=payload, timeout=10)
-
-        return r.text
-
-    def set_filename(self, filename):
-        return self.set('ACQ_SRV_SetFullStorageFile', ntpath.normpath(filename))
-
-    def start_measurement(self, filename=''):
-        if filename:
-            return self.set('ACQ_SRV_Start_Meas_Auto', ntpath.normpath(filename))
-
-        return self.set('ACQ_SRV_Start_Meas_Quick', 1)
-
-    def stop_measurement(self):
-        return self.set('ACQ_SRV_Stop_Meas', 1)
+#################################################
+#                                               #
+# Ionicon WebAPI - Python client                #
+#                                               #
+# this module requires the 'requests' package   #
+#                                               #
+# >> pip install --user requests                #
+#                                               #
+#################################################
+import ntpath
+import time
+
+import requests
+
+
+class IoniClient:
+    '''
+    Access the Ionicon WebAPI.
+
+    Usage:
+    > client = IoniClient()
+    > client.get('TPS_Pull_H')
+    {'TPS_Pull_H': 123.45, ... }
+
+    > client.set('TPS_Pull_H', 42)
+    {'TPS_Pull_H': 42.0, ... }
+
+    > client.start_measurement()
+    ACK
+
+    > client.host, client.port
+    ('localhost', 8002)
+    
+    '''
+    def __init__(self, host='localhost', port=8002):
+        self.host = host
+        self.port = port
+
+    @property
+    def baseurl(self):
+        return f'http://{self.host}:{self.port}/Ic_WebAPI'
+
+    def get(self, varname):
+        uri = self.baseurl + '/WebAPI_Get'
+        payload = {varname: '?'}
+        r = requests.get(uri, params=payload, timeout=10)
+
+        return r.text
+
+    def get_many(self, varnames):
+        uri = self.baseurl + '/WebAPI_Get'
+        payload = {varname: '?' for varname in varnames}
+        r = requests.get(uri, params=payload, timeout=10)
+
+        return r.text
+
+    def get_traces(self):
+        uri = self.baseurl + '/TRACES_WebAPI_Get' + '?'
+        r = requests.get(uri, timeout=10)
+
+        return r.text
+
+    def set(self, varname, value):
+        uri = self.baseurl + '/WebAPI_Set'
+        payload = {varname: value}
+        r = requests.post(uri, data=payload, timeout=10)
+
+        return r.text
+
+    def set_many(self, key_value_pairs):
+        uri = self.baseurl + '/WebAPI_Set'
+        payload = dict(key_value_pairs)
+        r = requests.post(uri, data=payload, timeout=10)
+
+        return r.text
+
+    def set_filename(self, filename):
+        return self.set('ACQ_SRV_SetFullStorageFile', ntpath.normpath(filename))
+
+    def start_measurement(self, filename=''):
+        if filename:
+            return self.set('ACQ_SRV_Start_Meas_Auto', ntpath.normpath(filename))
+
+        return self.set('ACQ_SRV_Start_Meas_Quick', 1)
+
+    def stop_measurement(self):
+        return self.set('ACQ_SRV_Stop_Meas', 1)