newportxps 0.3.0__py3-none-any.whl → 2025.1.0__py3-none-any.whl

newportxps/__init__.py

@@ -1 +1,3 @@
+from .version import __version__, __version_tuple__
+
 from .newportxps import NewportXPS

newportxps/debugtimer.py

@@ -0,0 +1,107 @@
+#!/usr/bin/env python
+
+import time
+import sys
+from tabulate import tabulate
+
+class DebugTimer():
+    '''
+    Measure run times for lines of code and summarize results
+    '''
+    def __init__(self, initial_message=None, verbose=False,
+                 with_mod_count=False, precision=3):
+        self.verbose = verbose
+        self.precision = precision
+        self.with_mod_count = with_mod_count
+        self.clear(initial_message=initial_message)
+
+    def clear(self, initial_message=None):
+        self.data = []
+        if initial_message is None:
+            initial_message = 'DebugTimer'
+        self.add(f'initial_message {time.ctime()}')
+
+    def add(self, msg=None):
+        if msg is None:
+            msg = time.ctime()
+        self.data.append((msg, len(sys.modules), time.perf_counter()))
+        if self.verbose:
+            print(msg)
+
+    def get_table(self, precision=None, with_mod_count=True,
+                 tablefmt='simple_outline'):
+        prec = self.precision
+        if precision is not None:
+            prec = precision
+        with_nmod= self.with_mod_count
+        if with_mod_count is not None:
+            with_nmod = with_mod_count
+        m0, n0, t0 = self.data[0]
+        tprev= t0
+        header = ['Message','Delta Time', 'Total Time']
+        row  = [m0, 0, 0]
+        if with_nmod:
+            header.append('# Modules')
+            row.append(n0)
+        table = [row[:]]
+        for m, n, t in self.data[1:]:
+            tt, dt = t-t0, t-tprev
+            row = [m, dt, tt, n] if with_nmod else [m, dt, tt]
+            table.append(row[:])
+            tprev = t
+        ffmt = f'.{prec}f'
+        return tabulate(table, header, floatfmt=ffmt, tablefmt=tablefmt)
+
+    def show(self, precision=None, with_mod_count=True,
+             tablefmt='outline'):
+        print(self.get_table(precision=precision,
+                             with_mod_count=with_mod_count,
+                             tablefmt=tablefmt))
+
+
+def debugtimer(initial_message=None, with_mod_count=False,
+               verbose=False, precision=3):
+    '''debugtimer returns a DebugTimer object to measure the runtime of
+    portions of code, and then write a simple report of the results.
+
+    Arguments
+    ------------
+    iniitial message: str, optional initial message ['DebugTimer']
+    precision:      int, precision for timing results [3]
+    with_mod_count: bool, whether to include number of imported modules [True]
+    verbose:        bool, whether to print() each message when entered [False]
+
+    Returns
+    --------
+    DebugTimer object, with methods:
+
+      clear(initial_message=None)      -- reset Timer
+      add(message)                     -- record time, with message
+      show(tablefmt='simple_outline')  -- print timer report
+          where tableftmt can be any tablefmt for the tabulate module.
+
+    Example:
+    -------
+      timer = debugtimer('started timer', precision=4)
+      result = foo(x=100)
+      timer.add('ran foo')
+      bar(result)
+      timer.add('ran bar')
+      timer.show(tablefmt='outline')
+    '''
+    return DebugTimer(initial_message=initial_message,
+                      with_mod_count=with_mod_count,
+                      verbose=verbose, precision=precision)
+
+
+if __name__ == '__main__':
+    dt = debugtimer('test timer')
+    time.sleep(1.102)
+    dt.add('slept for 1.102 seconds')
+    import numpy as np
+    n = 10_000_000
+    x = np.arange(n, dtype='float64')/3.0
+    dt.add(f'created numpy array len={n}')
+    s = np.sqrt(x)
+    dt.add('took sqrt')
+    dt.show(tablefmt='outline')

newportxps/ftp_wrapper.py

@@ -9,6 +9,15 @@ logger = logging.getLogger('paramiko')
 logger.setLevel(logging.ERROR)
 
 
+SFTP_ERROR_MESSAGE = """Could not connect to XPS with sftp: no host key.
+
+You may need to add a host key to your `ssh known_hosts` file, using
+   ssh-keyscan {host} >> ~/.ssh/known_hosts
+
+or first connecting with  `sftp Administrator@{host}` """
+
+import paramiko
+
 HAS_PYSFTP = False
 try:
     import pysftp
@@ -53,7 +62,9 @@ class FTPBaseWrapper(object):
 class SFTPWrapper(FTPBaseWrapper):
     """wrap ftp interactions for Newport XPS models D"""
     def __init__(self, host=None, username='Administrator',
-                 password='Administrator'):
+                 password='Administrator', use_paramiko=True):
+        self.use_paramiko = use_paramiko
+        self.ssh_client = None
         FTPBaseWrapper.__init__(self, host=host,
                                 username=username, password=password)
 
@@ -64,19 +75,32 @@ class SFTPWrapper(FTPBaseWrapper):
             self.username = username
         if password is not None:
             self.password = password
+        if not self.use_paramiko and HAS_PYSFTP:
+            self._conn = pysftp.Connection(host,
+                                           username=username,
+                                           password=password)
+        else:
+            if self.ssh_client is None:
+                self.ssh_client = paramiko.SSHClient()
+                self.ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+            try:
+                self.ssh_client.connect(host, 22, username, password)
+
+            except paramiko.AuthenticationException:
+                print("Authentication failed. Check your username and password/key.")
+                raise ValueError(SFTP_ERROR_MESSAGE.format(host=self.host))
+            except paramiko.SSHException as e:
+                print(f"SSH connection error: {e}")
+                raise ValueError(SFTP_ERROR_MESSAGE.format(host=self.host))
+            finally:
+                self._conn = self.ssh_client.open_sftp()
 
-        if not HAS_PYSFTP:
-            raise ValueError("pysftp not installed.")
-        try:
-            self._conn = pysftp.Connection(self.host,
-                                           username=self.username,
-                                           password=self.password)
-        except:
-            print("ERROR: sftp connection to %s failed" % self.host)
-            print("You may need to add the host keys for your XPS to your")
-            print("ssh known_hosts file, using a command like this:")
-            print("  ssh-keyscan %s >> ~/.ssh/known_hosts" % self.host)
-
+    def cwd(self, remotedir):
+        if self.use_paramiko:
+            self._conn.chdir(remotedir)
+        elif hasattr(self._conn, 'cwd'):
+            self._conn.cwd(remotedir)
 
     def save(self, remotefile, localfile):
         "save remote file to local file"