pytecplot 1.5.2__py3-none-any.whl

tecplot/tecutil/index_set.py

@@ -0,0 +1,118 @@
+import ctypes
+
+from ctypes import c_size_t, c_void_p, POINTER, cast, pointer
+from textwrap import dedent
+
+from .tecutil_connector import _tecutil_connector, _tecutil
+from .. import constant
+from ..exception import TecplotTypeError
+from .util import flatten_args, Index
+
+class IndexSet(c_void_p):
+    def __init__(self, *numbers):
+        # numbers may be an iterable or a single value
+        super().__init__(_tecutil.SetAlloc(False))
+        self.__iadd__(flatten_args(*numbers))
+
+    @staticmethod
+    def _bind_tecutil():
+        try:
+            _tecutil.handle.tecUtilArgListGetSetByIndex.restype = IndexSet
+        except AttributeError:
+            pass
+        try:
+            _tecutil.handle.tecUtilDataValueGetShareZoneSet.restype = IndexSet
+        except AttributeError:
+            pass
+        try:
+            _tecutil.handle.tecUtilConnectGetShareZoneSet.restype = IndexSet
+        except AttributeError:
+            pass
+
+        if _tecutil_connector.client is not None:
+            _ArgListGetSetByIndex = _tecutil_connector.client.ArgListGetSetByIndex
+            _tecutil_connector.client.ArgListGetSetByIndex = lambda *a, **kw: cast(_ArgListGetSetByIndex(*a, **kw), IndexSet)
+
+            _DataValueGetShareZoneSet = _tecutil_connector.client.DataValueGetShareZoneSet
+            _tecutil_connector.client.DataValueGetShareZoneSet = lambda *a, **kw: cast(_DataValueGetShareZoneSet(*a, **kw), IndexSet)
+
+            _ConnectGetShareZoneSet = _tecutil_connector.client.ConnectGetShareZoneSet
+            _tecutil_connector.client.ConnectGetShareZoneSet = lambda *a, **kw: cast(_ConnectGetShareZoneSet(*a, **kw), IndexSet)
+
+        # tecutil function with output IndexSet pointer argument
+        if not hasattr(_tecutil, '_ZoneGetActiveForFrame'):
+            _tecutil._ZoneGetActiveForFrame = _tecutil.ZoneGetActiveForFrame
+            def ZoneGetActiveForFrame(*a, **kw):
+                success, ptr = _tecutil._ZoneGetActiveForFrame(*a, **kw)
+                if not success:
+                    raise TecplotSystemError()
+                return cast(ptr, IndexSet)
+            _tecutil.ZoneGetActiveForFrame = ZoneGetActiveForFrame
+
+    def __eq__(self, other):
+        if len(self) != len(other):
+            return False
+        for i in self:
+            if i not in other:
+                return False
+        return True
+
+    # data access
+    def __getitem__(self,i):
+        return Index(_tecutil.SetGetMember(self, i + 1) - 1)
+
+    def __len__(self):
+        return _tecutil.SetGetMemberCount(self)
+
+    # string representations
+    def __repr__(self):
+        return 'IndexSet({args})'.format(args=', '.join([str(s) for s in self]))
+
+    def __str__(self):
+        return str(set(self))
+
+    # iterating
+    def __iter__(self):
+        self.current_index = -1
+        self.max_index = len(self)
+        return self
+
+    def __next__(self):
+        self.current_index += 1
+        if self.current_index < self.max_index:
+            return self.__getitem__(self.current_index)
+        else:
+            del self.current_index
+            del self.max_index
+            raise StopIteration()
+
+    # context management
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.dealloc()
+
+    # public methods
+    def __iadd__(self, numbers):
+        for i in numbers:
+            self.append(i)
+        return self
+
+    def append(self, i):
+        if isinstance(i, int):
+            _tecutil.SetAddMember(self, i+1, False)
+        elif hasattr(i, 'index') and isinstance(i.index, int):
+            _tecutil.SetAddMember(self, i.index+1, False)
+        else:
+            msg = dedent('''\
+                Set can only hold integers or objects
+                with an integer attribute named index.
+                failed on input: {} {}''')
+            raise TecplotTypeError(msg.format(type(i),i))
+
+    def clear(self):
+        _tecutil.SetClear(self)
+
+    def dealloc(self):
+        _tecutil.SetDealloc(pointer(self))

tecplot/tecutil/lock.py

@@ -0,0 +1,36 @@
+import contextlib
+import functools
+import sys
+
+from .tecutil_connector import _tecutil_connector, _tecutil
+
+
+@contextlib.contextmanager
+def lock(with_recording=True):
+    """
+    ParentLockStart takes a boolean: ShutdownImplicitRecording
+    ShutdownImplicitRecording = True -> No recording
+    ShutdownImplicitRecording = False -> With Recording
+    """
+    lock.FORCE_RECORDING = getattr(lock, 'FORCE_RECORDING', False)
+    if _tecutil_connector.connected:
+        yield
+    else:
+        _tecutil.ParentLockStart(not (with_recording or lock.FORCE_RECORDING))
+        try:
+            yield
+        finally:
+            _tecutil.handle.tecUtilParentLockFinish()
+
+
+@contextlib.contextmanager
+def force_recording():
+    """Do not disable implicit recording when locking the engine."""
+    if lock.FORCE_RECORDING:
+        yield
+    else:
+        try:
+            lock.FORCE_RECORDING = True
+            yield
+        finally:
+            lock.FORCE_RECORDING = False

tecplot/tecutil/message_pb2.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: message.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rmessage.proto\x12\x06tecrpc\"\xac\x04\n\x08\x41rgument\x12+\n\x04type\x18\x01 \x01(\x0e\x32\x1d.tecrpc.Argument.ArgumentType\x12\x11\n\x07\x62oolean\x18\x02 \x01(\x08H\x00\x12\x0f\n\x05int32\x18\x03 \x01(\x11H\x00\x12\x10\n\x06uint32\x18\x04 \x01(\rH\x00\x12\x0f\n\x05int64\x18\x05 \x01(\x12H\x00\x12\x10\n\x06uint64\x18\x06 \x01(\x04H\x00\x12\x11\n\x07\x66loat32\x18\x07 \x01(\x02H\x00\x12\x11\n\x07\x66loat64\x18\x08 \x01(\x01H\x00\x12\x0e\n\x04text\x18\t \x01(\tH\x00\x12\x10\n\x06\x62uffer\x18\n \x01(\x0cH\x00\x12\'\n\x07\x61rglist\x18\x0b \x01(\x0b\x32\x14.tecrpc.ArgListItemsH\x00\"\x9f\x02\n\x0c\x41rgumentType\x12\x0f\n\x0bUnspecified\x10\x00\x12\x08\n\x04Null\x10\x01\x12\x0b\n\x07\x41\x64\x64ress\x10\x02\x12\t\n\x05\x41rray\x10\x04\x12\x08\n\x04\x42ool\x10\x08\x12\x08\n\x04Text\x10\x10\x12\x08\n\x04Int8\x10 \x12\t\n\x05UInt8\x10@\x12\n\n\x05Int16\x10\x80\x01\x12\x0b\n\x06UInt16\x10\x80\x02\x12\n\n\x05Int32\x10\x80\x04\x12\x0b\n\x06UInt32\x10\x80\x08\x12\n\n\x05Int64\x10\x80\x10\x12\x0b\n\x06UInt64\x10\x80 \x12\x0c\n\x07\x46loat32\x10\x80@\x12\r\n\x07\x46loat64\x10\x80\x80\x01\x12\n\n\x04\x45num\x10\x80\x80\x02\x12\x10\n\nStringList\x10\x80\x80\x04\x12\x0e\n\x08IndexSet\x10\x80\x80\x08\x12\x0e\n\x08\x41rbParam\x10\x80\x80\x10\x12\r\n\x07\x41rgList\x10\x80\x80 B\x07\n\x05value\"2\n\x0c\x41rgListItems\x12\"\n\x05items\x18\x01 \x03(\x0b\x32\x13.tecrpc.ArgListItem\";\n\x0b\x41rgListItem\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1f\n\x05value\x18\x02 \x01(\x0b\x32\x10.tecrpc.Argument\"\xd9\x01\n\x07Request\x12\x0f\n\x07version\x18\x02 \x01(\r\x12+\n\x04type\x18\x03 \x01(\x0e\x32\x1d.tecrpc.Request.OperationType\x12\x11\n\toperation\x18\x04 \x01(\t\x12\x1e\n\x04\x61rgs\x18\x05 \x03(\x0b\x32\x10.tecrpc.Argument\"W\n\rOperationType\x12\x0b\n\x07TecUtil\x10\x00\x12\r\n\tImmediate\x10\x01\x12\x10\n\x0cLockRequired\x10\x02\x12\n\n\x06Server\x10\x04\x12\x0c\n\x08TecUtilX\x10\x08J\x04\x08\x01\x10\x02\"\xa8\x01\n\x05Reply\x12\x0f\n\x07version\x18\x02 \x01(\r\x12$\n\x06status\x18\x03 \x01(\x0e\x32\x14.tecrpc.Reply.Status\x12\x0b\n\x03log\x18\x04 \x01(\t\x12\x11\n\tlog_level\x18\x05 \x01(\r\x12\x1e\n\x04\x61rgs\x18\x06 \x03(\x0b\x32\x10.tecrpc.Argument\"\"\n\x06Status\x12\x0b\n\x07Success\x10\x00\x12\x0b\n\x07\x46\x61ilure\x10\x01J\x04\x08\x01\x10\x02\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'message_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _ARGUMENT._serialized_start=26
+  _ARGUMENT._serialized_end=582
+  _ARGUMENT_ARGUMENTTYPE._serialized_start=286
+  _ARGUMENT_ARGUMENTTYPE._serialized_end=573
+  _ARGLISTITEMS._serialized_start=584
+  _ARGLISTITEMS._serialized_end=634
+  _ARGLISTITEM._serialized_start=636
+  _ARGLISTITEM._serialized_end=695
+  _REQUEST._serialized_start=698
+  _REQUEST._serialized_end=915
+  _REQUEST_OPERATIONTYPE._serialized_start=822
+  _REQUEST_OPERATIONTYPE._serialized_end=909
+  _REPLY._serialized_start=918
+  _REPLY._serialized_end=1086
+  _REPLY_STATUS._serialized_start=1046
+  _REPLY_STATUS._serialized_end=1080
+# @@protoc_insertion_point(module_scope)

tecplot/tecutil/preamble.py

@@ -0,0 +1,54 @@
+import functools
+import logging
+
+from ..exception import *
+
+
+def tecutil_preamble(fn):
+    """Wrapper for all calls into the TecUtil layer.
+
+    This wrapper shows up as a decorator for all TecUtil functions. It first
+    ensures a valid license is acquired and clears any previous error messages
+    cached by the `_TecUtilConnector` class. After calling the actual function,
+    the `_connector.last_message` object is updated and checked. Internal
+    assertions will have a level of `logging.CRITICAL` and will be raised as
+    `TecplotLogicError` exceptions. Other messages that normally go through
+    dialogs are also checked (when `__debug__` is `True`) and errors will
+    trigger an exception, but warnings and informational messages are merely
+    logged (with the appropriate level).
+    """
+    @functools.wraps(fn)
+    def _fn(self, *a, **kw):
+        if __debug__:
+            self.connector._tecutil_call_count[fn.__name__] += 1
+        if self.connector.connected:
+            client = self.connector.client
+            result = getattr(client, fn.__name__)(*a, **kw)
+        else:
+            try:
+                self.connector.clear_last_message()
+                self.connector.acquire_license()
+                result = fn(self, *a, **kw)
+            except TecplotInitializationError:
+                raise
+            except:
+                lastmsg = self.connector.update_last_message()
+                if lastmsg:
+                    if lastmsg.level < logging.ERROR:
+                        self.connector.log_last_message()
+                        raise
+                    else:
+                        raise TecplotLogicError(lastmsg.message)
+                else:
+                    raise
+            else:
+                lastmsg = self.connector.update_last_message()
+                if lastmsg:
+                    if lastmsg.level < logging.ERROR:
+                        if __debug__:
+                            self.connector.log_last_message()
+                        pass
+                    else:
+                        raise TecplotLogicError(lastmsg.message)
+        return result
+    return _fn

tecplot/tecutil/stringlist.py

@@ -0,0 +1,114 @@
+import copy
+import logging
+
+from ctypes import c_void_p, cast, pointer
+
+from .tecutil_connector import _tecutil_connector, _tecutil
+from .util import flatten_args
+from .. import constant
+from ..exception import TecplotTypeError
+
+
+log = logging.getLogger(__name__)
+
+
+class StringList(c_void_p):
+    def __init__(self, *strings):
+        super().__init__(_tecutil.StringListAlloc())
+        self += flatten_args(*filter(lambda x: x, strings))
+
+    @staticmethod
+    def _bind_tecutil():
+        try:
+            _tecutil.handle.tecUtilArgListGetStringListByIndex.restype = StringList
+        except AttributeError:
+            pass
+
+        if _tecutil_connector.client is not None:
+            _ArgListGetStringListByIndex = _tecutil_connector.client.ArgListGetStringListByIndex
+            def ArgListGetStringListByIndex(*a, **kw):
+                return cast(_ArgListGetStringListByIndex(*a, **kw), StringList)
+            _tecutil_connector.client.ArgListGetStringListByIndex = ArgListGetStringListByIndex
+
+        if not hasattr(_tecutil, '_CustomLabelsGet'):
+            _tecutil._CustomLabelsGet = _tecutil.CustomLabelsGet
+            def CustomLabelsGet(*a, **kw):
+                success, ptr = _tecutil._CustomLabelsGet(*a, **kw)
+                if not success:
+                    raise TecplotSystemError()
+                return cast(ptr, StringList)
+            _tecutil.CustomLabelsGet = CustomLabelsGet
+
+    # data access
+    def __getitem__(self,i):
+        return _tecutil.StringListGetRawStringPtr(self, i+1)
+
+    def __len__(self):
+        return _tecutil.StringListGetCount(self)
+
+    def __eq__(self, other):
+        if len(self) != len(other):
+            return False
+        for i in self:
+            if i not in other:
+                return False
+        return True
+
+    # string representations
+    def __repr__(self):
+        return 'StringList({args})'.format(args=', '.join("'{arg}'".format(arg=s) for s in self))
+
+    def __str__(self):
+        return str(list(self))
+
+    # iterating
+    def __iter__(self):
+        obj = copy.copy(self) if hasattr(self, 'current_index') else self
+        obj.current_index = -1
+        obj.max_index = len(self)
+        obj.iter_items = _tecutil.StringListToNLString(obj).split('\n')
+        if len(obj.iter_items) != obj.max_index:
+            del obj.iter_items
+        return obj
+
+    def __next__(self):
+        self.current_index += 1
+        if self.current_index < self.max_index:
+            try:
+                return self.iter_items[self.current_index]
+            except (AttributeError, IndexError):
+                return self.__getitem__(self.current_index)
+        else:
+            del self.current_index
+            del self.max_index
+            try:
+                delattr(self, 'iter_items')
+            except AttributeError:
+                pass
+            raise StopIteration()
+
+    # context management
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.dealloc()
+
+    # public methods
+    def __iadd__(self, string_list):
+        for s in string_list:
+            self.append(s)
+        return self
+
+    def append(self,s):
+        if not isinstance(s, str):
+            raise TecplotTypeError('StringList can only hold strings')
+        if hasattr(self, 'current_index'):
+            raise TecplotLogicError('Cannot append to StringList while iterating over it')
+        _tecutil.StringListAppendString(self, s)
+
+    def clear(self):
+        _tecutil.StringListClear(self)
+
+    def dealloc(self):
+        _tecutil.StringListDealloc(pointer(self))