Expose client types in 'ni.datastore' / Make extension-related logic consistent across supported types (#29)

* Adding client types for various messages. Using list() for comparing equality of iterables.

* Re-adding definitions for Operator, Test, and TestDescription

* Updating client code, tests, and examples to use newly added types. Adding to-string methods for wrapper types.

* Exposing remaining needed types in ni.datastore package.

* Initial work - abstracting away ExtensionValue concept from client API

* Adding support for the case of no value being set for the Metadata of the returned ExtensionValue

* Cleanup: Re-order entries in __init__.py

* Review feedback - switch extensions to use a mapping of [str, str] instead of [str, object]

* Review feedback - update to_protobuf and from_protobuf parameter and local variable names.

* Review feedback - Use more descriptive local variable names

* Review feedback - Mark client.py as essentially an implementation detail by renaming it to _client.py. Mask imported types of ni.datastore as belonging to main module.

* Reorder methods for consistency with other types

* Review feedback - rename 'types' folder to '_types' folder

Signed-off-by: Hunter Kennon hunter.kennon@emerson.com

Author: hunter-ni

examples/notebooks/alias/alias.ipynb

@@ -17,8 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ni.datastore import Client\n",
-    "from ni.measurements.metadata.v1.metadata_store_pb2 import Operator\n",
+    "from ni.datastore import Client, Operator\n",
     "\n",
     "client = Client()\n",
     "operatorOne = Operator(operator_name=\"Jane Doe\")\n",

examples/notebooks/custom-metadata/custom_metadata.ipynb

@@ -49,33 +49,33 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from ni.measurements.metadata.v1.metadata_store_pb2 import HardwareItem, ExtensionValue\n",
+        "from ni.datastore import HardwareItem\n",
         "\n",
         "cable = HardwareItem(\n",
         "    manufacturer=\"NI\",\n",
         "    model=\"cable\",\n",
         "    serial_number=\"7u2349\",\n",
         "    schema_id=cable_schema_id,\n",
         ")\n",
-        "cable.extensions[\"cable_length\"].CopyFrom(ExtensionValue(string_value=\"1.5\"))\n",
-        "cable.extensions[\"manufacture_date\"].CopyFrom(ExtensionValue(string_value=\"2023-01-01\"))\n",
+        "cable.extensions[\"cable_length\"] = \"1.5\"\n",
+        "cable.extensions[\"manufacture_date\"] = \"2023-01-01\"\n",
         "\n",
         "socket = HardwareItem(\n",
         "    manufacturer=\"NI\",\n",
         "    model=\"socket\",\n",
         "    schema_id=socket_schema_id,\n",
         ")\n",
-        "socket.extensions[\"socket_number\"].CopyFrom(ExtensionValue(string_value=\"3\"))\n",
-        "socket.extensions[\"manufacture_date\"].CopyFrom(ExtensionValue(string_value=\"2024-05-01\"))\n",
+        "socket.extensions[\"socket_number\"] = \"3\"\n",
+        "socket.extensions[\"manufacture_date\"] = \"2024-05-01\"\n",
         "\n",
         "scope = HardwareItem(\n",
         "    manufacturer=\"NI\",\n",
         "    model=\"PXIe-5171\",\n",
         "    serial_number=\"1933B4E\",\n",
         "    schema_id=scope_schema_id,\n",
         ")\n",
-        "scope.extensions[\"bandwidth\"].CopyFrom(ExtensionValue(string_value=\"250 MHz\"))\n",
-        "scope.extensions[\"manufacture_date\"].CopyFrom(ExtensionValue(string_value=\"2024-11-03\"))"
+        "scope.extensions[\"bandwidth\"] = \"250 MHz\"\n",
+        "scope.extensions[\"manufacture_date\"] = \"2024-11-03\""
       ]
     },
     {
@@ -120,7 +120,6 @@
         "from datetime import timezone\n",
         "import hightime as ht\n",
         "from ni.datastore import TestResult, Step\n",
-        "from ni.protobuf.types.precision_timestamp_pb2 import PrecisionTimestamp\n",
         "from nitypes.waveform import AnalogWaveform\n",
         "from nitypes.waveform import Timing\n",
         "import numpy as np\n",
@@ -137,7 +136,6 @@
         "    )\n",
         ")\n",
         "\n",
-        "precision_timestamp = PrecisionTimestamp()\n",
         "waveform = AnalogWaveform(\n",
         "    sample_count=3,\n",
         "    raw_data=np.array([1.0, 2.0, 3.0]),\n",

examples/notebooks/overview/publish_measurement.ipynb

@@ -44,8 +44,7 @@
    "outputs": [],
    "source": [
     "import grpc\n",
-    "from ni.datastore import TestResult\n",
-    "from ni.measurements.metadata.v1.metadata_store_pb2 import Operator, TestStation, SoftwareItem, ExtensionValue\n",
+    "from ni.datastore import Operator, TestResult, TestStation, SoftwareItem\n",
     "\n",
     "# Invalid creation of operator - no badge_number provided\n",
     "operator = Operator(operator_name=\"James Bowery\", schema_id=schema_id)\n",
@@ -56,33 +55,33 @@
     "    print(f\"  {e.details()}\")\n",
     "\n",
     "# Add the required attribute to the operator object\n",
-    "operator.extensions[\"badge_number\"].CopyFrom(ExtensionValue(string_value=\"emp-128256\"))\n",
+    "operator.extensions[\"badge_number\"] = \"emp-128256\"\n",
     "operator_id = client.create_operator(operator)\n",
     "\n",
     "# Invalid creation of test station - location is invalid\n",
     "test_station = TestStation(test_station_name=\"TestStation_12\", schema_id=schema_id)\n",
-    "test_station.extensions[\"location\"].CopyFrom(ExtensionValue(string_value=\"Texas\"))\n",
+    "test_station.extensions[\"location\"] = \"Texas\"\n",
     "try:\n",
     "    test_station_id = client.create_test_station(test_station)\n",
     "except grpc.RpcError as e:\n",
     "    print(\"Failed to create test station:\")\n",
     "    print(f\"  {e.details()}\")\n",
     "\n",
     "# Fix the location\n",
-    "test_station.extensions[\"location\"].CopyFrom(ExtensionValue(string_value=\"USA\"))\n",
+    "test_station.extensions[\"location\"] = \"USA\"\n",
     "test_station_id = client.create_test_station(test_station)\n",
     "\n",
     "# Invalid creation of software item -  software license is invalid (not matching the pattern defined in the schema)\n",
     "software_item = SoftwareItem(product=\"Windows\", version=\"10.0.19044\", schema_id=schema_id)\n",
-    "software_item.extensions[\"license\"].CopyFrom(ExtensionValue(string_value=\"enterprise_LIC\"))\n",
+    "software_item.extensions[\"license\"] = \"enterprise_LIC\"\n",
     "try:\n",
     "    software_item_id = client.create_software_item(software_item)\n",
     "except grpc.RpcError as e:\n",
     "    print(\"Failed to create software item:\")\n",
     "    print(f\"  {e.details()}\")\n",
     "\n",
     "# Fix the software license to create the software item\n",
-    "software_item.extensions[\"license\"].CopyFrom(ExtensionValue(string_value=\"LIC_enterprise\"))\n",
+    "software_item.extensions[\"license\"] = \"LIC_enterprise\"\n",
     "software_item_id = client.create_software_item(software_item)\n",
     "    \n",
     "test_result = TestResult(\n",
@@ -91,7 +90,7 @@
     "    test_station_id=test_station_id,\n",
     "    schema_id=schema_id,\n",
     "    software_item_ids=[software_item_id])\n",
-    "test_result.extensions[\"session_file_path\"] = ExtensionValue(string_value=\"C:\\\\my_test_description.xlsx\")\n"
+    "test_result.extensions[\"session_file_path\"] = \"C:\\\\my_test_description.xlsx\"\n"
    ]
   },
   {
@@ -186,7 +185,7 @@
     "    operator = client.get_operator(test_result.operator_id)\n",
     "    # badge_number is a custom attribute in the schema\n",
     "    # It's not a standard attribute of the operator object\n",
-    "    badge_number = operator.extensions[\"badge_number\"].string_value\n",
+    "    badge_number = operator.extensions[\"badge_number\"]\n",
     "    print(f\"operator {operator.operator_name}'s badge number is: {badge_number}\")\n",
     "\n",
     "    waveform = client.read_data(found_measurement, expected_type=AnalogWaveform)\n",

examples/notebooks/query/query_measurements.ipynb

@@ -18,8 +18,7 @@
    "outputs": [],
    "source": [
     "from typing import List\n",
-    "from ni.datastore import Client, PublishedMeasurement\n",
-    "from ni.measurements.data.v1.data_store_pb2 import Outcome\n",
+    "from ni.datastore import Client, Outcome, PublishedMeasurement\n",
     "\n",
     "client = Client()\n",
     "\n",

examples/notebooks/voltage-regulator/publish_waveforms.ipynb

@@ -27,8 +27,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ni.datastore import Client, TestResult\n",
-    "from ni.measurements.metadata.v1.metadata_store_pb2 import Operator, TestStation\n",
+    "from ni.datastore import Client, Operator, TestResult, TestStation\n",
     "\n",
     "client = Client()\n",
     "\n",

examples/overview/src/overview.py

@@ -4,10 +4,12 @@
 
 import hightime as ht
 import numpy as np
-from ni.datastore import Client, Step, TestResult
-from ni.measurements.metadata.v1.metadata_store_pb2 import (
+from ni.datastore import (
+    Client,
     Operator,
     SoftwareItem,
+    Step,
+    TestResult,
     TestStation,
     Uut,
     UutInstance,

src/ni/datastore/__init__.py

@@ -1,13 +1,66 @@
 """Public API for accessing the NI Data Store Service."""
 
-from ni.datastore.client import Client
-from ni.datastore.types._published_measurement import PublishedMeasurement
-from ni.datastore.types._step import Step
-from ni.datastore.types._test_result import TestResult
+from ni.datamonikers.v1.data_moniker_pb2 import Moniker
+from ni.datastore._client import Client
+from ni.datastore._types._alias import Alias
+from ni.datastore._types._extension_schema import ExtensionSchema
+from ni.datastore._types._hardware_item import HardwareItem
+from ni.datastore._types._operator import Operator
+from ni.datastore._types._published_condition import PublishedCondition
+from ni.datastore._types._published_measurement import PublishedMeasurement
+from ni.datastore._types._software_item import SoftwareItem
+from ni.datastore._types._step import Step
+from ni.datastore._types._test import Test
+from ni.datastore._types._test_adapter import TestAdapter
+from ni.datastore._types._test_description import TestDescription
+from ni.datastore._types._test_result import TestResult
+from ni.datastore._types._test_station import TestStation
+from ni.datastore._types._uut import Uut
+from ni.datastore._types._uut_instance import UutInstance
+from ni.measurements.data.v1.data_store_pb2 import ErrorInformation, Outcome
+from ni.measurements.metadata.v1.metadata_store_pb2 import AliasTargetType
 
 __all__ = [
     "Client",
+    "Alias",
+    "AliasTargetType",
+    "ErrorInformation",
+    "ExtensionSchema",
+    "HardwareItem",
+    "Moniker",
+    "Operator",
+    "Outcome",
+    "PublishedCondition",
+    "PublishedMeasurement",
+    "SoftwareItem",
     "Step",
+    "Test",
+    "TestAdapter",
+    "TestDescription",
     "TestResult",
-    "PublishedMeasurement",
+    "TestStation",
+    "Uut",
+    "UutInstance",
 ]
+
+# Hide that it was not defined in this top-level package
+Client.__module__ = __name__
+Alias.__module__ = __name__
+AliasTargetType.__module__ = __name__
+ErrorInformation.__module__ = __name__
+ExtensionSchema.__module__ = __name__
+HardwareItem.__module__ = __name__
+Moniker.__module__ = __name__
+Operator.__module__ = __name__
+Outcome.__module__ = __name__
+PublishedCondition.__module__ = __name__
+PublishedMeasurement.__module__ = __name__
+SoftwareItem.__module__ = __name__
+Step.__module__ = __name__
+Test.__module__ = __name__
+TestAdapter.__module__ = __name__
+TestDescription.__module__ = __name__
+TestResult.__module__ = __name__
+TestStation.__module__ = __name__
+Uut.__module__ = __name__
+UutInstance.__module__ = __name__