Users/abhising/accomodateg rpc final changes

build/helper/codegen_helper.py

@@ -192,9 +192,9 @@ def get_library_interpreter_method_return_snippet(parameters, config, use_numpy_
     return ('return ' + ', '.join(snippets)).strip()
 
 
-def get_grpc_interpreter_method_return_snippet(parameters, config):
+def get_grpc_interpreter_method_return_snippet(parameters, config, use_numpy_array=False):
     '''Returns a string suitable to use as the return argument of a _gprc.LibraryInterpreter method'''
-    parameters_to_use = filter_parameters(parameters, ParameterUsageOptions.API_OUTPUT_PARAMETERS)
+    parameters_to_use = filter_parameters(parameters, ParameterUsageOptions.API_NUMPY_OUTPUT_PARAMETERS if use_numpy_array else ParameterUsageOptions.API_OUTPUT_PARAMETERS)
     snippets = [_get_grpc_interpreter_output_param_return_snippet(p, parameters, config) for p in parameters_to_use]
     return ('return ' + ', '.join(snippets)).strip()
 
@@ -370,6 +370,8 @@ def _get_ctype_variable_definition_snippet_for_scalar(parameter, parameters, ivi
             # This is used for complex waveforms, where the real and imaginary parts are interleaved in the array.
             if corresponding_buffer_parameters[0]['complex_type'] == 'interleaved':
                 definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}) // 2)  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
+            elif corresponding_buffer_parameters[0]['complex_type'] == 'ndim-numpy':
+                definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else {2}.size)  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
             else:
                 definitions.append(parameter['ctypes_variable_name'] + ' = {0}.{1}(0 if {2} is None else len({2}))  # case S160'.format(module_name, parameter['ctypes_type'], corresponding_buffer_parameters[0]['python_name']))
         else:

build/helper/metadata_filters.py

@@ -348,23 +348,31 @@ def filter_parameters(parameters, parameter_usage_options):
     parameters_to_use = []
 
     # Filter based on options
-    size_parameter = None
+    ivi_dance_size_parameter = None
+    len_size_parameter_names = set()
     size_twist_parameter = None
     # If we are being called looking for the ivi-dance, len or code param, we do not care about the size param so we do
     #  not call back into ourselves, to avoid infinite recursion
     if parameter_usage_options not in [ParameterUsageOptions.IVI_DANCE_PARAMETER, ParameterUsageOptions.LEN_PARAMETER]:
-        # Find the size parameter - we are assuming there can only be one type, either from ivi-dance or len
-        size_parameter = find_size_parameter(filter_ivi_dance_parameters(parameters), parameters)
-        if size_parameter is None:
-            size_parameter = find_size_parameter(filter_len_parameters(parameters), parameters)
+        # Determine any size parameters that should be skipped based on the presence of ivi-dance or len-sized buffers.
+        # For ivi-dance, there is a single shared size parameter; for len, there may be multiple independent size parameters.
+        ivi_dance_size_parameter = find_size_parameter(filter_ivi_dance_parameters(parameters), parameters)
+        # Collect all size parameter names referenced by len-sized parameters
+        len_params = filter_len_parameters(parameters)
+        for p in len_params:
+            sp = find_size_parameter(p, parameters)
+            if sp is not None:
+                len_size_parameter_names.add(sp['name'])
         size_twist_parameter = find_size_parameter(filter_ivi_dance_twist_parameters(parameters), parameters, key='value_twist')
     for x in parameters:
         skip = False
         if x['direction'] == 'out' and options_to_use['skip_output_parameters']:
             skip = True
         if x['direction'] == 'in' and options_to_use['skip_input_parameters']:
             skip = True
-        if x == size_parameter and options_to_use['skip_size_parameter']:
+        if ivi_dance_size_parameter is not None and x == ivi_dance_size_parameter and options_to_use['skip_size_parameter']:
+            skip = True
+        if len_size_parameter_names and x['name'] in len_size_parameter_names and options_to_use['skip_size_parameter']:
             skip = True
         if size_twist_parameter is not None and x == size_twist_parameter and options_to_use['skip_size_parameter']:
             skip = True
@@ -443,18 +451,15 @@ def filter_ivi_dance_twist_parameters(parameters):
 def filter_len_parameters(parameters):
     '''Returns the len parameters of a session method if there are any. These are the parameters whose size is determined at runtime using the value of a different parameter.
 
-    asserts all parameters that use len reference the same parameter
+    Note: Multiple len parameters may reference different size parameters.
     Args:
         parameters: parameters to be checked
 
     Return:
-        None if no len parameter found
-        Parameters dict if one is found
+        Empty list if no len parameter found
+        List of parameters if any are found
     '''
     params = filter_parameters(parameters, ParameterUsageOptions.LEN_PARAMETER)
-    if len(params) > 0:
-        size_param = params[0]['size']['value']
-        assert all(x['size']['value'] == size_param for x in params)
     return params
 
 

build/templates/_grpc_stub_interpreter.py.mako

@@ -21,7 +21,12 @@ from . import enums as enums  # noqa: F401
 from . import errors as errors
 from . import ${proto_name}_pb2 as grpc_types
 from . import ${proto_name}_pb2_grpc as ${module_name}_grpc
+% if 'restricted_proto' in config:
+from . import ${config['restricted_proto']}_pb2 as restricted_grpc_types
+from . import ${config['restricted_proto']}_pb2_grpc as restricted_grpc
+% endif
 from . import session_pb2 as session_grpc_types
+from . import nidevice_pb2 as grpc_complex_types
 % for c in config['custom_types']:
 
 from . import ${c['file_name']} as ${c['file_name']}  # noqa: F401
@@ -35,6 +40,9 @@ class GrpcStubInterpreter(object):
         self._grpc_options = grpc_options
         self._lock = threading.RLock()
         self._client = ${module_name}_grpc.${service_class_prefix}Stub(grpc_options.grpc_channel)
+% if 'restricted_proto' in config:
+        self._restricted_client = restricted_grpc.${service_class_prefix}RestrictedStub(grpc_options.grpc_channel)
+% endif
         self.set_session_handle()
 
     def set_session_handle(self, value=session_grpc_types.Session()):
@@ -87,7 +95,13 @@ class GrpcStubInterpreter(object):
 % for func_name in sorted(functions):
 % for method_template in functions[func_name]['method_templates']:
 % if method_template['library_interpreter_filename'] != '/none':
-<%include file="${'/_grpc_stub_interpreter.py' + method_template['library_interpreter_filename'] + '.py.mako'}" args="f=functions[func_name], config=config, method_template=method_template" />\
+<%
+# Determine which grpc types and client to use for this function
+f = functions[func_name]
+grpc_types_var = 'restricted_grpc_types' if f.get('grpc_type') == 'restricted' else 'grpc_types'
+grpc_client_var = 'restricted_grpc' if f.get('grpc_type') == 'restricted' else module_name + '_grpc'
+%>
+<%include file="${'/_grpc_stub_interpreter.py' + method_template['library_interpreter_filename'] + '.py.mako'}" args="f=f, config=config, method_template=method_template, grpc_types_var=grpc_types_var, grpc_client_var=grpc_client_var" />\
 % endif
 % endfor
 % endfor

build/templates/_grpc_stub_interpreter.py/default_method.py.mako

@@ -1,4 +1,4 @@
-<%page args="f, config, method_template"/>\
+<%page args="f, config, method_template, grpc_types_var, grpc_client_var"/>\
 <%
     '''Renders a GrpcStubInterpreter method corresponding to the passed-in function metadata.'''
     import build.helper as helper
@@ -10,14 +10,15 @@
     if return_statement == 'return':
         return_statement = None
     capture_response = 'response = ' if return_statement else ''
+    client = 'self._restricted_client' if grpc_client_var == 'restricted_grpc' else 'self._client'
     included_in_proto = f.get('included_in_proto', True)
 %>\
 
     def ${full_func_name}(${method_decl_params}):  # noqa: N802
 % if included_in_proto:
         ${capture_response}self._invoke(
-            self._client.${grpc_name},
-            grpc_types.${grpc_name}Request(${grpc_request_args}),
+            ${client}.${grpc_name},
+            ${grpc_types_var}.${grpc_name}Request(${grpc_request_args}),
         )
 % if return_statement:
         ${return_statement}

build/templates/_grpc_stub_interpreter.py/initialization_method.py.mako

@@ -1,4 +1,4 @@
-<%page args="f, config, method_template"/>\
+<%page args="f, config, method_template, grpc_types_var, grpc_client_var"/>\
 <%
     '''Renders a GrpcStubInterpreter initialization method, adding proto-specific fields to the passed-in function metadata.'''
 

build/templates/_grpc_stub_interpreter.py/lock.py.mako

@@ -1,4 +1,4 @@
-<%page args="f, config, method_template"/>\
+<%page args="f, config, method_template, grpc_types_var, grpc_client_var"/>\
 <%
     import build.helper as helper
 

build/templates/_grpc_stub_interpreter.py/numpy_read_method.py.mako

@@ -9,4 +9,4 @@
 %>\
 
     def ${full_func_name}(${method_decl_params}):  # noqa: N802
-        raise NotImplementedError('numpy-specific methods are not supported over gRPC')
+        raise NotImplementedError('numpy-specific methods are not supported over gRPC')

build/templates/_grpc_stub_interpreter.py/numpy_write_method.py.mako

@@ -1,3 +1,3 @@
 <%page args="f, config, method_template"/>\
 ## numpy_read and numpy_write are identical for gRPC -- both return a NotImplementedError
-<%include file="/_grpc_stub_interpreter.py/numpy_read_method.py.mako" args="f=f, config=config, method_template=method_template" />\
+<%include file="/_grpc_stub_interpreter.py/numpy_read_method.py.mako" args="f=f, config=config, method_template=method_template" />\

build/templates/_grpc_stub_interpreter.py/unlock.py.mako

@@ -1,4 +1,4 @@
-<%page args="f, config, method_template"/>\
+<%page args="f, config, method_template, grpc_types_var, grpc_client_var"/>\
 <%
     import build.helper as helper
 

build/templates/_library_interpreter.py/default_method.py.mako

@@ -11,8 +11,7 @@
     ivi_dance_parameters = helper.filter_ivi_dance_parameters(parameters)
     ivi_dance_size_parameter = helper.find_size_parameter(ivi_dance_parameters, parameters)
     len_parameters = helper.filter_len_parameters(parameters)
-    len_size_parameter = helper.find_size_parameter(len_parameters, parameters)
-    assert ivi_dance_size_parameter is None or len_size_parameter is None
+    assert ivi_dance_size_parameter is None or len(len_parameters) == 0
 
     full_func_name = f['interpreter_name'] + method_template['method_python_name_suffix']
     c_func_name = config['c_function_prefix'] + f['name']

build/templates/_library_interpreter.py/initialization_method.py.mako

@@ -12,8 +12,7 @@
     ivi_dance_parameters = helper.filter_ivi_dance_parameters(parameters)
     ivi_dance_size_parameter = helper.find_size_parameter(ivi_dance_parameters, parameters)
     len_parameters = helper.filter_len_parameters(parameters)
-    len_size_parameter = helper.find_size_parameter(len_parameters, parameters)
-    assert ivi_dance_size_parameter is None or len_size_parameter is None
+    assert ivi_dance_size_parameter is None or len(len_parameters) == 0
 
     full_func_name = f['interpreter_name'] + method_template['method_python_name_suffix']
     c_func_name = config['c_function_prefix'] + f['name']

docs/nirfsg/class.rst

@@ -3,7 +3,7 @@
 Session
 =======
 
-.. py:class:: Session(self, resource_name, id_query=False, reset_device=False, options={})
+.. py:class:: Session(self, resource_name, id_query=False, reset_device=False, options={}, *, grpc_options=None)
 
 
 
@@ -111,6 +111,16 @@ Session
 
     :type options: dict
 
+    :param grpc_options:
+
+
+        MeasurementLink gRPC session options
+
+
+
+
+    :type grpc_options: nirfsg.GrpcSessionOptions
+
 
 Methods
 =======
@@ -1679,7 +1689,7 @@ get_deembedding_sparameters
 
     .. py:currentmodule:: nirfsg.Session
 
-    .. py:method:: get_deembedding_sparameters()
+    .. py:method:: get_deembedding_sparameters(sparameters_array_size)
 
             Returns the S-parameters used for de-embedding a measurement on the selected port.
 
@@ -1695,15 +1705,46 @@ get_deembedding_sparameters
 
 
 
-            :rtype: numpy.array(dtype=numpy.complex128)
-            :return:
+            :param sparameters_array_size:
+
+
+                Specifies the size of the array that is returned by the :py:attr:`nirfsg.Session.SPARAMETERS` output.
+
+
+
+                .. note:: One or more of the referenced properties are not in the Python API for this driver.
+
+
+            :type sparameters_array_size: int
+
+            :rtype: tuple (sparameters, number_of_sparameters, number_of_ports)
+
+                WHERE
+
+                sparameters (numpy.array(dtype=numpy.complex128)): 
 
 
                     Returns an array of S-parameters. The S-parameters are returned in the following order: s11, s12, s21, s22.
 
 
 
 
+                number_of_sparameters (int): 
+
+
+                    Returns the number of S-parameters.
+
+
+
+
+                number_of_ports (int): 
+
+
+                    Returns the number of S-parameter ports. The **sparameter** array is always *n* x *n*, where span *n* is the number of ports.
+
+
+
+
 
 get_error
 ---------

docs/nirfsg/errors.rst

@@ -77,6 +77,16 @@ SelfTestError
         An error due to a failed self-test
 
 
+RpcError
+--------
+
+    .. py:currentmodule:: nirfsg.errors
+
+    .. exception:: RpcError
+
+        An error specific to sessions to the NI gRPC Device Server
+
+
 DriverWarning
 -------------
 

docs/nirfsg/grpc_session_options.rst

@@ -0,0 +1,91 @@
+gRPC Support
+============
+
+Support for using NI-RFSG over gRPC
+
+.. py:currentmodule:: nirfsg
+
+
+
+SessionInitializationBehavior
+-----------------------------
+
+.. py:class:: SessionInitializationBehavior
+
+    .. py:attribute:: SessionInitializationBehavior.AUTO
+
+
+        The NI gRPC Device Server will attach to an existing session with the specified name if it exists,
+        otherwise the server will initialize a new session.
+
+        .. note:: When using the Session as a context manager and the context exits, the behavior depends on what happened when the constructor
+            was called. If it resulted in a new session being initialized on the NI gRPC Device Server, then it will automatically close the
+            server session. If it instead attached to an existing session, then it will detach from the server session and leave it open.
+
+
+    .. py:attribute:: SessionInitializationBehavior.INITIALIZE_SERVER_SESSION
+
+
+        Require the NI gRPC Device Server to initialize a new session with the specified name.
+
+        .. note:: When using the Session as a context manager and the context exits, it will automatically close the
+            server session.
+
+
+    .. py:attribute:: SessionInitializationBehavior.ATTACH_TO_SERVER_SESSION
+
+
+        Require the NI gRPC Device Server to attach to an existing session with the specified name.
+
+        .. note:: When using the Session as a context manager and the context exits, it will detach from the server session
+            and leave it open.
+
+
+
+GrpcSessionOptions
+------------------
+
+
+.. py:class:: GrpcSessionOptions(self, grpc_channel, session_name, initialization_behavior=SessionInitializationBehavior.AUTO)
+
+
+    Collection of options that specifies session behaviors related to gRPC.
+
+    Creates and returns an object you can pass to a Session constructor.
+
+
+    :param grpc_channel:
+
+
+        Specifies the channel to the NI gRPC Device Server.
+
+
+
+    :type grpc_channel: grpc.Channel
+
+
+    :param session_name:
+
+
+        User-specified name that identifies the driver session on the NI gRPC Device Server.
+
+        This is different from the resource name parameter many APIs take as a separate
+        parameter. Specifying a name makes it easy to share sessions across multiple gRPC clients.
+        You can use an empty string if you want to always initialize a new session on the server.
+        To attach to an existing session, you must specify the session name it was initialized with.
+
+
+
+    :type session_name: str
+
+
+    :param initialization_behavior:
+
+
+        Specifies whether it is acceptable to initialize a new session or attach to an existing one, or if only one of the behaviors is desired.
+
+        The driver session exists on the NI gRPC Device Server.
+
+
+
+    :type initialization_behavior: :py:data:`nirfsg.SessionInitializationBehavior`

docs/nirfsg/toc.inc

@@ -8,4 +8,5 @@ API Reference
    enums
    errors
    examples
+   grpc_session_options