temscript 2.0.1__py3-none-any.whl → 2.2.0__py3-none-any.whl

temscript/_com.py

@@ -6,6 +6,7 @@ __all__ = 'UUID', 'CLSCTX_ALL', 'IUnknown', 'co_create_instance', 'SafeArray', '
 
 # COM constants
 COINIT_MULTITHREADED = 0
+COINIT_APARTMENTTHREADED = 2
 CLSCTX_ALL = 0x17
 
 
@@ -370,5 +371,27 @@ class SafeArray:
 
 
 _ole32 = ctypes.oledll.ole32
-_ole32.CoInitializeEx(None, ctypes.c_int(COINIT_MULTITHREADED))
 _oleauto = ctypes.windll.oleaut32
+
+def initialize_com(flags=None):
+    RPC_E_CHANGED_MODE = -2147417850
+
+    # The comtypes package allows to specify the apartment model by
+    # setting sys.coinit_flags in advance. We copy this behavior.
+    if flags is None:
+        import sys
+        flags = getattr(sys, "coinit_flags", None)
+
+    if flags is None:
+        # If we don't have explicit flags, try STA first and fall back to MTA
+        # if COM is already initialized to MTA.
+        try:
+            _ole32.CoInitializeEx(None, ctypes.c_int(COINIT_APARTMENTTHREADED))
+        except WindowsError as exc:
+            if exc.winerror == RPC_E_CHANGED_MODE:
+                _ole32.CoInitializeEx(None, ctypes.c_int(COINIT_MULTITHREADED))
+    else:
+        # Otherwise, use the apartment model we got
+        _ole32.CoInitializeEx(None, flags)
+
+initialize_com()

temscript/_instrument_com.py

@@ -28,7 +28,7 @@ class LongProperty(BaseProperty):
         if self._get_index is None:
             raise AttributeError("Attribute %s is not readable" % self._name)
         result = ctypes.c_long(-1)
-        prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._get_index, "get_property")
+        prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.POINTER(ctypes.c_long))(self._get_index, "get_property")
         prototype(obj.get(), ctypes.byref(result))
         return result.value
 

temscript/base_microscope.py

@@ -84,14 +84,48 @@ class BaseMicroscope(ABC):
         """Return product family (see :class:`ProductFamily` for values): "TITAN", "TECNAI", ..."""
         raise NotImplementedError
 
-    @abstractmethod
     def get_microscope_id(self):
         """
-        Return microscope ID.
+        Return hostname of microscope's computer.
 
-        There is no way to read this via the scripting adapter directly, thus this method uses hostname instead.
+        .. deprecated:: 2.2.0
+            The term "microscope ID" is ambiguous. FEI/TFS instruments identify themselves by the computer name
+            and the instrument ID (as also stored in Velox metadata), use :meth:`get_computer_name` or
+            :meth:`get_instrument_id` instead.
         """
-        raise NotImplementedError
+        import warnings
+        warnings.warn("Microscope.get_microscope_id() is deprecated. "
+                      "Use get_computer_name() and/or get_instrument_id() instead.",
+                      category=DeprecationWarning, stacklevel=2)
+        return self.get_computer_name()
+
+    def get_computer_name(self):
+        """
+        Return name (hostname) of the microscope computer.
+
+        This corresponds to the computer name stored by FEI/TFS software, e.g. in Velox metadata.
+
+        .. versionadded:: 2.2.0
+        """
+        import socket
+        return socket.gethostname()
+
+    def get_instrument_id(self):
+        """
+        Return serial number of the microscope as string of decimal digits (without the "D" prefix,
+        e.g. "1234" for D1234).
+
+        :class:`Microscope` reads the ``Instrument Key`` DWORD from
+        ``HKEY_LOCAL_MACHINE\\SOFTWARE\\FEI\\Configuration`` in the Windows registry. If the serial number
+        is not available, an empty string is returned. See :ref:`restrictions` for details.
+
+        This corresponds to the instrument ID stored by FEI/TFS software, e.g. in Velox metadata.
+
+        The default implementation returns an empty string.
+
+        .. versionadded:: 2.2.0
+        """
+        return ""
 
     @abstractmethod
     def get_version(self):
@@ -641,7 +675,11 @@ class BaseMicroscope(ABC):
     def get_indicated_camera_length(self):
         """
         Return (indicated) camera length in meters in diffraction modes.
-        If microscope is in imaging mode, 0 is returned.
+
+        .. note::
+            The scripting manual states, that this function always returns 0,
+            if microscope is in imaging mode. In STEM mode this
+            function works reportedly nevertheless.
 
         .. versionadded:: 1.0.9
         """
@@ -651,7 +689,11 @@ class BaseMicroscope(ABC):
     def get_indicated_magnification(self):
         """
         Return (indicated) magnification in imaging modes.
-        If microscope is in diffraction mode, 0 is returned.
+
+        .. note::
+            The scripting manual states, that this function always returns 0,
+            if microscope is in diffraction mode. In STEM mode this
+            function works reportedly nevertheless.
 
         .. note::
             On Titan 1.1 software this method returns 0.0 regardless of used mode. See :ref:`restrictions`.
@@ -1123,10 +1165,19 @@ class BaseMicroscope(ABC):
 
         .. versionchanged:: 2.0
             The method was renamed from get_optics_state() to get_state()
+
+        .. versionchanged:: 2.2.0
+            Added "instrument_id" and "computer_name" entries.
+
+        .. deprecated:: 2.2.0
+            The "microscope_id" entry is deprecated and will be removed in future versions. It contains the
+            same value as "computer_name", use that entry instead. See :meth:`get_microscope_id`.
         """
         state = {
             "family": self.get_family(),
-            "microscope_id": self.get_microscope_id(),
+            "microscope_id": self.get_computer_name(),
+            "instrument_id": self.get_instrument_id(),
+            "computer_name": self.get_computer_name(),
             "temscript_version": self.get_version(),
             "voltage(kV)": self.get_voltage(),
             "stage_holder": self.get_stage_holder(),
@@ -1174,5 +1225,6 @@ class BaseMicroscope(ABC):
             use :meth:`get_state` instead.
         """
         import warnings
-        warnings.warn("Microscope.get_optics_state() is deprecated. Use get_state() instead.", DeprecationWarning)
+        warnings.warn("Microscope.get_optics_state() is deprecated. Use get_state() instead.",
+                      category=DeprecationWarning, stacklevel=2)
         return self.get_state()

temscript/microscope.py

@@ -1,3 +1,4 @@
+import functools
 import math
 
 from temscript.base_microscope import set_enum_attr_from_dict, set_attr_from_dict
@@ -7,6 +8,27 @@ from .instrument import CCDCamera, GetInstrument, STEMDetector
 from .enums import *
 
 
+# Computer name and instrument ID are properties of the machine, thus cached at module level
+# (and not per instance, which would keep instances alive).
+@functools.lru_cache(maxsize=None)
+def _get_computer_name():
+    import socket
+    return socket.gethostname()
+
+
+@functools.lru_cache(maxsize=None)
+def _get_instrument_id():
+    import winreg
+    try:
+        with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"SOFTWARE\FEI\Configuration") as key:
+            value, value_type = winreg.QueryValueEx(key, "Instrument Key")
+        if value_type == winreg.REG_DWORD and value > 0:
+            return str(value)
+    except OSError:
+        pass  # Missing key/value or access denied.
+    return ""
+
+
 class Microscope(BaseMicroscope):
     """
     Hich level interface to local microscope.
@@ -38,9 +60,11 @@ class Microscope(BaseMicroscope):
     def get_family(self):
         return ProductFamily(self._family).name
 
-    def get_microscope_id(self):
-        import socket
-        return socket.gethostname()
+    def get_computer_name(self):
+        return _get_computer_name()
+
+    def get_instrument_id(self):
+        return _get_instrument_id()
 
     def get_version(self):
         from .version import __version__
@@ -79,7 +103,10 @@ class Microscope(BaseMicroscope):
         self._tem_vacuum.ColumnValvesOpen = state
 
     def get_stage_holder(self):
-        return self._tem_stage.Holder.name
+        try:
+            return self._tem_stage.Holder.name
+        except OSError:
+            return ""
 
     def get_stage_status(self):
         return self._tem_stage.Status.name

temscript/null_microscope.py

@@ -122,10 +122,6 @@ class NullMicroscope(BaseMicroscope):
     def get_family(self):
         return "NULL"
 
-    def get_microscope_id(self):
-        import socket
-        return socket.gethostname()
-
     def get_version(self):
         from .version import __version__
         return __version__

temscript/remote_microscope.py

@@ -130,8 +130,11 @@ class RemoteMicroscope(BaseMicroscope):
     def get_family(self):
         return self._request("GET", "/v1/family")[1]
 
-    def get_microscope_id(self):
-        return self._request("GET", "/v1/microscope_id")[1]
+    def get_computer_name(self):
+        return self._request("GET", "/v1/computer_name")[1]
+
+    def get_instrument_id(self):
+        return self._request("GET", "/v1/instrument_id")[1]
 
     def get_version(self):
         return self._request("GET", "/v1/version")[1]

temscript/server.py

@@ -8,15 +8,15 @@ from .marshall import ExtendedJsonEncoder, gzip_encode, MIME_TYPE_PICKLE, MIME_T
 
 
 class MicroscopeHandler(BaseHTTPRequestHandler):
-    GET_V1_FORWARD = ("family", "microscope_id", "version", "voltage", "vacuum", "stage_holder",
-                      "stage_status", "stage_position", "stage_limits", "detectors", "cameras", "stem_detectors",
-                      "stem_acquisition_param", "image_shift", "beam_shift", "beam_tilt", "projection_sub_mode",
-                      "projection_mode", "projection_mode_string", "magnification_index", "indicated_camera_length",
-                      "indicated_magnification", "defocus", "objective_excitation", "intensity", "objective_stigmator",
-                      "condenser_stigmator", "diffraction_shift", "screen_current", "screen_position",
-                      "illumination_mode", "condenser_mode", "illuminated_area", "probe_defocus", "convergence_angle",
-                      "stem_magnification", "stem_rotation", "spot_size_index", "dark_field_mode", "beam_blanked",
-                      "instrument_mode", 'optics_state', 'state', 'column_valves_open')
+    GET_V1_FORWARD = ("family", "microscope_id", "instrument_id", "computer_name", "version", "voltage", "vacuum",
+                      "stage_holder", "stage_status", "stage_position", "stage_limits", "detectors", "cameras",
+                      "stem_detectors", "stem_acquisition_param", "image_shift", "beam_shift", "beam_tilt",
+                      "projection_sub_mode", "projection_mode", "projection_mode_string", "magnification_index",
+                      "indicated_camera_length", "indicated_magnification", "defocus", "objective_excitation",
+                      "intensity", "objective_stigmator", "condenser_stigmator", "diffraction_shift", "screen_current",
+                      "screen_position", "illumination_mode", "condenser_mode", "illuminated_area", "probe_defocus",
+                      "convergence_angle", "stem_magnification", "stem_rotation", "spot_size_index", "dark_field_mode",
+                      "beam_blanked", "instrument_mode", 'optics_state', 'state', 'column_valves_open')
 
     PUT_V1_FORWARD = ("image_shift", "beam_shift", "beam_tilt", "projection_mode", "magnification_index",
                       "defocus", "intensity", "diffraction_shift", "objective_stigmator", "condenser_stigmator",
@@ -58,7 +58,7 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
             else:
                 content_encoding = None
         except Exception as exc:
-            self.log_error("Exception raised during encoding of response: %s" % repr(exc))
+            self.log_error("Exception raised during encoding of response: %s", repr(exc))
             self.send_error(500, "Error handling request '%s': %s" % (self.path, str(exc)))
         else:
             self.send_response(200)
@@ -146,10 +146,10 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
             else:
                 raise KeyError('Unknown API version: %s' % self.path)
         except KeyError as exc:
-            self.log_error("KeyError raised during handling of GET request '%s': %s" % (self.path, repr(exc)))
+            self.log_error("KeyError raised during handling of GET request '%s': %s", self.path, repr(exc))
             self.send_error(404, str(exc))
         except Exception as exc:
-            self.log_error("Exception raised during handling of GET request '%s': %s" % (self.path, repr(exc)))
+            self.log_error("Exception raised during handling of GET request '%s': %s", self.path, repr(exc))
             self.send_error(500, "Error handling request '%s': %s" % (self.path, str(exc)))
         else:
             self.build_response(response)
@@ -163,10 +163,10 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
             else:
                 raise KeyError('Unknown API version: %s' % self.path)
         except KeyError as exc:
-            self.log_error("KeyError raised during handling of GET request '%s': %s" % (self.path, repr(exc)))
+            self.log_error("KeyError raised during handling of GET request '%s': %s" , self.path, repr(exc))
             self.send_error(404, str(exc))
         except Exception as exc:
-            self.log_error("Exception raised during handling of GET request '%s': %s" % (self.path, repr(exc)))
+            self.log_error("Exception raised during handling of GET request '%s': %s" , self.path, repr(exc))
             self.send_error(500, "Error handling request '%s': %s" % (self.path, str(exc)))
         else:
             self.build_response(response)

temscript/version.py

@@ -1 +1 @@
-__version__ = '2.0.1'
+__version__ = '2.2.0'

{temscript-2.0.1.dist-info → temscript-2.2.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: temscript
-Version: 2.0.1
-Summary: TEM Scripting adapter for FEI microscopes
+Version: 2.2.0
+Summary: TEM Scripting adapter for TFS/FEI transmission electron microscopes
 Home-page: https://github.com/niermann/temscript
 Author: Tore Niermann
 Author-email: tore.niermann@tu-berlin.de
@@ -22,6 +22,19 @@ Requires-Python: >=3.4
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # About
 

temscript-2.2.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+temscript/__init__.py,sha256=j1InqV3AFmU14cUv-Zfk4w6QK7oBGeg8X0GpMZJlG3Y,294
+temscript/_com.py,sha256=-VvCb9w6d3vQsM3iurYBBEJoPyjYUs0tpRqwOSZrI84,12409
+temscript/_instrument_com.py,sha256=rB5hms5viDfzKBXLG3N7Xn5nu82Myi52FF_y8W5x_Ho,25529
+temscript/_instrument_stubs.py,sha256=0YxgDrJCgKUAlIK__xv5GOTxAZn00f3W0ux76tu7BuE,767
+temscript/base_microscope.py,sha256=FYsl3QpE-imuIe2FCb6_aGFD7YFir3i9HPILSC74wZQ,39013
+temscript/enums.py,sha256=meaXlI4tUyYDGWqH8fFD0QYDDmEGbNV7wvPtI5XxXxk,3538
+temscript/instrument.py,sha256=lQhkxgChQmpmmMHxTuihv53up1rtIeCTvOcvC7Hg3K8,158
+temscript/marshall.py,sha256=_PGKOew2lLBVGX0KJ4jDkvD9M3fCRzWLqr57wpv-tZ8,2751
+temscript/microscope.py,sha256=zsnKNZuCSPfYbbpiEvyRc7Bts6iyXDuLdfEg6j1SPpk,16288
+temscript/null_microscope.py,sha256=RxmPOs2y6k8RbyJ6lvMThA5M-uWd05_9Ot8Ng4qTrWk,13524
+temscript/remote_microscope.py,sha256=LIh_hc8aI8QyiQkhrn9WGSyGIa3MoNmw9yXbRamlKTc,13954
+temscript/server.py,sha256=ELrYAvXxZarhNGU1z1OUZo3mHg4ReZXtbxoBWwmC6Ec,11279
+temscript/version.py,sha256=Vyf6P6UCZKFeQtRzYujPmFfdlqSfnc01VEMWE3O0ZrA,22
+temscript-2.2.0.dist-info/licenses/LICENSE,sha256=cq4IrCq4Tl-ygbyclC70cTWpGtcFb7RR_W_QBCKLxz0,1464
+temscript-2.2.0.dist-info/METADATA,sha256=FmQKapDNu2BuZYmexVylm_H0DWdy2POTMKPHPfpRjUo,5642
+temscript-2.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+temscript-2.2.0.dist-info/entry_points.txt,sha256=TXg5cJaCTRRKF4ksl8lKhDincfi26lKt0Kt6L4qF2mY,65
+temscript-2.2.0.dist-info/top_level.txt,sha256=UtLZJUYxHjcTLq03gFBMSX58CtGZ-KebBFOTKyRfKtE,10
+temscript-2.2.0.dist-info/RECORD,,

{temscript-2.0.1.dist-info → temscript-2.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

temscript-2.0.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-temscript/__init__.py,sha256=j1InqV3AFmU14cUv-Zfk4w6QK7oBGeg8X0GpMZJlG3Y,294
-temscript/_com.py,sha256=biWMvsr0JgmiRA6J2qmRxqH6PISwxTemaKpphuug5ng,11615
-temscript/_instrument_com.py,sha256=ymaPuzlLMNiZ9ZdBuubLuqAilNcZ3QZtIZ1mUNdOAUg,25515
-temscript/_instrument_stubs.py,sha256=0YxgDrJCgKUAlIK__xv5GOTxAZn00f3W0ux76tu7BuE,767
-temscript/base_microscope.py,sha256=jxB389Qdf7hsnuJx0Dbon0eZzzCTR4GLW4o1Vz8A_m8,36805
-temscript/enums.py,sha256=meaXlI4tUyYDGWqH8fFD0QYDDmEGbNV7wvPtI5XxXxk,3538
-temscript/instrument.py,sha256=lQhkxgChQmpmmMHxTuihv53up1rtIeCTvOcvC7Hg3K8,158
-temscript/marshall.py,sha256=_PGKOew2lLBVGX0KJ4jDkvD9M3fCRzWLqr57wpv-tZ8,2751
-temscript/microscope.py,sha256=DaG6ozciqV4W70Ts4ceKHe4ME1E9tUFauDpj9J3Lcas,15462
-temscript/null_microscope.py,sha256=kQltb86XD0W5OQZo17E2hFxEPzBW4YC6BSrGsSyT4AI,13616
-temscript/remote_microscope.py,sha256=LgIweN9O_nFZDzqbKRar515x_lHcI-UUyzz4cyW7_iI,13860
-temscript/server.py,sha256=Lv7vrulJTTqsN1T7pnACYoJpHEJNsKWNYFcNt_37qgM,11256
-temscript/version.py,sha256=HVx0XJJ9OYFWBBPBCUFYb8Nm43ChPg9GZLh_dkxh9qI,22
-temscript-2.0.1.dist-info/LICENSE,sha256=cq4IrCq4Tl-ygbyclC70cTWpGtcFb7RR_W_QBCKLxz0,1464
-temscript-2.0.1.dist-info/METADATA,sha256=7J5MysRiPir20o-6GGMuCfEeimyz_wN2tXp23519I10,5341
-temscript-2.0.1.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-temscript-2.0.1.dist-info/entry_points.txt,sha256=TXg5cJaCTRRKF4ksl8lKhDincfi26lKt0Kt6L4qF2mY,65
-temscript-2.0.1.dist-info/top_level.txt,sha256=UtLZJUYxHjcTLq03gFBMSX58CtGZ-KebBFOTKyRfKtE,10
-temscript-2.0.1.dist-info/RECORD,,