Add set_runtime_environment functionality to nifgen (#1974)

* Update nifgen metadata to add set_runtime_environment functionality

* Update CHANGELOG

Author: ni-jfitzger

CHANGELOG.md

@@ -51,6 +51,7 @@ All notable changes to this project will be documented in this file.
     * #### Removed
 * ### `nifgen` (NI-FGEN)
     * #### Added
+        * Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
     * #### Changed
     * #### Removed
 * ### `nimodinst` (NI-ModInst)

generated/nifgen/nifgen/_grpc_stub_interpreter.py

@@ -447,6 +447,9 @@ def set_named_waveform_next_write_position(self, channel_name, waveform_name, re
             grpc_types.SetNamedWaveformNextWritePositionRequest(vi=self._vi, channel_name=channel_name, waveform_name=waveform_name, relative_to_raw=relative_to.value, offset=offset),
         )
 
+    def set_runtime_environment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        raise NotImplementedError('set_runtime_environment is not supported over gRPC')
+
     def set_waveform_next_write_position(self, channel_name, waveform_handle, relative_to, offset):  # noqa: N802
         self._invoke(
             self._client.SetWaveformNextWritePosition,

generated/nifgen/nifgen/_library.py

@@ -77,6 +77,7 @@ def __init__(self, ctypes_library):
         self.niFgen_SetAttributeViReal64_cfunc = None
         self.niFgen_SetAttributeViString_cfunc = None
         self.niFgen_SetNamedWaveformNextWritePosition_cfunc = None
+        self.niFgen_SetRuntimeEnvironment_cfunc = None
         self.niFgen_SetWaveformNextWritePosition_cfunc = None
         self.niFgen_UnlockSession_cfunc = None
         self.niFgen_WaitUntilDone_cfunc = None
@@ -561,6 +562,14 @@ def niFgen_SetNamedWaveformNextWritePosition(self, vi, channel_name, waveform_na
                 self.niFgen_SetNamedWaveformNextWritePosition_cfunc.restype = ViStatus  # noqa: F405
         return self.niFgen_SetNamedWaveformNextWritePosition_cfunc(vi, channel_name, waveform_name, relative_to, offset)
 
+    def niFgen_SetRuntimeEnvironment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        with self._func_lock:
+            if self.niFgen_SetRuntimeEnvironment_cfunc is None:
+                self.niFgen_SetRuntimeEnvironment_cfunc = self._get_library_function('niFgen_SetRuntimeEnvironment')
+                self.niFgen_SetRuntimeEnvironment_cfunc.argtypes = [ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar)]  # noqa: F405
+                self.niFgen_SetRuntimeEnvironment_cfunc.restype = ViStatus  # noqa: F405
+        return self.niFgen_SetRuntimeEnvironment_cfunc(environment, environment_version, reserved1, reserved2)
+
     def niFgen_SetWaveformNextWritePosition(self, vi, channel_name, waveform_handle, relative_to, offset):  # noqa: N802
         with self._func_lock:
             if self.niFgen_SetWaveformNextWritePosition_cfunc is None:

generated/nifgen/nifgen/_library_interpreter.py

@@ -4,12 +4,17 @@
 import array
 import ctypes
 import hightime  # noqa: F401
+import platform
+
 import nifgen._library_singleton as _library_singleton
 import nifgen._visatype as _visatype
 import nifgen.enums as enums  # noqa: F401
 import nifgen.errors as errors
 
 
+_was_runtime_environment_set = None
+
+
 # Helper functions for creating ctypes needed for calling into the driver DLL
 def _get_ctypes_pointer_for_buffer(value=None, library_type=None, size=None):
     if isinstance(value, array.array):
@@ -56,6 +61,21 @@ class LibraryInterpreter(object):
     def __init__(self, encoding):
         self._encoding = encoding
         self._library = _library_singleton.get()
+        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 errors.DriverTooOldError:
+                pass
+            finally:
+                _was_runtime_environment_set = True
         # Initialize _vi to 0 for now.
         # Session will directly update it once the driver runtime init function has been called and
         # we have a valid session handle.
@@ -616,6 +636,15 @@ def set_named_waveform_next_write_position(self, channel_name, waveform_name, re
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
         return
 
+    def set_runtime_environment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        environment_ctype = ctypes.create_string_buffer(environment.encode(self._encoding))  # case C020
+        environment_version_ctype = ctypes.create_string_buffer(environment_version.encode(self._encoding))  # case C020
+        reserved1_ctype = ctypes.create_string_buffer(reserved1.encode(self._encoding))  # case C020
+        reserved2_ctype = ctypes.create_string_buffer(reserved2.encode(self._encoding))  # case C020
+        error_code = self._library.niFgen_SetRuntimeEnvironment(environment_ctype, environment_version_ctype, reserved1_ctype, reserved2_ctype)
+        errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=False)
+        return
+
     def set_waveform_next_write_position(self, channel_name, waveform_handle, relative_to, offset):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         channel_name_ctype = ctypes.create_string_buffer(channel_name.encode(self._encoding))  # case C010

generated/nifgen/nifgen/unit_tests/_mock_helper.py

@@ -182,6 +182,8 @@ def __init__(self):
         self._defaults['SetAttributeViString']['return'] = 0
         self._defaults['SetNamedWaveformNextWritePosition'] = {}
         self._defaults['SetNamedWaveformNextWritePosition']['return'] = 0
+        self._defaults['SetRuntimeEnvironment'] = {}
+        self._defaults['SetRuntimeEnvironment']['return'] = 0
         self._defaults['SetWaveformNextWritePosition'] = {}
         self._defaults['SetWaveformNextWritePosition']['return'] = 0
         self._defaults['UnlockSession'] = {}
@@ -772,6 +774,11 @@ def niFgen_SetNamedWaveformNextWritePosition(self, vi, channel_name, waveform_na
             return self._defaults['SetNamedWaveformNextWritePosition']['return']
         return self._defaults['SetNamedWaveformNextWritePosition']['return']
 
+    def niFgen_SetRuntimeEnvironment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        if self._defaults['SetRuntimeEnvironment']['return'] != 0:
+            return self._defaults['SetRuntimeEnvironment']['return']
+        return self._defaults['SetRuntimeEnvironment']['return']
+
     def niFgen_SetWaveformNextWritePosition(self, vi, channel_name, waveform_handle, relative_to, offset):  # noqa: N802
         if self._defaults['SetWaveformNextWritePosition']['return'] != 0:
             return self._defaults['SetWaveformNextWritePosition']['return']
@@ -978,6 +985,8 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niFgen_SetAttributeViString.return_value = 0
         mock_library.niFgen_SetNamedWaveformNextWritePosition.side_effect = MockFunctionCallError("niFgen_SetNamedWaveformNextWritePosition")
         mock_library.niFgen_SetNamedWaveformNextWritePosition.return_value = 0
+        mock_library.niFgen_SetRuntimeEnvironment.side_effect = MockFunctionCallError("niFgen_SetRuntimeEnvironment")
+        mock_library.niFgen_SetRuntimeEnvironment.return_value = 0
         mock_library.niFgen_SetWaveformNextWritePosition.side_effect = MockFunctionCallError("niFgen_SetWaveformNextWritePosition")
         mock_library.niFgen_SetWaveformNextWritePosition.return_value = 0
         mock_library.niFgen_UnlockSession.side_effect = MockFunctionCallError("niFgen_UnlockSession")

src/nifgen/metadata/attributes.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-FGEN API metadata version 23.5.0d28
+# This file is generated from NI-FGEN API metadata version 23.5.0d86
 attributes = {
     1050005: {
         'access': 'read-write',

src/nifgen/metadata/config.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-FGEN API metadata version 23.5.0d28
+# This file is generated from NI-FGEN API metadata version 23.5.0d86
 config = {
-    'api_version': '23.5.0d28',
+    'api_version': '23.5.0d86',
     'c_function_prefix': 'niFgen_',
     'close_function': 'close',
     'context_manager_name': {

src/nifgen/metadata/enums.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-FGEN API metadata version 23.5.0d28
+# This file is generated from NI-FGEN API metadata version 23.5.0d86
 enums = {
     'AnalogPath': {
         'values': [

src/nifgen/metadata/functions.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-FGEN API metadata version 23.5.0d28
+# This file is generated from NI-FGEN API metadata version 23.5.0d86
 functions = {
     'AbortGeneration': {
         'documentation': {
@@ -2860,6 +2860,44 @@
         'python_name': 'set_next_write_position',
         'returns': 'ViStatus'
     },
+    'SetRuntimeEnvironment': {
+        'codegen_method': 'private',
+        'documentation': {
+            'description': 'TBD'
+        },
+        'included_in_proto': False,
+        'method_templates': [
+            {
+                'documentation_filename': 'none',
+                'library_interpreter_filename': 'default_method',
+                'method_python_name_suffix': '',
+                'session_filename': 'none'
+            }
+        ],
+        'parameters': [
+            {
+                'direction': 'in',
+                'name': 'environment',
+                'type': 'ViConstString'
+            },
+            {
+                'direction': 'in',
+                'name': 'environmentVersion',
+                'type': 'ViConstString'
+            },
+            {
+                'direction': 'in',
+                'name': 'reserved1',
+                'type': 'ViConstString'
+            },
+            {
+                'direction': 'in',
+                'name': 'reserved2',
+                'type': 'ViConstString'
+            }
+        ],
+        'returns': 'ViStatus'
+    },
     'SetWaveformNextWritePosition': {
         'codegen_method': 'private',
         'documentation': {