Add set_runtime_environment functionality to niscope (#1975)

* Update niscope metadata to add set_runtime_environment functionality

* Update CHANGELOG

Author: ni-jfitzger

CHANGELOG.md

@@ -60,6 +60,7 @@ All notable changes to this project will be documented in this file.
 * ### `niscope` (NI-SCOPE)
     * #### Added
         * `get_channel_names()`
+        * Pass Python interpreter information if the driver runtime version supports it. This is used by NI in order to better understand client usage.
     * #### Changed
         * Fix [#1770](https://github.com/ni/nimi-python/issues/1770): fetch(), read(), and friends return wrong data when called with channel ranges on multi-instrument session.
     * #### Removed

docs/niscope/class.rst

@@ -1916,12 +1916,12 @@ get_channel_names
                 -   A range using a hyphen—for example, "0-3"
                 -   A range using a colon—for example, "0:3 "
 
-                You can combine comma-separated lists and ranges that use a hyphen or colon. Both out-of-order and repeated indices are supported ("2,3,0," "1,2,2,3"). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed between characters. Ranges can be incrementing or decrementing.
+                You can combine comma-separated lists and ranges that use a hyphen or colon. Both out-of-order and repeated indices are supported ("2,3,0", "1,2,2,3"). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed between characters. Ranges can be incrementing or decrementing.
 
                 
 
 
-            :type indices: basic sequence types or str or int
+            :type indices: basic sequence types, str, or int
 
             :rtype: list of str
             :return:

generated/niscope/niscope/_grpc_stub_interpreter.py

@@ -425,6 +425,9 @@ def set_attribute_vi_string(self, channel_list, attribute_id, value):  # noqa: N
             grpc_types.SetAttributeViStringRequest(vi=self._vi, channel_list=channel_list, attribute_id=attribute_id, value_raw=value),
         )
 
+    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/niscope/niscope/_library.py

@@ -80,6 +80,7 @@ def __init__(self, ctypes_library):
         self.niScope_SetAttributeViInt64_cfunc = None
         self.niScope_SetAttributeViReal64_cfunc = None
         self.niScope_SetAttributeViString_cfunc = None
+        self.niScope_SetRuntimeEnvironment_cfunc = None
         self.niScope_UnlockSession_cfunc = None
         self.niScope_close_cfunc = None
         self.niScope_error_message_cfunc = None
@@ -549,6 +550,14 @@ def niScope_SetAttributeViString(self, vi, channel_list, attribute_id, value):
                 self.niScope_SetAttributeViString_cfunc.restype = ViStatus  # noqa: F405
         return self.niScope_SetAttributeViString_cfunc(vi, channel_list, attribute_id, value)
 
+    def niScope_SetRuntimeEnvironment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        with self._func_lock:
+            if self.niScope_SetRuntimeEnvironment_cfunc is None:
+                self.niScope_SetRuntimeEnvironment_cfunc = self._get_library_function('niScope_SetRuntimeEnvironment')
+                self.niScope_SetRuntimeEnvironment_cfunc.argtypes = [ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar)]  # noqa: F405
+                self.niScope_SetRuntimeEnvironment_cfunc.restype = ViStatus  # noqa: F405
+        return self.niScope_SetRuntimeEnvironment_cfunc(environment, environment_version, reserved1, reserved2)
+
     def niScope_UnlockSession(self, vi, caller_has_lock):  # noqa: N802
         with self._func_lock:
             if self.niScope_UnlockSession_cfunc is None:

generated/niscope/niscope/_library_interpreter.py

@@ -4,6 +4,8 @@
 import array
 import ctypes
 import hightime  # noqa: F401
+import platform
+
 import niscope._library_singleton as _library_singleton
 import niscope._visatype as _visatype
 import niscope.enums as enums  # noqa: F401
@@ -14,6 +16,9 @@
 import niscope.measurement_stats as measurement_stats  # noqa: F401
 
 
+_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):
@@ -60,6 +65,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.
@@ -650,6 +670,15 @@ def set_attribute_vi_string(self, channel_list, attribute_id, value):  # noqa: N
         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.niScope_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.niScope_UnlockSession(vi_ctype, None)

generated/niscope/niscope/session.py

@@ -4857,13 +4857,13 @@ def get_channel_names(self, indices):
         Returns a list of channel names for given channel indices.
 
         Args:
-            indices (basic sequence types or str or int): Index list for the channels in the session. Valid values are from zero to the total number of channels in the session minus one. The index string can be one of the following formats:
+            indices (basic sequence types, str, or int): Index list for the channels in the session. Valid values are from zero to the total number of channels in the session minus one. The index string can be one of the following formats:
 
                 -   A comma-separated list—for example, "0,2,3,1"
                 -   A range using a hyphen—for example, "0-3"
                 -   A range using a colon—for example, "0:3 "
 
-                You can combine comma-separated lists and ranges that use a hyphen or colon. Both out-of-order and repeated indices are supported ("2,3,0," "1,2,2,3"). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed between characters. Ranges can be incrementing or decrementing.
+                You can combine comma-separated lists and ranges that use a hyphen or colon. Both out-of-order and repeated indices are supported ("2,3,0", "1,2,2,3"). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed between characters. Ranges can be incrementing or decrementing.
 
 
         Returns:

generated/niscope/niscope/unit_tests/_mock_helper.py

@@ -167,6 +167,8 @@ def __init__(self):
         self._defaults['SetAttributeViReal64']['return'] = 0
         self._defaults['SetAttributeViString'] = {}
         self._defaults['SetAttributeViString']['return'] = 0
+        self._defaults['SetRuntimeEnvironment'] = {}
+        self._defaults['SetRuntimeEnvironment']['return'] = 0
         self._defaults['UnlockSession'] = {}
         self._defaults['UnlockSession']['return'] = 0
         self._defaults['UnlockSession']['callerHasLock'] = None
@@ -781,6 +783,11 @@ def niScope_SetAttributeViString(self, vi, channel_list, attribute_id, value):
             return self._defaults['SetAttributeViString']['return']
         return self._defaults['SetAttributeViString']['return']
 
+    def niScope_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 niScope_UnlockSession(self, vi, caller_has_lock):  # noqa: N802
         if self._defaults['UnlockSession']['return'] != 0:
             return self._defaults['UnlockSession']['return']
@@ -950,6 +957,8 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niScope_SetAttributeViReal64.return_value = 0
         mock_library.niScope_SetAttributeViString.side_effect = MockFunctionCallError("niScope_SetAttributeViString")
         mock_library.niScope_SetAttributeViString.return_value = 0
+        mock_library.niScope_SetRuntimeEnvironment.side_effect = MockFunctionCallError("niScope_SetRuntimeEnvironment")
+        mock_library.niScope_SetRuntimeEnvironment.return_value = 0
         mock_library.niScope_UnlockSession.side_effect = MockFunctionCallError("niScope_UnlockSession")
         mock_library.niScope_UnlockSession.return_value = 0
         mock_library.niScope_close.side_effect = MockFunctionCallError("niScope_close")

src/niscope/metadata/attributes.py

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

src/niscope/metadata/config.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-SCOPE API metadata version 23.1.0f21
+# This file is generated from NI-SCOPE API metadata version 23.5.0d118
 config = {
-    'api_version': '23.1.0f21',
+    'api_version': '23.5.0d118',
     'c_function_prefix': 'niScope_',
     'close_function': 'close',
     'context_manager_name': {

src/niscope/metadata/enums.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-SCOPE API metadata version 23.1.0f21
+# This file is generated from NI-SCOPE API metadata version 23.5.0d118
 enums = {
     '5900AccessoryInAScopeSessionValues': {
         'values': [
@@ -346,13 +346,13 @@
                 'name': 'NISCOPE_VAL_ATTRIBUTE_RETRIEVAL_MODE_COERCED',
                 'value': 0
             },
-            {
-                'name': 'NISCOPE_VAL_ATTRIBUTE_RETRIEVAL_MODE_DEFAULT',
-                'value': 2
-            },
             {
                 'name': 'NISCOPE_VAL_ATTRIBUTE_RETRIEVAL_MODE_DESIRED',
                 'value': 1
+            },
+            {
+                'name': 'NISCOPE_VAL_ATTRIBUTE_RETRIEVAL_MODE_DEFAULT',
+                'value': 2
             }
         ]
     },