Add python as a default annotation under programming language. (#599)

* Force add an annotation programming language Python

ni_measurementlink_service/_annotations.py

@@ -0,0 +1,5 @@
+"""Constants for annotations."""
+
+ENUM_VALUES_KEY = "ni/enum.values"
+TYPE_SPECIALIZATION_KEY = "ni/type_specialization"
+SERVICE_PROGRAMMINGLANGUAGE_KEY = "ni/service.programminglanguage"

ni_measurementlink_service/_internal/parameter/metadata.py

@@ -6,6 +6,10 @@
 
 from google.protobuf import type_pb2
 
+from ni_measurementlink_service._annotations import (
+    ENUM_VALUES_KEY,
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service._internal.parameter import serialization_strategy
 from ni_measurementlink_service.measurement.info import TypeSpecialization
 
@@ -147,11 +151,8 @@ def get_enum_values_annotation(parameter_metadata: ParameterMetadata) -> str:
     Returns:
         str: The value of "ni/enum.values" annotation
     """
-    if (
-        parameter_metadata.annotations.get("ni/type_specialization")
-        == TypeSpecialization.Enum.value
-    ):
-        return parameter_metadata.annotations.get("ni/enum.values", "")
+    if parameter_metadata.annotations.get(TYPE_SPECIALIZATION_KEY) == TypeSpecialization.Enum.value:
+        return parameter_metadata.annotations.get(ENUM_VALUES_KEY, "")
     else:
         return ""
 

ni_measurementlink_service/_internal/parameter/serializer.py

@@ -10,6 +10,9 @@
 )
 from google.protobuf.message import Message
 
+from ni_measurementlink_service._annotations import (
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service._internal.parameter import serialization_strategy
 from ni_measurementlink_service._internal.parameter.metadata import (
     ParameterMetadata,
@@ -76,7 +79,7 @@ def serialize_parameters(
         )
         # Convert enum parameters to their underlying value if necessary.
         if (
-            parameter_metadata.annotations.get("ni/type_specialization")
+            parameter_metadata.annotations.get(TYPE_SPECIALIZATION_KEY)
             == TypeSpecialization.Enum.value
         ):
             parameter = _get_enum_value(parameter, parameter_metadata.repeated)

ni_measurementlink_service/discovery/_client.py

@@ -7,6 +7,9 @@
 import grpc
 from deprecation import deprecated
 
+from ni_measurementlink_service._annotations import (
+    SERVICE_PROGRAMMINGLANGUAGE_KEY,
+)
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1 import (
     discovery_service_pb2,
     discovery_service_pb2_grpc,
@@ -112,13 +115,15 @@ def register_service(self, service_info: ServiceInfo, service_location: ServiceL
         Returns:
             ID that can be used to unregister the service.
         """
+        annotations = service_info.annotations.copy()
+        annotations[SERVICE_PROGRAMMINGLANGUAGE_KEY] = "Python"
         try:
             grpc_service_description = discovery_service_pb2.ServiceDescriptor(
                 display_name=service_info.display_name,
                 description_url=service_info.description_url,
                 provided_interfaces=service_info.provided_interfaces,
                 service_class=service_info.service_class,
-                annotations=service_info.annotations,
+                annotations=annotations,
             )
 
             grpc_service_location = discovery_service_pb2.ServiceLocation(

ni_measurementlink_service/measurement/service.py

@@ -28,6 +28,10 @@
 from google.protobuf.descriptor import EnumDescriptor
 
 from ni_measurementlink_service import _datatypeinfo
+from ni_measurementlink_service._annotations import (
+    ENUM_VALUES_KEY,
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service._featuretoggles import (
     SESSION_MANAGEMENT_2024Q1,
     requires_feature,
@@ -512,13 +516,13 @@ def _make_annotations_dict(
         if type_specialization == TypeSpecialization.NoType:
             return annotations
 
-        annotations["ni/type_specialization"] = type_specialization.value
+        annotations[TYPE_SPECIALIZATION_KEY] = type_specialization.value
         if type_specialization == TypeSpecialization.Pin:
             if instrument_type != "" or instrument_type is not None:
                 annotations["ni/pin.instrument_type"] = instrument_type
         if type_specialization == TypeSpecialization.Enum:
             if enum_type is not None:
-                annotations["ni/enum.values"] = self._enum_to_annotations_value(enum_type)
+                annotations[ENUM_VALUES_KEY] = self._enum_to_annotations_value(enum_type)
             else:
                 raise ValueError("enum_type is required for enum parameters.")
 

tests/unit/test_discovery_client.py

@@ -13,6 +13,9 @@
 import pytest
 from pytest_mock import MockerFixture
 
+from ni_measurementlink_service._annotations import (
+    SERVICE_PROGRAMMINGLANGUAGE_KEY,
+)
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.discovery.v1.discovery_service_pb2 import (
     RegisterServiceRequest,
     RegisterServiceResponse,
@@ -383,6 +386,7 @@ def _assert_service_location_equal(
 def _assert_service_info_equal(
     expected: ServiceInfo, actual: Union[ServiceInfo, GrpcServiceDescriptor]
 ) -> None:
+    expected.annotations[SERVICE_PROGRAMMINGLANGUAGE_KEY] = "Python"
     assert expected.display_name == actual.display_name
     assert expected.description_url == actual.description_url
     assert set(expected.provided_interfaces) == set(actual.provided_interfaces)

tests/unit/test_metadata.py

@@ -5,6 +5,10 @@
 import pytest
 
 from ni_measurementlink_service import _datatypeinfo
+from ni_measurementlink_service._annotations import (
+    ENUM_VALUES_KEY,
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service._internal.parameter import metadata
 from ni_measurementlink_service.measurement.info import DataType, TypeSpecialization
 
@@ -50,25 +54,25 @@ class Countries(IntEnum):
             DataType.Enum,
             1.0,
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
             },
         ),
         (
             DataType.Enum,
             DifferentColor.TEAL,
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
             },
         ),
         (DataType.EnumArray1D, 1, {}),
         (
             DataType.EnumArray1D,
             [1.0, 2.0],
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
             },
         ),
     ],
@@ -101,32 +105,32 @@ def test___default_value_different_from_type___validate___raises_type_exception(
             DataType.Enum,
             Color.BLUE,
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
             },
         ),
         (
             DataType.EnumArray1D,
             [Color.BLUE, Color.GREEN],
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"NONE":0, "RED": 1, "GREEN": 2, "BLUE": 3}',
             },
         ),
         (
             DataType.Enum,
             Countries.AUSTRALIA,
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"AMERICA":0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"AMERICA":0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
             },
         ),
         (
             DataType.EnumArray1D,
             [Countries.AUSTRALIA, Countries.CANADA],
             {
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"AMERICA":0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"AMERICA":0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
             },
         ),
     ],

tests/unit/test_serializer.py

@@ -6,6 +6,11 @@
 import pytest
 from google.protobuf import any_pb2, type_pb2
 
+
+from ni_measurementlink_service._annotations import (
+    ENUM_VALUES_KEY,
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service._internal.parameter import serializer
 from ni_measurementlink_service._internal.parameter.metadata import (
     ParameterMetadata,
@@ -402,8 +407,8 @@ def _get_test_parameter_by_id(default_values):
             repeated=False,
             default_value=default_values[16],
             annotations={
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"PURPLE": 0, "ORANGE": 1, "TEAL": 2, "BROWN": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"PURPLE": 0, "ORANGE": 1, "TEAL": 2, "BROWN": 3}',
             },
         ),
         18: ParameterMetadata(
@@ -412,8 +417,8 @@ def _get_test_parameter_by_id(default_values):
             repeated=True,
             default_value=default_values[17],
             annotations={
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"PURPLE": 0, "ORANGE": 1, "TEAL": 2, "BROWN": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"PURPLE": 0, "ORANGE": 1, "TEAL": 2, "BROWN": 3}',
             },
         ),
         19: ParameterMetadata(
@@ -422,8 +427,8 @@ def _get_test_parameter_by_id(default_values):
             repeated=False,
             default_value=default_values[18],
             annotations={
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"AMERICA": 0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"AMERICA": 0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
             },
         ),
         20: ParameterMetadata(
@@ -432,8 +437,8 @@ def _get_test_parameter_by_id(default_values):
             repeated=True,
             default_value=default_values[19],
             annotations={
-                "ni/type_specialization": TypeSpecialization.Enum.value,
-                "ni/enum.values": '{"AMERICA": 0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
+                TYPE_SPECIALIZATION_KEY: TypeSpecialization.Enum.value,
+                ENUM_VALUES_KEY: '{"AMERICA": 0, "TAIWAN": 1, "AUSTRALIA": 2, "CANADA": 3}',
             },
         ),
         21: ParameterMetadata(

tests/unit/test_service.py

@@ -9,6 +9,9 @@
 from pytest_mock import MockerFixture
 
 from ni_measurementlink_service import _datatypeinfo
+from ni_measurementlink_service._annotations import (
+    TYPE_SPECIALIZATION_KEY,
+)
 from ni_measurementlink_service.measurement.info import DataType, TypeSpecialization
 from ni_measurementlink_service.measurement.service import MeasurementService
 
@@ -100,7 +103,7 @@ def test___measurement_service___add_pin_configuration__pin_configuration_added(
         and param.default_value == default_value
         and param.annotations
         == {
-            "ni/type_specialization": TypeSpecialization.Pin.value,
+            TYPE_SPECIALIZATION_KEY: TypeSpecialization.Pin.value,
             "ni/pin.instrument_type": instrument_type,
         }
         for param in measurement_service._configuration_parameter_list
@@ -131,7 +134,7 @@ def test___measurement_service___add_non_pin_configuration__pin_type_annotations
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
 
     assert not all(
-        param.annotations.get("ni/type_specialization") == TypeSpecialization.Pin.value
+        param.annotations.get(TYPE_SPECIALIZATION_KEY) == TypeSpecialization.Pin.value
         for param in measurement_service._configuration_parameter_list
     )
 
@@ -159,7 +162,7 @@ def test___measurement_service___add_path_configuration__path_configuration_adde
         and param.default_value == default_value
         and param.annotations
         == {
-            "ni/type_specialization": TypeSpecialization.Path.value,
+            TYPE_SPECIALIZATION_KEY: TypeSpecialization.Path.value,
         }
         for param in measurement_service._configuration_parameter_list
     )
@@ -189,7 +192,7 @@ def test___measurement_service___add_non_path_configuration__path_type_annotatio
     measurement_service.configuration(display_name, type, default_value)(_fake_measurement_function)
 
     assert not all(
-        param.annotations.get("ni/type_specialization") == TypeSpecialization.Path.value
+        param.annotations.get(TYPE_SPECIALIZATION_KEY) == TypeSpecialization.Path.value
         for param in measurement_service._configuration_parameter_list
     )