Add set_runtime_environment functionality to niswitch (#1976)

* Update niswitch metadata to add set_runtime_environment functionality

* Update CHANGELOG

Author: ni-jfitzger

CHANGELOG.md

@@ -69,6 +69,7 @@ All notable changes to this project will be documented in this file.
     * #### Removed
 * ### `niswitch` (NI-SWITCH)
     * #### 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
 * ### `nise` (NI Switch Executive)

generated/niswitch/niswitch/_grpc_stub_interpreter.py

@@ -276,6 +276,9 @@ def set_path(self, path_list):  # noqa: N802
             grpc_types.SetPathRequest(vi=self._vi, path_list=path_list),
         )
 
+    def set_runtime_environment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        raise NotImplementedError('set_runtime_environment is not supported over gRPC')
+
     def unlock(self):  # noqa: N802
         self._lock.release()
 

generated/niswitch/niswitch/_library.py

@@ -51,6 +51,7 @@ def __init__(self, ctypes_library):
         self.niSwitch_SetAttributeViReal64_cfunc = None
         self.niSwitch_SetAttributeViString_cfunc = None
         self.niSwitch_SetPath_cfunc = None
+        self.niSwitch_SetRuntimeEnvironment_cfunc = None
         self.niSwitch_UnlockSession_cfunc = None
         self.niSwitch_WaitForDebounce_cfunc = None
         self.niSwitch_WaitForScanComplete_cfunc = None
@@ -178,13 +179,13 @@ def niSwitch_GetChannelName(self, vi, index, buffer_size, channel_name_buffer):
                 self.niSwitch_GetChannelName_cfunc.restype = ViStatus  # noqa: F405
         return self.niSwitch_GetChannelName_cfunc(vi, index, buffer_size, channel_name_buffer)
 
-    def niSwitch_GetError(self, vi, code, buffer_size, description):  # noqa: N802
+    def niSwitch_GetError(self, vi, error_code, buffer_size, description):  # noqa: N802
         with self._func_lock:
             if self.niSwitch_GetError_cfunc is None:
                 self.niSwitch_GetError_cfunc = self._get_library_function('niSwitch_GetError')
                 self.niSwitch_GetError_cfunc.argtypes = [ViSession, ctypes.POINTER(ViStatus), ViInt32, ctypes.POINTER(ViChar)]  # noqa: F405
                 self.niSwitch_GetError_cfunc.restype = ViStatus  # noqa: F405
-        return self.niSwitch_GetError_cfunc(vi, code, buffer_size, description)
+        return self.niSwitch_GetError_cfunc(vi, error_code, buffer_size, description)
 
     def niSwitch_GetPath(self, vi, channel1, channel2, buffer_size, path):  # noqa: N802
         with self._func_lock:
@@ -322,6 +323,14 @@ def niSwitch_SetPath(self, vi, path_list):  # noqa: N802
                 self.niSwitch_SetPath_cfunc.restype = ViStatus  # noqa: F405
         return self.niSwitch_SetPath_cfunc(vi, path_list)
 
+    def niSwitch_SetRuntimeEnvironment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        with self._func_lock:
+            if self.niSwitch_SetRuntimeEnvironment_cfunc is None:
+                self.niSwitch_SetRuntimeEnvironment_cfunc = self._get_library_function('niSwitch_SetRuntimeEnvironment')
+                self.niSwitch_SetRuntimeEnvironment_cfunc.argtypes = [ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar)]  # noqa: F405
+                self.niSwitch_SetRuntimeEnvironment_cfunc.restype = ViStatus  # noqa: F405
+        return self.niSwitch_SetRuntimeEnvironment_cfunc(environment, environment_version, reserved1, reserved2)
+
     def niSwitch_UnlockSession(self, vi, caller_has_lock):  # noqa: N802
         with self._func_lock:
             if self.niSwitch_UnlockSession_cfunc is None:

generated/niswitch/niswitch/_library_interpreter.py

@@ -4,12 +4,17 @@
 import array
 import ctypes
 import hightime  # noqa: F401
+import platform
+
 import niswitch._library_singleton as _library_singleton
 import niswitch._visatype as _visatype
 import niswitch.enums as enums  # noqa: F401
 import niswitch.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.
@@ -210,16 +230,16 @@ def get_channel_name(self, index):  # noqa: N802
 
     def get_error(self):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
-        code_ctype = _visatype.ViStatus()  # case S220
+        error_code_ctype = _visatype.ViStatus()  # case S220
         buffer_size_ctype = _visatype.ViInt32()  # case S170
         description_ctype = None  # case C050
-        error_code = self._library.niSwitch_GetError(vi_ctype, None if code_ctype is None else (ctypes.pointer(code_ctype)), buffer_size_ctype, description_ctype)
+        error_code = self._library.niSwitch_GetError(vi_ctype, None if error_code_ctype is None else (ctypes.pointer(error_code_ctype)), buffer_size_ctype, description_ctype)
         errors.handle_error(self, error_code, ignore_warnings=True, is_error_handling=True)
         buffer_size_ctype = _visatype.ViInt32(error_code)  # case S180
         description_ctype = (_visatype.ViChar * buffer_size_ctype.value)()  # case C060
-        error_code = self._library.niSwitch_GetError(vi_ctype, None if code_ctype is None else (ctypes.pointer(code_ctype)), buffer_size_ctype, description_ctype)
+        error_code = self._library.niSwitch_GetError(vi_ctype, None if error_code_ctype is None else (ctypes.pointer(error_code_ctype)), buffer_size_ctype, description_ctype)
         errors.handle_error(self, error_code, ignore_warnings=False, is_error_handling=True)
-        return int(code_ctype.value), description_ctype.value.decode(self._encoding)
+        return int(error_code_ctype.value), description_ctype.value.decode(self._encoding)
 
     def get_path(self, channel1, channel2):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
@@ -368,6 +388,15 @@ def set_path(self, path_list):  # noqa: N802
         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.niSwitch_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 unlock(self):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         error_code = self._library.niSwitch_UnlockSession(vi_ctype, None)

generated/niswitch/niswitch/unit_tests/_mock_helper.py

@@ -52,7 +52,7 @@ def __init__(self):
         self._defaults['GetChannelName']['channelNameBuffer'] = None
         self._defaults['GetError'] = {}
         self._defaults['GetError']['return'] = 0
-        self._defaults['GetError']['code'] = None
+        self._defaults['GetError']['errorCode'] = None
         self._defaults['GetError']['description'] = None
         self._defaults['GetPath'] = {}
         self._defaults['GetPath']['return'] = 0
@@ -94,6 +94,8 @@ def __init__(self):
         self._defaults['SetAttributeViString']['return'] = 0
         self._defaults['SetPath'] = {}
         self._defaults['SetPath']['return'] = 0
+        self._defaults['SetRuntimeEnvironment'] = {}
+        self._defaults['SetRuntimeEnvironment']['return'] = 0
         self._defaults['UnlockSession'] = {}
         self._defaults['UnlockSession']['return'] = 0
         self._defaults['UnlockSession']['callerHasLock'] = None
@@ -221,14 +223,14 @@ def niSwitch_GetChannelName(self, vi, index, buffer_size, channel_name_buffer):
         channel_name_buffer.value = self._defaults['GetChannelName']['channelNameBuffer'].encode('ascii')
         return self._defaults['GetChannelName']['return']
 
-    def niSwitch_GetError(self, vi, code, buffer_size, description):  # noqa: N802
+    def niSwitch_GetError(self, vi, error_code, buffer_size, description):  # noqa: N802
         if self._defaults['GetError']['return'] != 0:
             return self._defaults['GetError']['return']
-        # code
-        if self._defaults['GetError']['code'] is None:
-            raise MockFunctionCallError("niSwitch_GetError", param='code')
-        if code is not None:
-            code.contents.value = self._defaults['GetError']['code']
+        # error_code
+        if self._defaults['GetError']['errorCode'] is None:
+            raise MockFunctionCallError("niSwitch_GetError", param='errorCode')
+        if error_code is not None:
+            error_code.contents.value = self._defaults['GetError']['errorCode']
         # description
         if self._defaults['GetError']['description'] is None:
             raise MockFunctionCallError("niSwitch_GetError", param='description')
@@ -354,6 +356,11 @@ def niSwitch_SetPath(self, vi, path_list):  # noqa: N802
             return self._defaults['SetPath']['return']
         return self._defaults['SetPath']['return']
 
+    def niSwitch_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 niSwitch_UnlockSession(self, vi, caller_has_lock):  # noqa: N802
         if self._defaults['UnlockSession']['return'] != 0:
             return self._defaults['UnlockSession']['return']
@@ -483,6 +490,8 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niSwitch_SetAttributeViString.return_value = 0
         mock_library.niSwitch_SetPath.side_effect = MockFunctionCallError("niSwitch_SetPath")
         mock_library.niSwitch_SetPath.return_value = 0
+        mock_library.niSwitch_SetRuntimeEnvironment.side_effect = MockFunctionCallError("niSwitch_SetRuntimeEnvironment")
+        mock_library.niSwitch_SetRuntimeEnvironment.return_value = 0
         mock_library.niSwitch_UnlockSession.side_effect = MockFunctionCallError("niSwitch_UnlockSession")
         mock_library.niSwitch_UnlockSession.return_value = 0
         mock_library.niSwitch_WaitForDebounce.side_effect = MockFunctionCallError("niSwitch_WaitForDebounce")

src/niswitch/metadata/attributes.py

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

src/niswitch/metadata/config.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-SWITCH API metadata version 23.0.0f167
+# This file is generated from NI-SWITCH API metadata version 23.5.0d149
 config = {
-    'api_version': '23.0.0f167',
+    'api_version': '23.5.0d149',
     'c_function_prefix': 'niSwitch_',
     'close_function': 'close',
     'context_manager_name': {

src/niswitch/metadata/enums.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-SWITCH API metadata version 23.0.0f167
+# This file is generated from NI-SWITCH API metadata version 23.5.0d149
 enums = {
     'CabledModuleScanAdvancedBus': {
         'values': [

src/niswitch/metadata/functions.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-SWITCH API metadata version 23.0.0f167
+# This file is generated from NI-SWITCH API metadata version 23.5.0d149
 functions = {
     'AbortScan': {
         'documentation': {
@@ -482,7 +482,8 @@
                 'documentation': {
                     'description': '\nReturns the error code for the session or execution thread. If you pass\n0 for the Buffer Size, you can pass VI_NULL for this parameter.\n'
                 },
-                'name': 'code',
+                'grpc_name': 'code',
+                'name': 'errorCode',
                 'type': 'ViStatus'
             },
             {
@@ -1115,7 +1116,7 @@
                 },
                 'grpc_name': 'attribute_value_raw',
                 'name': 'attributeValue',
-                'type': 'ViString'
+                'type': 'ViConstString'
             }
         ],
         'returns': 'ViStatus'
@@ -1145,6 +1146,44 @@
         ],
         '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'
+    },
     'UnlockSession': {
         'documentation': {
             'description': '\nThis function releases a lock that you acquired on an instrument session\nusing niSwitch_LockSession. Refer to niSwitch_LockSession for\nadditional information on session locks.\n'