temscript 2.0.0__tar.gz → 2.1.0__tar.gz

{temscript-2.0.0/temscript.egg-info → temscript-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: temscript
-Version: 2.0.0
+Version: 2.1.0
 Summary: TEM Scripting adapter for FEI microscopes
 Home-page: https://github.com/niermann/temscript
 Author: Tore Niermann
@@ -21,6 +21,19 @@ Classifier: Operating System :: OS Independent
 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: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # About
 
@@ -58,7 +71,17 @@ On Windows platforms the package provides the Python wrapper
 to the scripting COM interface. However, trying to instantiate this wrapper
 will fail, if the scripting COM classes are not installed locally.
 
-### Installation from wheels file (using pip)
+### Installation from PyPI (using pip)
+
+This assumes you have connection to the internet. 
+
+Execute from the command line (assuming you have your python interpreter in the path, this might require superuser or 
+administrator privileges):
+    
+    python3 -m pip install --upgrade pip
+    python3 -m pip install temscript
+
+### Offline-Installation from wheels file (using pip)
 
 This assumes you have downloaded the wheels file <downloaded-wheels-file>.whl 
 
@@ -129,5 +152,3 @@ LICENCE.txt file for any details.
 All product and company names are trademarks or registered trademarks of
 their respective holders. Use of them does not imply any affiliation 
 with or endorsement by them. 
-
-

{temscript-2.0.0 → temscript-2.1.0}/README.md

@@ -34,7 +34,17 @@ On Windows platforms the package provides the Python wrapper
 to the scripting COM interface. However, trying to instantiate this wrapper
 will fail, if the scripting COM classes are not installed locally.
 
-### Installation from wheels file (using pip)
+### Installation from PyPI (using pip)
+
+This assumes you have connection to the internet. 
+
+Execute from the command line (assuming you have your python interpreter in the path, this might require superuser or 
+administrator privileges):
+    
+    python3 -m pip install --upgrade pip
+    python3 -m pip install temscript
+
+### Offline-Installation from wheels file (using pip)
 
 This assumes you have downloaded the wheels file <downloaded-wheels-file>.whl 
 

{temscript-2.0.0 → temscript-2.1.0}/docs/changelog.rst

@@ -1,6 +1,19 @@
 Changelog
 =========
 
+Version 2.1.0
+^^^^^^^^^^^^^
+
+* Changed default apartment model to COINIT_APARTMENTTHREADED to increase compatibility with comtypes
+* COM initialization respects setting from sys.coinit_flags
+
+Version 2.0.1
+^^^^^^^^^^^^^
+
+* Added Talos as ProductFamily
+* Added more graceful behavior for unsupported ProductFamily query and unknown future families.
+* Added column valves state to Microscope classes.
+
 Version 2.0.0
 ^^^^^^^^^^^^^
 
@@ -11,7 +24,7 @@ Version 2.0.0
 * Support of the fluorescent screen
 * Separation of STEM detectors and CCD cameras in high level interface
 * Deprecation of the methods 'get_detectors', 'get_detector_param', 'set_detector_params', and 'get_optics_state' of
-'Microscope' and related classes. See docs for further details.
+  'Microscope' and related classes. See docs for further details.
 * Deprecation of the property 'AcqParams' of 'STEMDetector'. See docs for further details.
 * Deprecation of the use of 'speed' and 'method' keywords in position dictionary of the 'set_stage_position' method.
 * Abstract base class for high level interface

{temscript-2.0.0 → temscript-2.1.0}/docs/instrument.rst

@@ -13,6 +13,13 @@ The interface is described in detail in the scripting manual of your microscope
 The manual is your ultimate reference, this documentation will only describe the
 python wrapper to the COM interface.
 
+The COM apartment model will automatically be initialized as ``COINIT_APARTMENTTHREADED``
+(this changed in Version 2.1.0, it was ``COINIT_MULTITHREADED`` before). However, if the
+apartment model was already initialized as ``COINIT_MULTITHREADED`` before `temscript`
+was imported, `temscript` will also work. If you want a specific apartment model, set the
+variable ``sys.coinit_flags`` before importing `temscript`.
+
+
 Enumerations
 ^^^^^^^^^^^^
 

temscript-2.1.0/docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx
+sphinx_rtd_theme
+readthedocs-sphinx-search
+numpy

{temscript-2.0.0 → temscript-2.1.0}/scripts/test_microscope.py

@@ -34,6 +34,7 @@ print("Microscope.get_microscope_id():", microscope.get_microscope_id())
 print("Microscope.get_version():", microscope.get_version())
 print("Microscope.get_voltage():", microscope.get_voltage())
 print("Microscope.get_vacuum():", microscope.get_vacuum())
+print("Microscope.get_column_valves_open():", microscope.get_column_valves_open())
 print("Microscope.get_stage_holder():", microscope.get_stage_holder())
 print("Microscope.get_stage_status():", microscope.get_stage_status())
 print("Microscope.get_stage_limits():", microscope.get_stage_limits())

{temscript-2.0.0 → temscript-2.1.0}/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-2.0.0 → temscript-2.1.0}/temscript/_instrument_com.py

@@ -26,7 +26,7 @@ class LongProperty(BaseProperty):
 
     def __get__(self, obj, objtype=None):
         if self._get_index is None:
-            raise AttributeError("Attribute %sis not readable" % self._name)
+            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(obj.get(), ctypes.byref(result))
@@ -34,7 +34,7 @@ class LongProperty(BaseProperty):
 
     def __set__(self, obj, value):
         if self._put_index is None:
-            raise AttributeError("Attribute %sis not writable" % self._name)
+            raise AttributeError("Attribute %s is not writable" % self._name)
         value = int(value)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_long)(self._put_index, "put_property")
         prototype(obj.get(), value)
@@ -43,7 +43,7 @@ class LongProperty(BaseProperty):
 class VariantBoolProperty(BaseProperty):
     def __get__(self, obj, objtype=None):
         if self._get_index is None:
-            raise AttributeError("Attribute %sis not readable" % self._name)
+            raise AttributeError("Attribute %s is not readable" % self._name)
         result = ctypes.c_short(-1)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._get_index, "get_property")
         prototype(obj.get(), ctypes.byref(result))
@@ -51,7 +51,7 @@ class VariantBoolProperty(BaseProperty):
 
     def __set__(self, obj, value):
         if self._put_index is None:
-            raise AttributeError("Attribute %sis not writable" % self._name)
+            raise AttributeError("Attribute %s is not writable" % self._name)
         bool_value = 0xffff if value else 0x0000
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_short)(self._put_index, "put_property")
         prototype(obj.get(), bool_value)
@@ -60,7 +60,7 @@ class VariantBoolProperty(BaseProperty):
 class DoubleProperty(BaseProperty):
     def __get__(self, obj, objtype=None):
         if self._get_index is None:
-            raise AttributeError("Attribute %sis not readable" % self._name)
+            raise AttributeError("Attribute %s is not readable" % self._name)
         result = ctypes.c_double(-1)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._get_index, "get_property")
         prototype(obj.get(), ctypes.byref(result))
@@ -68,7 +68,7 @@ class DoubleProperty(BaseProperty):
 
     def __set__(self, obj, value):
         if self._put_index is None:
-            raise AttributeError("Attribute %sis not writable" % self._name)
+            raise AttributeError("Attribute %s is not writable" % self._name)
         value = float(value)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_double)(self._put_index, "put_property")
         prototype(obj.get(), value)
@@ -77,7 +77,7 @@ class DoubleProperty(BaseProperty):
 class StringProperty(BaseProperty):
     def __get__(self, obj, objtype=None):
         if self._get_index is None:
-            raise AttributeError("Attribute %sis not readable" % self._name)
+            raise AttributeError("Attribute %s is not readable" % self._name)
         result = BStr()
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._get_index, "get_property")
         prototype(obj.get(), result.byref())
@@ -85,7 +85,7 @@ class StringProperty(BaseProperty):
 
     def __set__(self, obj, value):
         if self._put_index is None:
-            raise AttributeError("Attribute %sis not writable" % self._name)
+            raise AttributeError("Attribute %s is not writable" % self._name)
         value = BStr(str(value))
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._put_index, "put_property")
         prototype(obj.get(), BStr(value).get())
@@ -100,7 +100,7 @@ class EnumProperty(BaseProperty):
 
     def __get__(self, obj, objtype=None):
         if self._get_index is None:
-            raise AttributeError("Attribute %sis not readable" % self._name)
+            raise AttributeError("Attribute %s is not readable" % self._name)
         result = ctypes.c_int(-1)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_void_p)(self._get_index, "get_property")
         prototype(obj.get(), ctypes.byref(result))
@@ -108,7 +108,7 @@ class EnumProperty(BaseProperty):
 
     def __set__(self, obj, value):
         if self._put_index is None:
-            raise AttributeError("Attribute %sis not writable" % self._name)
+            raise AttributeError("Attribute %s is not writable" % self._name)
         value = int(value)
         prototype = ctypes.WINFUNCTYPE(ctypes.HRESULT, ctypes.c_long)(self._put_index, "put_property")
         prototype(obj.get(), value)

{temscript-2.0.0 → temscript-2.1.0}/temscript/base_microscope.py

@@ -18,7 +18,7 @@ def set_attr_from_dict(obj, attr_name, mapping, key, ignore_errors=False):
     If no such *key* is in the dict, nothing is done.
     Any TypeErrors or ValueErrors are silently ignored, if *ignore_errors is set.
 
-    Returns true is *key* was present in *map* and the attribute was successfully set. Otherwise False is returned.
+    Returns true is *key* was present in *map* and the attribute was successfully set. Otherwise, False is returned.
     """
     try:
         value = mapping.pop(key)
@@ -43,7 +43,7 @@ def set_enum_attr_from_dict(obj, attr_name, enum_type, mapping, key, ignore_erro
     If no such *key* is in the dict nothing is done.
     Any TypeErrors or ValueErrors are silently ignored, if *ignore_errors is set.
 
-    Returns true is *key* was present in *map* and the attribute was successfully set. Otherwise False is returned.
+    Returns true is *key* was present in *map* and the attribute was successfully set. Otherwise, False is returned.
     """
     try:
         value = mapping.pop(key)
@@ -73,11 +73,15 @@ STAGE_AXES = frozenset(('x', 'y', 'z', 'a', 'b'))
 
 class BaseMicroscope(ABC):
     """
-    Base class for Microscope classes. Do not use directly.
+    Abstract base class for microscope classes.
+
+    Do not use `BaseMicroscope` directly, instead instantiate
+    one of the subclasses, like :class:`Microscope` or :class:`RemoteMicroscope`. The Subclasses
+    implement all the abstract methods.
     """
     @abstractmethod
     def get_family(self):
-        """Return product family (see :class:`ProductFamily`): "TITAN", "TECNAI", ..."""
+        """Return product family (see :class:`ProductFamily` for values): "TITAN", "TECNAI", ..."""
         raise NotImplementedError
 
     @abstractmethod
@@ -124,6 +128,29 @@ class BaseMicroscope(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def get_column_valves_open(self):
+        """
+        Returns state of the column valves.
+
+        :return: `True`, if column valves are open. `False`, otherwise.
+
+        .. versionadded: 2.1.0
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def set_column_valves_open(self, state):
+        """
+        Set state of the column valves. The column valves are opened, if `True` is passes as *state*
+
+        :param state: `True`, if column valves should be opened. `False`, if they should be closed.
+        :type state: bool
+
+        .. versionadded: 2.0.1
+        """
+        raise NotImplementedError
+
     @abstractmethod
     def get_stage_holder(self):
         """Return holder currently in stage (see :class:`StageHolderType`)"""
@@ -614,7 +641,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
         """
@@ -624,7 +655,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`.

{temscript-2.0.0 → temscript-2.1.0}/temscript/enums.py

@@ -179,8 +179,18 @@ class AcqExposureMode(IntEnum):
 
 
 class ProductFamily(IntEnum):
+    UNDEFINED = -1
     TECNAI = 0
     TITAN = 1
+    TALOS = 2
+    FUTURE_3 = 3    # Future family #3
+    FUTURE_4 = 4    # Future family #4
+    FUTURE_5 = 5    # Future family #5
+    FUTURE_6 = 6    # Future family #6
+    FUTURE_7 = 7    # Future family #7
+    FUTURE_8 = 8    # Future family #8
+    FUTURE_9 = 9    # Future family #9
+    FUTURE_2 = TALOS    # Alias
 
 
 class ScreenPosition(IntEnum):

{temscript-2.0.0 → temscript-2.1.0}/temscript/microscope.py

@@ -30,7 +30,10 @@ class Microscope(BaseMicroscope):
         self._tem_vacuum = tem.Vacuum
         self._tem_camera = tem.Camera
         self._tem_control = tem.InstrumentModeControl
-        self._family = tem.Configuration.ProductFamily
+        try:
+            self._family = tem.Configuration.ProductFamily
+        except Exception:
+            self._family = ProductFamily.UNDEFINED
 
     def get_family(self):
         return ProductFamily(self._family).name
@@ -64,11 +67,17 @@ class Microscope(BaseMicroscope):
                 gauges[name] = g.Pressure
         return {
             "status": VacuumStatus(self._tem_vacuum.Status).name,
-            "column_valves_open": self._tem_vacuum.ColumnValvesOpen,
+            "column_valves_open": self.get_column_valves_open(),
             "pvp_running": self._tem_vacuum.PVPRunning,
             "gauges(Pa)": gauges,
         }
 
+    def get_column_valves_open(self):
+        return self._tem_vacuum.ColumnValvesOpen
+
+    def set_column_valves_open(self, state):
+        self._tem_vacuum.ColumnValvesOpen = state
+
     def get_stage_holder(self):
         return self._tem_stage.Holder.name
 

{temscript-2.0.0 → temscript-2.1.0}/temscript/null_microscope.py

@@ -141,6 +141,12 @@ class NullMicroscope(BaseMicroscope):
             "gauges(Pa)": {},
         }
 
+    def get_column_valves_open(self):
+        return self._column_valves
+
+    def set_column_valves_open(self, state):
+        self._column_valves = bool(state)
+
     def get_stage_holder(self):
         return StageHolderType.SINGLE_TILT.name
 

{temscript-2.0.0 → temscript-2.1.0}/temscript/remote_microscope.py

@@ -142,6 +142,12 @@ class RemoteMicroscope(BaseMicroscope):
     def get_vacuum(self):
         return self._request("GET", "/v1/vacuum")[1]
 
+    def get_column_valves_open(self):
+        return self._request("GET", "/v1/column_valves_open")[1]
+
+    def set_column_valves_open(self, state):
+        self._request_with_json_body("PUT", "/v1/column_valves_open", state)
+
     def get_stage_holder(self):
         return self._request("GET", "/v1/stage_holder")[1]
 

{temscript-2.0.0 → temscript-2.1.0}/temscript/server.py

@@ -16,7 +16,7 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
                       "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')
+                      "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",
@@ -126,6 +126,13 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
             response = self.get_microscope().set_detector_param(name, decoded_content)
         elif endpoint == "normalize":
             self.get_microscope().normalize(decoded_content)
+        elif endpoint == "column_valves_open":
+            state = bool(decoded_content)
+            assert isinstance(self.server, MicroscopeServer)
+            if self.server.allow_column_valves_open or not state:
+                self.get_microscope().set_column_valves_open(state)
+            else:
+                raise ValueError("Opening of column valves is prohibited.")
         else:
             raise KeyError("Unknown endpoint: '%s'" % endpoint)
         return response
@@ -166,17 +173,19 @@ class MicroscopeHandler(BaseHTTPRequestHandler):
 
 
 class MicroscopeServer(HTTPServer, object):
-    def __init__(self, server_address=('', 8080), microscope_factory=None):
+    def __init__(self, server_address=('', 8080), microscope_factory=None, allow_column_valves_open=True):
         """
         Run a microscope server.
 
         :param server_address: (address, port) tuple
         :param microscope_factory: callable creating the BaseMicroscope instance to use
+        :param allow_column_valves_open: Allow remote client to open column valves
         """
         if microscope_factory is None:
             from .microscope import Microscope
             microscope_factory = Microscope
         self.microscope = microscope_factory()
+        self.allow_column_valves_open = allow_column_valves_open
         super(MicroscopeServer, self).__init__(server_address, MicroscopeHandler)
 
 

temscript-2.1.0/temscript/version.py

@@ -0,0 +1 @@
+__version__ = '2.1.0'

{temscript-2.0.0 → temscript-2.1.0/temscript.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: temscript
-Version: 2.0.0
+Version: 2.1.0
 Summary: TEM Scripting adapter for FEI microscopes
 Home-page: https://github.com/niermann/temscript
 Author: Tore Niermann
@@ -21,6 +21,19 @@ Classifier: Operating System :: OS Independent
 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: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # About
 
@@ -58,7 +71,17 @@ On Windows platforms the package provides the Python wrapper
 to the scripting COM interface. However, trying to instantiate this wrapper
 will fail, if the scripting COM classes are not installed locally.
 
-### Installation from wheels file (using pip)
+### Installation from PyPI (using pip)
+
+This assumes you have connection to the internet. 
+
+Execute from the command line (assuming you have your python interpreter in the path, this might require superuser or 
+administrator privileges):
+    
+    python3 -m pip install --upgrade pip
+    python3 -m pip install temscript
+
+### Offline-Installation from wheels file (using pip)
 
 This assumes you have downloaded the wheels file <downloaded-wheels-file>.whl 
 
@@ -129,5 +152,3 @@ LICENCE.txt file for any details.
 All product and company names are trademarks or registered trademarks of
 their respective holders. Use of them does not imply any affiliation 
 with or endorsement by them. 
-
-

{temscript-2.0.0 → temscript-2.1.0}/temscript.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ docs/index.rst
 docs/instrument.rst
 docs/make.bat
 docs/microscope.rst
+docs/requirements.txt
 docs/restrictions.rst
 docs/server.rst
 scripts/run_null_server.py

{temscript-2.0.0 → temscript-2.1.0}/temscript.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 temscript-server = temscript.server:run_server
-

temscript-2.0.0/temscript/version.py

@@ -1 +0,0 @@
-__version__ = '2.0.0'