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

pytrms/__init__.py

@@ -1,38 +1,42 @@
-_version = '0.9.2'
-
-__all__ = ['load', 'connect']
-
-
-def load(path):
-    '''Open a datafile for post-analysis or batch processing.
-
-    `path` may be a glob-expression to collect a whole batch.
-
-    returns a `Measurement` instance.
-    '''
-    import glob
-    from .measurement import FinishedMeasurement
-
-    files = glob.glob(path)
-
-    return FinishedMeasurement(*files)
-
-def connect(host=None, method='webapi'):
-    '''Connect a client to a running measurement server.
-
-    'method' is the preferred connection, either 'webapi' (default) or 'modbus'.
-
-    returns an `Instrument` if connected successfully.
-    '''
-    from .instrument import Instrument
-
-    if method.lower() == 'webapi':
-        from .clients.ioniclient import IoniClient
-        return IoniClient(host)
-
-    if method.lower() == 'modbus':
-        from .modbus import IoniconModbus
-        return IoniconModbus(host)
-
-    raise NotImplementedError(str(method))
-
+_version = '0.9.5'
+
+__all__ = ['load', 'connect']
+
+
+def load(path):
+    '''Open a datafile for post-analysis or batch processing.
+
+    `path` may be a glob-expression to collect a whole batch.
+
+    returns a `Measurement` instance.
+    '''
+    import glob
+    from .measurement import FinishedMeasurement
+
+    files = glob.glob(path)
+
+    return FinishedMeasurement(*files)
+
+
+def connect(host='localhost', port=None, method='mqtt'):
+    '''Connect a client to a running measurement server.
+
+    'method' is the preferred connection, either 'mqtt' (default), 'webapi' or 'modbus'.
+
+    returns an `Instrument` if connected successfully.
+    '''
+    from .instrument import Instrument
+
+    if method.lower() == 'mqtt':
+        from .clients.mqtt import MqttClient as _client
+    elif method.lower() == 'webapi':
+        from .clients.ioniclient import IoniClient as _client
+    elif method.lower() == 'modbus':
+        from .modbus import IoniconModbus as _client
+    else:
+        raise NotImplementedError(str(method))
+
+    backend = _client(host, port) if port is not None else _client(host)
+
+    return Instrument(backend)
+

pytrms/_base/__init__.py

@@ -1,24 +1,24 @@
-from collections import namedtuple
-
-from .mqttclient import MqttClientBase
-from .ioniclient import IoniClientBase
-
-class itype:
-
-    table_setting_t = namedtuple('mass_mapping', ['name', 'mass2value'])
-    timecycle_t     = namedtuple('timecycle',  ['rel_cycle','abs_cycle','abs_time','rel_time'])
-    masscal_t       = namedtuple('masscal',    ['mode', 'masses', 'timebins', 'cal_pars', 'cal_segs'])
-    add_data_item_t = namedtuple('add_data',   ['value', 'name', 'unit', 'view'])
-    fullcycle_t     = namedtuple('fullcycle',  ['timecycle', 'intensity', 'mass_cal', 'add_data'])
-
-    AME_RUN    = 8
-    AME_STEP   = 7
-    AME_ACTION = 5
-    USE_MEAN   = 2  # (only in AUTO_UseMean)
-
-    REACT_Udrift = 0
-    REACT_pDrift = 1
-    REACT_Tdrift = 2
-    REACT_PI_Idx = 4  # skipping E/N = 3
-    REACT_TM_Idx = 5
-
+from collections import namedtuple
+
+from .mqttclient import MqttClientBase
+from .ioniclient import IoniClientBase
+
+class itype:
+
+    table_setting_t = namedtuple('mass_mapping', ['name', 'mass2value'])
+    timecycle_t     = namedtuple('timecycle',  ['rel_cycle','abs_cycle','abs_time','rel_time'])
+    masscal_t       = namedtuple('masscal',    ['mode', 'masses', 'timebins', 'cal_pars', 'cal_segs'])
+    add_data_item_t = namedtuple('add_data',   ['value', 'name', 'unit', 'view'])
+    fullcycle_t     = namedtuple('fullcycle',  ['timecycle', 'intensity', 'mass_cal', 'add_data'])
+
+    AME_RUN    = 8
+    AME_STEP   = 7
+    AME_ACTION = 5
+    USE_MEAN   = 2  # (only in AUTO_UseMean)
+
+    REACT_Udrift = 0
+    REACT_pDrift = 1
+    REACT_Tdrift = 2
+    REACT_PI_Idx = 4  # skipping E/N = 3
+    REACT_TM_Idx = 5
+

pytrms/_base/ioniclient.py

@@ -1,32 +1,32 @@
-from abc import ABC, abstractmethod
-
-class IoniClientBase(ABC):
-
-    @property
-    @abstractmethod
-    def is_connected(self):
-        '''Returns `True` if connection to IoniTOF could be established.'''
-        pass
-
-    @property
-    @abstractmethod
-    def is_running(self):
-        '''Returns `True` if IoniTOF is currently acquiring data.'''
-        pass
-
-    @abstractmethod
-    def connect(self, timeout_s):
-        pass
-
-    @abstractmethod
-    def disconnect(self):
-        pass
-
-    def __init__(self, host, port):
-        # Note: circumvent (potentially sluggish) Windows DNS lookup:
-        self.host = '127.0.0.1' if host == 'localhost' else str(host)
-        self.port = int(port)
-
-    def __repr__(self):
-        return f"<{self.__class__.__name__} @ {self.host}[:{self.port}]>"
-
+from abc import ABC, abstractmethod
+
+class IoniClientBase(ABC):
+
+    @property
+    @abstractmethod
+    def is_connected(self):
+        '''Returns `True` if connection to IoniTOF could be established.'''
+        pass
+
+    @property
+    @abstractmethod
+    def is_running(self):
+        '''Returns `True` if IoniTOF is currently acquiring data.'''
+        pass
+
+    @abstractmethod
+    def connect(self, timeout_s):
+        pass
+
+    @abstractmethod
+    def disconnect(self):
+        pass
+
+    def __init__(self, host, port):
+        # Note: circumvent (potentially sluggish) Windows DNS lookup:
+        self.host = '127.0.0.1' if host == 'localhost' else str(host)
+        self.port = int(port)
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} @ {self.host}[:{self.port}]>"
+

pytrms/_base/mqttclient.py

@@ -1,119 +1,119 @@
-import os
-import time
-import logging
-import json
-from collections import deque
-from itertools import cycle
-from threading import Condition, RLock
-from datetime import datetime as dt
-
-import paho.mqtt.client
-
-from .ioniclient import IoniClientBase
-
-log = logging.getLogger(__name__)
-
-__all__ = ['MqttClientBase']
-
-
-def _on_connect(client, self, flags, rc):
-    # Note: ensure subscription after re-connecting,
-    #  wildcards are '+' (one level), '#' (all levels):
-    default_QoS = 2
-    topics = set()
-    for subscriber in self._subscriber_functions:
-        topics.update(set(getattr(subscriber, "topics", [])))
-    subs = sorted(zip(topics, cycle([default_QoS])))
-    log.debug(f"[{self}] " + "\n   --> ".join(["subscribing to"] + list(map(str, subs))))
-    rv = client.subscribe(subs)
-    log.info(f"[{self}] successfully connected with {rv = }")
-
-def _on_subscribe(client, self, mid, granted_qos):
-    log.info(f"[{self}] successfully subscribed with {mid = } | {granted_qos = }")
-
-def _on_publish(client, self, mid):
-    log.debug(f"[{self}] published {mid = }")
-
-
-class MqttClientBase(IoniClientBase):
-
-    @property
-    def is_connected(self):
-        '''Returns `True` if connected to the server.
-
-        Note: this property will be polled on initialization and should
-         return `True` if a connection could be established!
-        '''
-        return (True
-            and self.client.is_connected())
-
-    def __init__(self, host, port, subscriber_functions,
-            on_connect, on_subscribe, on_publish, 
-            connect_timeout_s=10):
-        assert len(subscriber_functions) > 0, "no subscribers: for some unknown reason this causes disconnects"
-        super().__init__(host, port)
-
-        # Note: Version 2.0 of paho-mqtt introduced versioning of the user-callback to fix
-        #  some inconsistency in callback arguments and to provide better support for MQTTv5.
-        #  VERSION1 of the callback is deprecated, but is still supported in version 2.x.
-        #  If you want to upgrade to the newer version of the API callback, you will need
-        #  to update your callbacks:
-        paho_version = int(paho.mqtt.__version__.split('.')[0])
-        if paho_version == 1:
-            self.client = paho.mqtt.client.Client(clean_session=True)
-        elif paho_version == 2:
-            self.client = paho.mqtt.client.Client(paho.mqtt.client.CallbackAPIVersion.VERSION1,
-                    clean_session=True)
-        else:
-            # see https://eclipse.dev/paho/files/paho.mqtt.python/html/migrations.html
-            raise NotImplementedError("API VERSION2 for MQTTv5 (use paho-mqtt 2.x or implement user callbacks)")
-
-        # clean_session is a boolean that determines the client type. If True,
-        # the broker will remove all information about this client when it
-        # disconnects. If False, the client is a persistent client and
-        # subscription information and queued messages will be retained when the
-        # client disconnects.
-        # The clean_session argument only applies to MQTT versions v3.1.1 and v3.1.
-        # It is not accepted if the MQTT version is v5.0 - use the clean_start
-        # argument on connect() instead.
-        self.client.on_connect   = on_connect    if on_connect   is not None else _on_connect
-        self.client.on_subscribe = on_subscribe  if on_subscribe is not None else _on_subscribe
-        self.client.on_publish   = on_publish    if on_publish   is not None else _on_publish
-        # ...subscribe to topics...
-        self._subscriber_functions = list(subscriber_functions)
-        for subscriber in self._subscriber_functions:
-            for topic in getattr(subscriber, "topics", []):
-                self.client.message_callback_add(topic, subscriber)
-        # ...pass this instance to each callback...
-        self.client.user_data_set(self)
-        # ...and connect to the server:
-        try:
-            self.connect(connect_timeout_s)
-        except TimeoutError as exc:
-            log.warn(f"{exc} (retry connecting when the Instrument is set up)")
-
-    def connect(self, timeout_s=10):
-        log.info(f"[{self}] connecting to MQTT broker...")
-        self.client.connect(self.host, self.port, timeout_s)
-        self.client.loop_start()  # runs in a background thread
-        started_at = time.monotonic()
-        while time.monotonic() < started_at + timeout_s:
-            if self.is_connected:
-                break
-
-            time.sleep(10e-3)
-        else:
-            self.disconnect()
-            raise TimeoutError(f"[{self}] no connection to IoniTOF")
-
-    def publish_with_ack(self, *args, timeout_s=10, **kwargs):
-        # Note: this is important when publishing just before exiting the application
-        #  to ensure that all messages get through (timeout_s is set on `.__init__()`)
-        msg = self.client.publish(*args, **kwargs)
-        msg.wait_for_publish(timeout=timeout_s)
-        return msg
-
-    def disconnect(self):
-        self.client.loop_stop()
-        self.client.disconnect()
-
+import os
+import time
+import logging
+import json
+from collections import deque
+from itertools import cycle
+from threading import Condition, RLock
+from datetime import datetime as dt
+
+import paho.mqtt.client
+
+from .ioniclient import IoniClientBase
+
+log = logging.getLogger(__name__)
+
+__all__ = ['MqttClientBase']
+
+
+def _on_connect(client, self, flags, rc):
+    # Note: ensure subscription after re-connecting,
+    #  wildcards are '+' (one level), '#' (all levels):
+    default_QoS = 2
+    topics = set()
+    for subscriber in self._subscriber_functions:
+        topics.update(set(getattr(subscriber, "topics", [])))
+    subs = sorted(zip(topics, cycle([default_QoS])))
+    log.debug(f"[{self}] " + "\n   --> ".join(["subscribing to"] + list(map(str, subs))))
+    rv = client.subscribe(subs)
+    log.info(f"[{self}] successfully connected with {rv = }")
+
+def _on_subscribe(client, self, mid, granted_qos):
+    log.info(f"[{self}] successfully subscribed with {mid = } | {granted_qos = }")
+
+def _on_publish(client, self, mid):
+    log.debug(f"[{self}] published {mid = }")
+
+
+class MqttClientBase(IoniClientBase):
+
+    @property
+    def is_connected(self):
+        '''Returns `True` if connected to the server.
+
+        Note: this property will be polled on initialization and should
+         return `True` if a connection could be established!
+        '''
+        return (True
+            and self.client.is_connected())
+
+    def __init__(self, host, port, subscriber_functions,
+            on_connect, on_subscribe, on_publish, 
+            connect_timeout_s=10):
+        assert len(subscriber_functions) > 0, "no subscribers: for some unknown reason this causes disconnects"
+        super().__init__(host, port)
+
+        # Note: Version 2.0 of paho-mqtt introduced versioning of the user-callback to fix
+        #  some inconsistency in callback arguments and to provide better support for MQTTv5.
+        #  VERSION1 of the callback is deprecated, but is still supported in version 2.x.
+        #  If you want to upgrade to the newer version of the API callback, you will need
+        #  to update your callbacks:
+        paho_version = int(paho.mqtt.__version__.split('.')[0])
+        if paho_version == 1:
+            self.client = paho.mqtt.client.Client(clean_session=True)
+        elif paho_version == 2:
+            self.client = paho.mqtt.client.Client(paho.mqtt.client.CallbackAPIVersion.VERSION1,
+                    clean_session=True)
+        else:
+            # see https://eclipse.dev/paho/files/paho.mqtt.python/html/migrations.html
+            raise NotImplementedError("API VERSION2 for MQTTv5 (use paho-mqtt 2.x or implement user callbacks)")
+
+        # clean_session is a boolean that determines the client type. If True,
+        # the broker will remove all information about this client when it
+        # disconnects. If False, the client is a persistent client and
+        # subscription information and queued messages will be retained when the
+        # client disconnects.
+        # The clean_session argument only applies to MQTT versions v3.1.1 and v3.1.
+        # It is not accepted if the MQTT version is v5.0 - use the clean_start
+        # argument on connect() instead.
+        self.client.on_connect   = on_connect    if on_connect   is not None else _on_connect
+        self.client.on_subscribe = on_subscribe  if on_subscribe is not None else _on_subscribe
+        self.client.on_publish   = on_publish    if on_publish   is not None else _on_publish
+        # ...subscribe to topics...
+        self._subscriber_functions = list(subscriber_functions)
+        for subscriber in self._subscriber_functions:
+            for topic in getattr(subscriber, "topics", []):
+                self.client.message_callback_add(topic, subscriber)
+        # ...pass this instance to each callback...
+        self.client.user_data_set(self)
+        # ...and connect to the server:
+        try:
+            self.connect(connect_timeout_s)
+        except TimeoutError as exc:
+            log.warn(f"{exc} (retry connecting when the Instrument is set up)")
+
+    def connect(self, timeout_s=10):
+        log.info(f"[{self}] connecting to MQTT broker...")
+        self.client.connect(self.host, self.port, timeout_s)
+        self.client.loop_start()  # runs in a background thread
+        started_at = time.monotonic()
+        while time.monotonic() < started_at + timeout_s:
+            if self.is_connected:
+                break
+
+            time.sleep(10e-3)
+        else:
+            self.disconnect()
+            raise TimeoutError(f"[{self}] no connection to IoniTOF")
+
+    def publish_with_ack(self, *args, timeout_s=10, **kwargs):
+        # Note: this is important when publishing just before exiting the application
+        #  to ensure that all messages get through (timeout_s is set on `.__init__()`)
+        msg = self.client.publish(*args, **kwargs)
+        msg.wait_for_publish(timeout=timeout_s)
+        return msg
+
+    def disconnect(self):
+        self.client.loop_stop()
+        self.client.disconnect()
+

pytrms/_version.py

@@ -1,26 +1,26 @@
-__version__ = '0.2.2'  # must be on the first line!
-
-__all__ = ['branch', 'digest', '__version__']
-
-
-from os.path import abspath, dirname, join, isdir
-
-# 'gitdir' might be defined by the setup.py script..
-if not 'gitdir' in vars():
-    gitdir = abspath(join(dirname(__file__), '..', '.git'))
-
-# in development mode: get git branch and digest..
-if isdir(gitdir):
-    with open(join(gitdir, 'HEAD')) as f:
-        refinfo = f.readline().strip()
-        detached = not refinfo.startswith('ref:')
-        if detached:
-            branch = 'detached-HEAD'
-            digest = refinfo[:7]
-        else:
-            refpath = refinfo.split()[-1]
-            branch = refinfo.split('/')[-1]
-            digest = open(join(gitdir, refpath)).read(7)
-
-    if not branch == 'master':
-        __version__ += '.dev' + str(eval('0x'+digest))
+__version__ = '0.2.2'  # must be on the first line!
+
+__all__ = ['branch', 'digest', '__version__']
+
+
+from os.path import abspath, dirname, join, isdir
+
+# 'gitdir' might be defined by the setup.py script..
+if not 'gitdir' in vars():
+    gitdir = abspath(join(dirname(__file__), '..', '.git'))
+
+# in development mode: get git branch and digest..
+if isdir(gitdir):
+    with open(join(gitdir, 'HEAD')) as f:
+        refinfo = f.readline().strip()
+        detached = not refinfo.startswith('ref:')
+        if detached:
+            branch = 'detached-HEAD'
+            digest = refinfo[:7]
+        else:
+            refpath = refinfo.split()[-1]
+            branch = refinfo.split('/')[-1]
+            digest = open(join(gitdir, refpath)).read(7)
+
+    if not branch == 'master':
+        __version__ += '.dev' + str(eval('0x'+digest))

pytrms/clients/__init__.py

@@ -1,33 +1,33 @@
-import os
-
-_root = os.path.dirname(__file__)
-_par_id_file = os.path.abspath(os.path.join(_root, '..', 'data', 'ParaIDs.csv'))
-assert os.path.exists(_par_id_file), "par-id file not found: please re-install PyTRMS package"
-
-
-import logging as _logging
-
-_logging.TRACE = 5  # even more verbose than logging.DEBUG
-
-def enable_extended_logging(log_level=_logging.DEBUG):
-    '''make output of http-requests more talkative.
-    
-    set 'log_level=logging.TRACE' (defined as 0 in pytrms.__init__) for highest verbosity!
-    '''
-    if log_level <= _logging.DEBUG:
-        # enable logging of http request urls on the library, that is
-        #  underlying the 'requests'-package:
-        _logging.warn(f"enabling logging-output on 'urllib3' ({log_level = })")
-        requests_log = _logging.getLogger("urllib3")
-        requests_log.setLevel(log_level)
-        requests_log.propagate = True
-    
-    if log_level <= _logging.TRACE:
-        # Enabling debugging at http.client level (requests->urllib3->http.client)
-        # you will see the REQUEST, including HEADERS and DATA, and RESPONSE with
-        # HEADERS but without DATA. the only thing missing will be the response.body,
-        # which is not logged.
-        _logging.warn(f"enabling logging-output on 'HTTPConnection' ({log_level = })")
-        from http.client import HTTPConnection
-        HTTPConnection.debuglevel = 1
-
+import os
+
+_root = os.path.dirname(__file__)
+_par_id_file = os.path.abspath(os.path.join(_root, '..', 'data', 'ParaIDs.csv'))
+assert os.path.exists(_par_id_file), "par-id file not found: please re-install PyTRMS package"
+
+
+import logging as _logging
+
+_logging.TRACE = 5  # even more verbose than logging.DEBUG
+
+def enable_extended_logging(log_level=_logging.DEBUG):
+    '''make output of http-requests more talkative.
+    
+    set 'log_level=logging.TRACE' (defined as 0 in pytrms.__init__) for highest verbosity!
+    '''
+    if log_level <= _logging.DEBUG:
+        # enable logging of http request urls on the library, that is
+        #  underlying the 'requests'-package:
+        _logging.warn(f"enabling logging-output on 'urllib3' ({log_level = })")
+        requests_log = _logging.getLogger("urllib3")
+        requests_log.setLevel(log_level)
+        requests_log.propagate = True
+    
+    if log_level <= _logging.TRACE:
+        # Enabling debugging at http.client level (requests->urllib3->http.client)
+        # you will see the REQUEST, including HEADERS and DATA, and RESPONSE with
+        # HEADERS but without DATA. the only thing missing will be the response.body,
+        # which is not logged.
+        _logging.warn(f"enabling logging-output on 'HTTPConnection' ({log_level = })")
+        from http.client import HTTPConnection
+        HTTPConnection.debuglevel = 1
+