Code quality improvements to the Measurement Plug-In Client generator

.github/workflows/check_nimg.yml

@@ -46,3 +46,13 @@ jobs:
         run:  poetry run mypy --platform win32
       - name: Bandit security checks (ni-measurement-plugin-sdk-generator, example_renders)
         run:  poetry run bandit -c pyproject.toml -r ni_measurement_plugin_sdk_generator tests/test_assets/example_renders
+      - name: Generate gRPC stubs
+        run: |
+          find tests/utilities/measurements/non_streaming_data_measurement/_stubs -name \*_pb2.py\* -o -name \*_pb2_grpc.py\* -delete
+          poetry run python scripts/generate_grpc_stubs.py
+      - name: Check for out-of-date gRPC stubs
+        run:  git diff --exit-code
+      - name: Revert gRPC stubs
+        run: |
+          git clean -dfx tests/utilities/measurements/non_streaming_data_measurement/_stubs
+          git restore tests/utilities/measurements/non_streaming_data_measurement/_stubs

README.md

@@ -234,7 +234,7 @@ The generated client includes four APIs: `measure`, `stream_measure`, `register_
 
 1. Make sure the required measurement service is running before interacting with it via the client.
 
-2. Use the client APIs from the ["Developing a Minimal Python MeasurementClient"](#developing-a-minimal-python-measurement-client) section.
+2. Use the client APIs from the ["Generating a Minimal Python Measurement Client"](#generating-a-minimal-python-measurement-client) section.
 
     1. For non-streaming measurements, use the `measure` method.
 

packages/generator/README.md

@@ -92,7 +92,7 @@ The generated client includes four APIs: `measure`, `stream_measure`, `register_
 
 1. Make sure the required measurement service is running before interacting with it via the client.
 
-2. Use the client APIs from the ["Developing a Minimal Python MeasurementClient"](#developing-a-minimal-python-measurement-client) section.
+2. Use the client APIs from the ["Generating a Minimal Python Measurement Client"](#generating-a-minimal-python-measurement-client) section.
 
     1. For non-streaming measurements, use the `measure` method.
 

packages/generator/ni_measurement_plugin_sdk_generator/client/__init__.py

@@ -1,7 +1,6 @@
 """Utilizes command line args to create a Measurement Plug-In Client using template files."""
 
 import pathlib
-import re
 from enum import Enum
 from typing import Any, Dict, List, Optional, Type
 
@@ -39,18 +38,12 @@ def _render_template(template_name: str, **template_args: Any) -> bytes:
     return template.render(**template_args)
 
 
-def _replace_enum_class_type(output: str) -> str:
-    pattern = "<enum '([^']+)'>"
-    return re.sub(pattern, r"\1", output)
-
-
 def _create_file(
     template_name: str, file_name: str, directory_out: pathlib.Path, **template_args: Any
 ) -> None:
     output_file = directory_out / file_name
 
     output = _render_template(template_name, **template_args).decode("utf-8")
-    output = _replace_enum_class_type(output)
     formatted_output = black.format_str(
         src_contents=output,
         mode=black.Mode(line_length=100),
@@ -231,7 +224,7 @@ def _create_clients(
 @optgroup.option(
     "-s",
     "--measurement-service-class",
-    help="Creates Python Measurement Plug-In Client for the given measurement services.",
+    help="Creates Python Measurement Plug-In Client for the given measurement service classes.",
     multiple=True,
 )
 @optgroup.option(
@@ -276,9 +269,6 @@ def create_client(
     """Generates a Python Measurement Plug-In Client module for the measurement service.
 
     You can use the generated module to interact with the corresponding measurement service.
-
-    MEASUREMENT_SERVICE_CLASS: Accepts one or more measurement service classes.
-    Provide each service class separately.
     """
     if all:
         _create_all_clients(directory_out)

packages/generator/ni_measurement_plugin_sdk_generator/client/_support.py

@@ -2,7 +2,6 @@
 
 import json
 import keyword
-import os
 import pathlib
 import re
 import sys
@@ -154,7 +153,7 @@ def get_configuration_metadata_by_index(
     deserialized_parameters = deserialize_parameters(
         configuration_metadata,
         metadata.measurement_signature.configuration_defaults.value,
-        service_class + ".Configurations",
+        f"{service_class}.Configurations",
     )
 
     for k, v in deserialized_parameters.items():
@@ -248,10 +247,7 @@ def get_configuration_parameters_with_type_and_default_values(
 
         configuration_parameters.append(f"{parameter_name}: {parameter_type} = {default_value}")
 
-    # Use line separator and spaces to align the parameters appropriately in the generated file.
-    configuration_parameters_with_type_and_value = f",{os.linesep}        ".join(
-        configuration_parameters
-    )
+    configuration_parameters_with_type_and_value = f", ".join(configuration_parameters)
     parameter_names_as_str = ", ".join(parameter_names)
 
     return (configuration_parameters_with_type_and_value, parameter_names_as_str)
@@ -262,9 +258,9 @@ def get_output_parameters_with_type(
     built_in_import_modules: List[str],
     custom_import_modules: List[str],
     enum_values_by_type: Dict[Type[Enum], Dict[str, int]] = {},
-) -> str:
+) -> List[str]:
     """Returns the output parameters of the measurement with type."""
-    output_parameters_with_type = []
+    output_parameters_with_type: List[str] = []
     for metadata in output_metadata.values():
         parameter_name = _get_python_identifier(metadata.display_name)
         parameter_type = _get_python_type_as_str(metadata.type, metadata.repeated)
@@ -289,7 +285,7 @@ def get_output_parameters_with_type(
 
         output_parameters_with_type.append(f"{parameter_name}: {parameter_type}")
 
-    return f"{os.linesep}    ".join(output_parameters_with_type)
+    return output_parameters_with_type
 
 
 def to_ordered_set(values: Iterable[_T]) -> AbstractSet[_T]:
@@ -438,4 +434,4 @@ def _get_enum_class_name(name: str) -> str:
         name = "".join(s.capitalize() for s in split_string)
     else:
         name = name[0].upper() + name[1:]
-    return name + "Enum"
+    return f"{name}Enum"

packages/generator/ni_measurement_plugin_sdk_generator/client/templates/measurement_plugin_client.py.mako

@@ -1,5 +1,20 @@
-<%page args="class_name, display_name, configuration_metadata, output_metadata, service_class, configuration_parameters_with_type_and_default_values, measure_api_parameters, output_parameters_with_type, built_in_import_modules, custom_import_modules, enum_by_class_name, configuration_parameters_type_url"/>\
-\
+<%!
+import re
+%>
+
+<%page args="class_name, display_name, configuration_metadata, output_metadata, service_class, configuration_parameters_with_type_and_default_values, measure_api_parameters, output_parameters_with_type, built_in_import_modules, custom_import_modules, enum_by_class_name, configuration_parameters_type_url"/>
+
+<%
+    def _replace_enum_class_type(input_string: str) -> str:
+        """Replace enum class type representation with the enum name."""
+        pattern = r"<enum '([^']+)'>"
+        return re.sub(pattern, r"\1", input_string)
+
+    configuration_metadata = _replace_enum_class_type(str(configuration_metadata))
+    if output_metadata:
+        output_metadata = _replace_enum_class_type(str(output_metadata))
+%>
+
 """Generated client API for the ${display_name | repr} measurement plug-in."""
 
 import logging
@@ -57,7 +72,9 @@ class ${enum_name.__name__}(Enum):
 class Outputs(NamedTuple):
     """Outputs for the ${display_name | repr} measurement plug-in."""
 
-    ${output_parameters_with_type}
+    % for output_parameter in output_parameters_with_type:
+    ${output_parameter}
+    % endfor
 <% output_type = "Outputs" %>\
 % endif
 
@@ -102,7 +119,7 @@ class ${class_name}:
 
     @property
     def pin_map_context(self) -> PinMapContext:
-        """Get the pin map context for the measurement."""
+        """The pin map context for the measurement."""
         return self._pin_map_context
 
     @pin_map_context.setter