Add set_runtime_environment functionality to nidigital (#1972)

* Update nidigital metadata to add set_runtime_environment functionality

* Update CHANGELOG

* Fix nidigital unit test failure: set side_effect for for niDigital_SetRuntimeEnvironment

Author: ni-jfitzger

CHANGELOG.md

@@ -43,6 +43,7 @@ All notable changes to this project will be documented in this file.
     * #### Removed
 * ### `nidigital` (NI-Digital Pattern Driver)
     * #### 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
 * ### `nidmm` (NI-DMM)

docs/nidigital/class.rst

@@ -1581,12 +1581,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/nidigital/nidigital/_grpc_stub_interpreter.py

@@ -568,6 +568,9 @@ def set_attribute_vi_string(self, channel_name, attribute, value):  # noqa: N802
             grpc_types.SetAttributeViStringRequest(vi=self._vi, channel_name=channel_name, attribute=attribute, 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 tdr(self, channel_list, apply_offsets):  # noqa: N802
         response = self._invoke(
             self._client.TDR,

generated/nidigital/nidigital/_library.py

@@ -98,6 +98,7 @@ def __init__(self, ctypes_library):
         self.niDigital_SetAttributeViInt64_cfunc = None
         self.niDigital_SetAttributeViReal64_cfunc = None
         self.niDigital_SetAttributeViString_cfunc = None
+        self.niDigital_SetRuntimeEnvironment_cfunc = None
         self.niDigital_TDR_cfunc = None
         self.niDigital_UnloadAllPatterns_cfunc = None
         self.niDigital_UnloadSpecifications_cfunc = None
@@ -737,6 +738,14 @@ def niDigital_SetAttributeViString(self, vi, channel_name, attribute, value):  #
                 self.niDigital_SetAttributeViString_cfunc.restype = ViStatus  # noqa: F405
         return self.niDigital_SetAttributeViString_cfunc(vi, channel_name, attribute, value)
 
+    def niDigital_SetRuntimeEnvironment(self, environment, environment_version, reserved1, reserved2):  # noqa: N802
+        with self._func_lock:
+            if self.niDigital_SetRuntimeEnvironment_cfunc is None:
+                self.niDigital_SetRuntimeEnvironment_cfunc = self._get_library_function('niDigital_SetRuntimeEnvironment')
+                self.niDigital_SetRuntimeEnvironment_cfunc.argtypes = [ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar), ctypes.POINTER(ViChar)]  # noqa: F405
+                self.niDigital_SetRuntimeEnvironment_cfunc.restype = ViStatus  # noqa: F405
+        return self.niDigital_SetRuntimeEnvironment_cfunc(environment, environment_version, reserved1, reserved2)
+
     def niDigital_TDR(self, vi, channel_list, apply_offsets, offsets_buffer_size, offsets, actual_num_offsets):  # noqa: N802
         with self._func_lock:
             if self.niDigital_TDR_cfunc is None:

generated/nidigital/nidigital/_library_interpreter.py

@@ -4,6 +4,8 @@
 import array
 import ctypes
 import hightime  # noqa: F401
+import platform
+
 import nidigital._library_singleton as _library_singleton
 import nidigital._visatype as _visatype
 import nidigital.enums as enums  # noqa: F401
@@ -12,6 +14,9 @@
 import nidigital.history_ram_cycle_information as history_ram_cycle_information  # 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):
@@ -58,6 +63,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.
@@ -870,6 +890,15 @@ def set_attribute_vi_string(self, channel_name, attribute, value):  # 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.niDigital_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 tdr(self, channel_list, apply_offsets):  # noqa: N802
         vi_ctype = _visatype.ViSession(self._vi)  # case S110
         channel_list_ctype = ctypes.create_string_buffer(channel_list.encode(self._encoding))  # case C010

generated/nidigital/nidigital/session.py

@@ -2489,13 +2489,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/nidigital/nidigital/unit_tests/_mock_helper.py

@@ -222,6 +222,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['TDR'] = {}
         self._defaults['TDR']['return'] = 0
         self._defaults['TDR']['actualNumOffsets'] = None
@@ -995,6 +997,11 @@ def niDigital_SetAttributeViString(self, vi, channel_name, attribute, value):  #
             return self._defaults['SetAttributeViString']['return']
         return self._defaults['SetAttributeViString']['return']
 
+    def niDigital_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 niDigital_TDR(self, vi, channel_list, apply_offsets, offsets_buffer_size, offsets, actual_num_offsets):  # noqa: N802
         if self._defaults['TDR']['return'] != 0:
             return self._defaults['TDR']['return']
@@ -1270,6 +1277,8 @@ def set_side_effects_and_return_values(self, mock_library):
         mock_library.niDigital_SetAttributeViReal64.return_value = 0
         mock_library.niDigital_SetAttributeViString.side_effect = MockFunctionCallError("niDigital_SetAttributeViString")
         mock_library.niDigital_SetAttributeViString.return_value = 0
+        mock_library.niDigital_SetRuntimeEnvironment.side_effect = MockFunctionCallError("niDigital_SetRuntimeEnvironment")
+        mock_library.niDigital_SetRuntimeEnvironment.return_value = 0
         mock_library.niDigital_TDR.side_effect = MockFunctionCallError("niDigital_TDR")
         mock_library.niDigital_TDR.return_value = 0
         mock_library.niDigital_UnloadAllPatterns.side_effect = MockFunctionCallError("niDigital_UnloadAllPatterns")

generated/nidigital/nidigital/unit_tests/test_nidigital.py

@@ -39,6 +39,10 @@ def setup_method(self, method):
         self.side_effects_helper = _mock_helper.SideEffectsHelper()
         self.side_effects_helper.set_side_effects_and_return_values(self.patched_library)
 
+        # The side effect must be set for this, because it's called.
+        # No need to set argument values; the method is tested in nifake unit tests, not here.
+        self.patched_library.niDigital_SetRuntimeEnvironment.side_effect = self.side_effects_helper.niDigital_SetRuntimeEnvironment
+
         self.patched_library.niDigital_InitWithOptions.side_effect = self.side_effects_helper.niDigital_InitWithOptions
         self.side_effects_helper['InitWithOptions']['newVi'] = session_id_for_test
 

src/nidigital/metadata/attributes.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-Digital Pattern Driver API metadata version 23.3.0f165
+# This file is generated from NI-Digital Pattern Driver API metadata version 23.5.0d80
 attributes = {
     1050002: {
         'access': 'read-write',

src/nidigital/metadata/config.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-Digital Pattern Driver API metadata version 23.3.0f165
+# This file is generated from NI-Digital Pattern Driver API metadata version 23.5.0d80
 config = {
-    'api_version': '23.3.0f165',
+    'api_version': '23.5.0d80',
     'c_function_prefix': 'niDigital_',
     'close_function': 'close',
     'context_manager_name': {