nidaqmx-python Reports Python as Runtime Environment (#574)

* Add set runtime environment * Address comments
ni · May 7, 2024 · fcc8c13 · fcc8c13
1 parent af9e449
commit fcc8c13
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 4 deletions.
diff --git a/generated/nidaqmx/_base_interpreter.py b/generated/nidaqmx/_base_interpreter.py
@@ -1530,6 +1530,11 @@ def set_read_attribute_uint32(self, task, attribute, value):
     def set_read_attribute_uint64(self, task, attribute, value):
         raise NotImplementedError
 
+    @abc.abstractmethod
+    def set_runtime_environment(
+            self, environment, environment_version, reserved_1, reserved_2):
+        raise NotImplementedError
+
     @abc.abstractmethod
     def set_scale_attribute_double(self, scale_name, attribute, value):
         raise NotImplementedError

diff --git a/generated/nidaqmx/_grpc_interpreter.py b/generated/nidaqmx/_grpc_interpreter.py
@@ -3574,6 +3574,10 @@ def get_error_string(self, error_code):
             _logger.exception('Failed to get error string for error code %d.', error_code)
             return 'Failed to retrieve error description.'
 
+    def set_runtime_environment(
+            self, environment, environment_version, reserved_1, reserved_2):
+        raise NotImplementedError
+
 
 def _assign_numpy_array(numpy_array, grpc_array):
     """

diff --git a/generated/nidaqmx/_library_interpreter.py b/generated/nidaqmx/_library_interpreter.py
@@ -2,6 +2,7 @@
 
 import ctypes
 import logging
+import platform
 import warnings
 from typing import Optional
 
@@ -11,11 +12,12 @@
 from nidaqmx._base_interpreter import BaseEventHandler, BaseInterpreter
 from nidaqmx._lib import lib_importer, ctypes_byte_str, c_bool32, wrapped_ndpointer
 from nidaqmx.error_codes import DAQmxErrors, DAQmxWarnings
-from nidaqmx.errors import DaqError, DaqReadError, DaqWarning, DaqWriteError
+from nidaqmx.errors import DaqError, DaqFunctionNotSupportedError, DaqReadError, DaqWarning, DaqWriteError
 from nidaqmx._lib_time import AbsoluteTime
 
 
 _logger = logging.getLogger(__name__)
+_was_runtime_environment_set = None
 
 
 class LibraryEventHandler(BaseEventHandler):
@@ -43,7 +45,22 @@ class LibraryInterpreter(BaseInterpreter):
     __slots__ = ()
 
     def __init__(self):
-        pass
+        global _was_runtime_environment_set 
+        if _was_runtime_environment_set is None:
+            try:
+                runtime_env = platform.python_implementation()
+                version = platform.python_version()
+                self.set_runtime_environment(
+                    runtime_env,
+                    version,
+                    '',
+                    ''
+                )
+            except DaqFunctionNotSupportedError:
+                pass
+            finally:
+                _was_runtime_environment_set = True
+
 
     def add_cdaq_sync_connection(self, port_list):
         cfunc = lib_importer.windll.DAQmxAddCDAQSyncConnection
@@ -5288,6 +5305,20 @@ def set_read_attribute_uint64(self, task, attribute, value):
             task, attribute, ctypes.c_uint64(value))
         self.check_for_error(error_code)
 
+    def set_runtime_environment(
+            self, environment, environment_version, reserved_1, reserved_2):
+        cfunc = lib_importer.windll.DAQmxSetRuntimeEnvironment
+        if cfunc.argtypes is None:
+            with cfunc.arglock:
+                if cfunc.argtypes is None:
+                    cfunc.argtypes = [
+                        ctypes_byte_str, ctypes_byte_str, ctypes_byte_str,
+                        ctypes_byte_str]
+
+        error_code = cfunc(
+            environment, environment_version, reserved_1, reserved_2)
+        self.check_for_error(error_code)
+
     def set_scale_attribute_double(self, scale_name, attribute, value):
         cfunc = lib_importer.cdll.DAQmxSetScaleAttribute
         if cfunc.argtypes is None:

diff --git a/src/codegen/metadata/functions.py b/src/codegen/metadata/functions.py
@@ -21934,6 +21934,42 @@
         'python_codegen_method': 'CustomCode',
         'returns': 'int32'
     },
+    'SetRuntimeEnvironment': {
+        'calling_convention': 'StdCall',
+        'codegen_method': 'private',
+        'parameters': [
+            {
+                'ctypes_data_type': 'ctypes.c_char_p',
+                'direction': 'in',
+                'name': 'environment',
+                'python_data_type': 'str',
+                'type': 'const char[]'
+            },
+            {
+                'ctypes_data_type': 'ctypes.c_char_p',
+                'direction': 'in',
+                'name': 'environmentVersion',
+                'python_data_type': 'str',
+                'type': 'const char[]'
+            },
+            {
+                'ctypes_data_type': 'ctypes.c_char_p',
+                'direction': 'in',
+                'name': 'reserved1',
+                'python_data_type': 'str',
+                'type': 'const char[]'
+            },
+            {
+                'ctypes_data_type': 'ctypes.c_char_p',
+                'direction': 'in',
+                'name': 'reserved2',
+                'python_data_type': 'str',
+                'type': 'const char[]'
+            }
+        ],
+        'python_codegen_method': 'CustomCode',
+        'returns': 'int32'
+    },
     'SetScaleAttributeDouble': {
         'calling_convention': 'Cdecl',
         'cname': 'DAQmxSetScaleAttribute',

diff --git a/src/codegen/templates/_grpc_interpreter.py.mako b/src/codegen/templates/_grpc_interpreter.py.mako
@@ -224,6 +224,10 @@ class GrpcStubInterpreter(BaseInterpreter):
             _logger.exception('Failed to get error string for error code %d.', error_code)
             return 'Failed to retrieve error description.'
 
+    def set_runtime_environment(
+            self, environment, environment_version, reserved_1, reserved_2):
+        raise NotImplementedError
+
 
 def _assign_numpy_array(numpy_array, grpc_array):
     """

diff --git a/src/codegen/templates/_library_interpreter.py.mako b/src/codegen/templates/_library_interpreter.py.mako
@@ -19,6 +19,7 @@
 
 import ctypes
 import logging
+import platform
 import warnings
 from typing import Optional
 
@@ -28,11 +29,12 @@ from typing import List
 from nidaqmx._base_interpreter import BaseEventHandler, BaseInterpreter
 from nidaqmx._lib import lib_importer, ctypes_byte_str, c_bool32, wrapped_ndpointer
 from nidaqmx.error_codes import DAQmxErrors, DAQmxWarnings
-from nidaqmx.errors import DaqError, DaqReadError, DaqWarning, DaqWriteError
+from nidaqmx.errors import DaqError, DaqFunctionNotSupportedError, DaqReadError, DaqWarning, DaqWriteError
 from nidaqmx._lib_time import AbsoluteTime
 
 
 _logger = logging.getLogger(__name__)
+_was_runtime_environment_set = None
 
 
 class LibraryEventHandler(BaseEventHandler):
@@ -60,7 +62,22 @@ class LibraryInterpreter(BaseInterpreter):
     __slots__ = ()
 
     def __init__(self):
-        pass
+        global _was_runtime_environment_set 
+        if _was_runtime_environment_set is None:
+            try:
+                runtime_env = platform.python_implementation()
+                version = platform.python_version()
+                self.set_runtime_environment(
+                    runtime_env,
+                    version,
+                    '',
+                    ''
+                )
+            except DaqFunctionNotSupportedError:
+                pass
+            finally:
+                _was_runtime_environment_set = True
+
 
 % for func in functions:
 <%

diff --git a/src/codegen/utilities/interpreter_helpers.py b/src/codegen/utilities/interpreter_helpers.py
@@ -66,6 +66,7 @@
 
 GRPC_INTERPRETER_IGNORED_FUNCTIONS = [
     "get_error_string",
+    "set_runtime_environment",
 ]
 
 LIBRARY_INTERPRETER_IGNORED_FUNCTIONS = [