ni.datastore 0.1.0.dev6__tar.gz → 2.0.0.dev0__tar.gz

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ni.datastore
-Version: 0.1.0.dev6
+Version: 2.0.0.dev0
 Summary: APIs for publishing and retrieving data from NI Measurement Data Services
 License: MIT
 Keywords: datastore
@@ -9,7 +9,7 @@ Author-email: opensource@ni.com
 Maintainer: Johann Scholtz
 Maintainer-email: johann.scholtz@emerson.com
 Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Manufacturing
 Classifier: Intended Audience :: Science/Research
@@ -23,12 +23,13 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Dist: hightime (>=0.3.0.dev0)
-Requires-Dist: ni-datamonikers-v1-client (>=0.1.0.dev1)
-Requires-Dist: ni-measurements-data-v1-client (>=0.2.0.dev4)
-Requires-Dist: ni-measurements-metadata-v1-client (>=0.2.0.dev2)
-Requires-Dist: ni-protobuf-types (>=1.0.1.dev0)
+Requires-Dist: hightime (>=1.0.0)
+Requires-Dist: ni-measurements-data-v1-client (>=1.1.0dev0)
+Requires-Dist: ni-measurements-metadata-v1-client (>=1.0.0)
+Requires-Dist: ni-protobuf-types (>=1.1.0)
 Requires-Dist: protobuf (>=4.21)
+Project-URL: Documentation, https://datastorepython.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/ni/datastore-python
 Description-Content-Type: text/markdown
 
 # Table of Contents
@@ -43,8 +44,7 @@ Description-Content-Type: text/markdown
 # Measurement Data Services API for Python
 
 `datastore-python` contains Python code for writing to and reading from
-[NI Measurement Data Services](https://github.com/ni/datastore-service).
-It will include examples of how to use the Python API.
+NI Measurement Data Store. It will include examples of how to use the Python API.
 
 # About
 

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/README.md

@@ -10,8 +10,7 @@
 # Measurement Data Services API for Python
 
 `datastore-python` contains Python code for writing to and reading from
-[NI Measurement Data Services](https://github.com/ni/datastore-service).
-It will include examples of how to use the Python API.
+NI Measurement Data Store. It will include examples of how to use the Python API.
 
 # About
 

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ni.datastore"
-version = "0.1.0.dev6"
+version = "2.0.0.dev0"
 license = "MIT"
 description = "APIs for publishing and retrieving data from NI Measurement Data Services"
 authors = [{name = "NI", email = "opensource@ni.com"}]
@@ -9,10 +9,9 @@ maintainers = [
   {name = "Joel Dixon", email = "joel.dixon@emerson.com"}
 ]
 readme = "README.md"
-repository = "https://github.com/ni/datastore-python"
 keywords = ["datastore"]
 classifiers = [
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Developers",
   "Intended Audience :: Manufacturing",
   "Intended Audience :: Science/Research",
@@ -30,6 +29,10 @@ classifiers = [
 dynamic = ["dependencies"]
 requires-python = '>=3.10,<4.0'
 
+[project.urls]
+repository = "https://github.com/ni/datastore-python"
+documentation = "https://datastorepython.readthedocs.io/en/latest/"
+
 [tool.poetry]
 packages = [{include = "ni", from = "src"}]
 requires-poetry = '>=2.1,<3.0'
@@ -37,11 +40,10 @@ requires-poetry = '>=2.1,<3.0'
 [tool.poetry.dependencies]
 python = "^3.10"
 protobuf = {version=">=4.21"}
-ni-datamonikers-v1-client = { version = ">=0.1.0.dev1", allow-prereleases = true }
-ni-measurements-data-v1-client = { version = ">=0.2.0.dev4", allow-prereleases = true }
-ni-measurements-metadata-v1-client = { version = ">=0.2.0.dev2", allow-prereleases = true }
-ni-protobuf-types = { version = ">=1.0.1.dev0", allow-prereleases = true }
-hightime = { version = ">=0.3.0.dev0", allow-prereleases = true }
+ni-measurements-data-v1-client = { version = ">=1.1.0dev0", allow-prereleases = true }
+ni-measurements-metadata-v1-client = { version = ">=1.0.0" }
+ni-protobuf-types = { version = ">=1.1.0" }
+hightime = { version = ">=1.0.0" }
 
 [tool.poetry.group.dev.dependencies]
 types-grpcio = ">=1.0"
@@ -51,6 +53,7 @@ plotly = ">=5.0"
 nbformat = ">=4.2.0"
 ipython = ">=7.0"
 jupyter = ">=1.0"
+datastore-utilities = { path = "./utilities", develop = true }
 
 [tool.poetry.group.lint.dependencies]
 bandit = { version = ">=1.7", extras = ["toml"] }
@@ -89,7 +92,7 @@ skips = [
 ]
 
 [tool.ni-python-styleguide]
-extend_exclude = "docs,examples"
+extend_exclude = "docs,examples,utilities"
 
 [tool.black]
 extend-exclude = 'docs/|examples/|_pb2(_grpc)?\.(py|pyi)$'
@@ -101,7 +104,7 @@ files = "."
 namespace_packages = true
 strict = true
 explicit_package_bases = true
-exclude = ["docs", "examples"]
+exclude = ["docs", "examples", "utilities"]
 
 [tool.pyright]
 include = ["src/", "tests/"]

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/__init__.py

@@ -2,7 +2,6 @@
 
 from ni.datastore.data._data_store_client import DataStoreClient
 from ni.datastore.data._types._error_information import ErrorInformation
-from ni.datastore.data._types._moniker import Moniker
 from ni.datastore.data._types._outcome import Outcome
 from ni.datastore.data._types._published_condition import PublishedCondition
 from ni.datastore.data._types._published_measurement import PublishedMeasurement
@@ -12,7 +11,6 @@ from ni.datastore.data._types._test_result import TestResult
 __all__ = [
     "DataStoreClient",
     "ErrorInformation",
-    "Moniker",
     "Outcome",
     "PublishedCondition",
     "PublishedMeasurement",
@@ -23,7 +21,6 @@ __all__ = [
 # Hide that it was not defined in this top-level package
 DataStoreClient.__module__ = __name__
 ErrorInformation.__module__ = __name__
-Moniker.__module__ = __name__
 Outcome.__module__ = __name__
 PublishedCondition.__module__ = __name__
 PublishedMeasurement.__module__ = __name__

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_data_store_client.py

@@ -8,21 +8,19 @@ from collections.abc import Iterable, Sequence
 from threading import Lock
 from types import TracebackType
 from typing import TYPE_CHECKING, Type, TypeVar, overload
-from urllib.parse import urlparse
 
 import hightime as ht
 from grpc import Channel
-from ni.datamonikers.v1.client import MonikerClient
 from ni.datastore.data._grpc_conversion import (
+    convert_read_condition_response_from_protobuf,
+    convert_read_measurement_response_from_protobuf,
     get_publish_measurement_timestamp,
     populate_publish_condition_batch_request_values,
     populate_publish_condition_request_value,
     populate_publish_measurement_batch_request_values,
     populate_publish_measurement_request_value,
-    unpack_and_convert_from_protobuf_any,
 )
 from ni.datastore.data._types._error_information import ErrorInformation
-from ni.datastore.data._types._moniker import Moniker
 from ni.datastore.data._types._outcome import Outcome
 from ni.datastore.data._types._published_condition import PublishedCondition
 from ni.datastore.data._types._published_measurement import PublishedMeasurement
@@ -45,6 +43,8 @@ from ni.measurements.data.v1.data_store_service_pb2 import (
     QueryMeasurementsRequest,
     QueryStepsRequest,
     QueryTestResultsRequest,
+    ReadConditionValueRequest,
+    ReadMeasurementValueRequest,
 )
 from ni.protobuf.types.precision_timestamp_conversion import (
     hightime_datetime_to_protobuf,
@@ -72,8 +72,6 @@ class DataStoreClient:
         "_grpc_channel_pool",
         "_data_store_client",
         "_data_store_client_lock",
-        "_moniker_clients_by_service_location",
-        "_moniker_clients_lock",
     )
 
     _DATA_STORE_CLIENT_CLOSED_ERROR = (
@@ -86,9 +84,7 @@ class DataStoreClient:
     _grpc_channel: Channel | None
     _grpc_channel_pool: GrpcChannelPool | None
     _data_store_client: DataStoreServiceClient | None
-    _moniker_clients_by_service_location: dict[str, MonikerClient]
     _data_store_client_lock: Lock
-    _moniker_clients_lock: Lock
 
     def __init__(
         self,
@@ -102,9 +98,7 @@ class DataStoreClient:
             discovery_client: An optional discovery client (recommended).
 
             grpc_channel: An optional data store gRPC channel. Providing this channel will bypass
-                discovery service resolution of the data store. (Note: Reading data from a moniker
-                will still always use a channel corresponding to the service location specified by
-                that moniker.)
+                discovery service resolution of the data store.
 
             grpc_channel_pool: An optional gRPC channel pool (recommended).
         """
@@ -113,10 +107,8 @@ class DataStoreClient:
         self._grpc_channel_pool = grpc_channel_pool
 
         self._data_store_client = None
-        self._moniker_clients_by_service_location = {}
 
         self._data_store_client_lock = Lock()
-        self._moniker_clients_lock = Lock()
 
         self._closed = False
 
@@ -142,11 +134,6 @@ class DataStoreClient:
                 self._data_store_client.close()
                 self._data_store_client = None
 
-        with self._moniker_clients_lock:
-            for _, moniker_client in self._moniker_clients_by_service_location.items():
-                moniker_client.close()
-            self._moniker_clients_by_service_location.clear()
-
     def publish_condition(
         self,
         name: str,
@@ -375,30 +362,72 @@ class DataStoreClient:
         return publish_response.measurement_ids
 
     @overload
-    def read_data(
+    def read_condition_value(
         self,
-        moniker_source: Moniker | PublishedMeasurement | PublishedCondition,
+        read_source: PublishedCondition,
         expected_type: Type[TRead],
     ) -> TRead: ...
 
     @overload
-    def read_data(
+    def read_condition_value(
         self,
-        moniker_source: Moniker | PublishedMeasurement | PublishedCondition,
+        read_source: PublishedCondition,
     ) -> object: ...
 
-    def read_data(
+    def read_condition_value(
         self,
-        moniker_source: Moniker | PublishedMeasurement | PublishedCondition,
+        read_source: PublishedCondition,
         expected_type: Type[TRead] | None = None,
     ) -> TRead | object:
         """Read data published to the data store.
 
         Args:
-            moniker_source: The source from which to read data. Can be:
-                - A Moniker (wrapper type) directly
-                - A PublishedMeasurement (uses its moniker)
-                - A PublishedCondition (uses its moniker)
+            read_source: The source from which to read data (PublishedCondition).
+
+            expected_type: Optional type to validate the returned data against.
+                If provided, a TypeError will be raised if the actual data type
+                doesn't match.
+
+        Returns:
+            The data retrieved from the data store. The return type depends on
+            what was originally published:
+            - Scalar conditions return as Vectors
+            - Other types are returned as originally published
+            If expected_type is specified, the return value is guaranteed to be
+            of that type.
+
+        Raises:
+            TypeError: If expected_type is provided and the actual data type
+                doesn't match.
+        """
+        read_value = self._read_condition(read_source)
+        if expected_type is not None and not isinstance(read_value, expected_type):
+            raise TypeError(f"Expected type {expected_type}, got {type(read_value)}")
+
+        return read_value
+
+    @overload
+    def read_measurement_value(
+        self,
+        read_source: PublishedMeasurement,
+        expected_type: Type[TRead],
+    ) -> TRead: ...
+
+    @overload
+    def read_measurement_value(
+        self,
+        read_source: PublishedMeasurement,
+    ) -> object: ...
+
+    def read_measurement_value(
+        self,
+        read_source: PublishedMeasurement,
+        expected_type: Type[TRead] | None = None,
+    ) -> TRead | object:
+        """Read data published to the data store.
+
+        Args:
+            read_source: The source from which to read data (PublishedMeasurement).
 
             expected_type: Optional type to validate the returned data against.
                 If provided, a TypeError will be raised if the actual data type
@@ -413,33 +442,14 @@ class DataStoreClient:
             of that type.
 
         Raises:
-            ValueError: If the moniker_source doesn't have a valid moniker.
             TypeError: If expected_type is provided and the actual data type
                 doesn't match.
         """
-        from ni.datamonikers.v1.data_moniker_pb2 import Moniker as MonikerProto
-
-        moniker_proto: MonikerProto
-
-        if isinstance(moniker_source, Moniker):
-            moniker_proto = moniker_source.to_protobuf()
-        elif isinstance(moniker_source, PublishedMeasurement):
-            if moniker_source.moniker is None:
-                raise ValueError("PublishedMeasurement must have a Moniker to read data")
-            moniker_proto = moniker_source.moniker.to_protobuf()
-        elif isinstance(moniker_source, PublishedCondition):
-            if moniker_source.moniker is None:
-                raise ValueError("PublishedCondition must have a Moniker to read data")
-            moniker_proto = moniker_source.moniker.to_protobuf()
-        else:
-            raise TypeError(f"Unsupported moniker_source type: {type(moniker_source)}")
-
-        moniker_client = self._get_moniker_client(moniker_proto.service_location)
-        read_result = moniker_client.read_from_moniker(moniker_proto)
-        converted_data = unpack_and_convert_from_protobuf_any(read_result.value)
-        if expected_type is not None and not isinstance(converted_data, expected_type):
-            raise TypeError(f"Expected type {expected_type}, got {type(converted_data)}")
-        return converted_data
+        read_value = self._read_measurement(read_source)
+        if expected_type is not None and not isinstance(read_value, expected_type):
+            raise TypeError(f"Expected type {expected_type}, got {type(read_value)}")
+
+        return read_value
 
     def create_step(self, step: Step) -> str:
         """Create a new step in the data store.
@@ -540,7 +550,7 @@ class DataStoreClient:
 
         Returns:
             Sequence[PublishedCondition]: The list of matching conditions. Each
-                item contains a moniker for retrieving the condition
+                item contains an id for retrieving the condition
                 measurements, as well as the metadata associated with the
                 condition.
         """
@@ -563,7 +573,7 @@ class DataStoreClient:
 
         Returns:
             Sequence[PublishedMeasurement]: The list of matching measurements.
-                Each item contains a moniker for retrieving the measurement, as
+                Each item contains an id for retrieving the measurement, as
                 well as the metadata associated with the measurement.
         """
         query_request = QueryMeasurementsRequest(odata_query=odata_query)
@@ -629,21 +639,12 @@ class DataStoreClient:
             grpc_channel_pool=self._grpc_channel_pool,
         )
 
-    def _get_moniker_client(self, service_location: str) -> MonikerClient:
-        if self._closed:
-            raise RuntimeError(self._DATA_STORE_CLIENT_CLOSED_ERROR)
+    def _read_measurement(self, published_measurement: PublishedMeasurement) -> object:
+        request = ReadMeasurementValueRequest(measurement_id=published_measurement.id)
+        response = self._get_data_store_client().read_measurement_value(request)
+        return convert_read_measurement_response_from_protobuf(response)
 
-        parsed_service_location = urlparse(service_location).netloc
-        if parsed_service_location not in self._moniker_clients_by_service_location:
-            with self._moniker_clients_lock:
-                if parsed_service_location not in self._moniker_clients_by_service_location:
-                    self._moniker_clients_by_service_location[parsed_service_location] = (
-                        self._instantiate_moniker_client(parsed_service_location)
-                    )
-        return self._moniker_clients_by_service_location[parsed_service_location]
-
-    def _instantiate_moniker_client(self, parsed_service_location: str) -> MonikerClient:
-        return MonikerClient(
-            service_location=parsed_service_location,
-            grpc_channel_pool=self._grpc_channel_pool,
-        )
+    def _read_condition(self, published_condition: PublishedCondition) -> object:
+        request = ReadConditionValueRequest(condition_id=published_condition.id)
+        response = self._get_data_store_client().read_condition_value(request)
+        return convert_read_condition_response_from_protobuf(response)

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_grpc_conversion.py

@@ -8,12 +8,13 @@ from typing import Iterable, cast
 
 import hightime as ht
 import numpy as np
-from google.protobuf.any_pb2 import Any
 from ni.measurements.data.v1.data_store_service_pb2 import (
     PublishConditionBatchRequest,
     PublishConditionRequest,
     PublishMeasurementBatchRequest,
     PublishMeasurementRequest,
+    ReadConditionValueResponse,
+    ReadMeasurementValueResponse,
 )
 from ni.protobuf.types.precision_timestamp_conversion import (
     hightime_datetime_to_protobuf,
@@ -21,7 +22,6 @@ from ni.protobuf.types.precision_timestamp_conversion import (
 from ni.protobuf.types.precision_timestamp_pb2 import PrecisionTimestamp
 from ni.protobuf.types.scalar_conversion import scalar_to_protobuf
 from ni.protobuf.types.vector_conversion import vector_from_protobuf, vector_to_protobuf
-from ni.protobuf.types.vector_pb2 import Vector as VectorProto
 from ni.protobuf.types.waveform_conversion import (
     digital_waveform_from_protobuf,
     digital_waveform_to_protobuf,
@@ -36,19 +36,10 @@ from ni.protobuf.types.waveform_conversion import (
     int16_complex_waveform_from_protobuf,
     int16_complex_waveform_to_protobuf,
 )
-from ni.protobuf.types.waveform_pb2 import (
-    DigitalWaveform as DigitalWaveformProto,
-    DoubleAnalogWaveform,
-    DoubleComplexWaveform,
-    DoubleSpectrum,
-    I16AnalogWaveform,
-    I16ComplexWaveform,
-)
 from ni.protobuf.types.xydata_conversion import (
     float64_xydata_from_protobuf,
     float64_xydata_to_protobuf,
 )
-from ni.protobuf.types.xydata_pb2 import DoubleXYData
 from nitypes.complex import ComplexInt32DType
 from nitypes.scalar import Scalar
 from nitypes.vector import Vector
@@ -187,43 +178,38 @@ def populate_publish_measurement_batch_request_values(
         )
 
 
-def unpack_and_convert_from_protobuf_any(read_value: Any) -> object:
-    """Convert from a packed pb.Any to the appropriate python object."""
-    value_type = read_value.TypeName()
-    if value_type == DoubleAnalogWaveform.DESCRIPTOR.full_name:
-        double_analog_waveform = DoubleAnalogWaveform()
-        read_value.Unpack(double_analog_waveform)
-        return float64_analog_waveform_from_protobuf(double_analog_waveform)
-    elif value_type == I16AnalogWaveform.DESCRIPTOR.full_name:
-        i16_analog_waveform = I16AnalogWaveform()
-        read_value.Unpack(i16_analog_waveform)
-        return int16_analog_waveform_from_protobuf(i16_analog_waveform)
-    elif value_type == DoubleComplexWaveform.DESCRIPTOR.full_name:
-        double_complex_waveform = DoubleComplexWaveform()
-        read_value.Unpack(double_complex_waveform)
-        return float64_complex_waveform_from_protobuf(double_complex_waveform)
-    elif value_type == I16ComplexWaveform.DESCRIPTOR.full_name:
-        i16_complex_waveform = I16ComplexWaveform()
-        read_value.Unpack(i16_complex_waveform)
-        return int16_complex_waveform_from_protobuf(i16_complex_waveform)
-    elif value_type == DoubleSpectrum.DESCRIPTOR.full_name:
-        spectrum = DoubleSpectrum()
-        read_value.Unpack(spectrum)
-        return float64_spectrum_from_protobuf(spectrum)
-    elif value_type == DigitalWaveformProto.DESCRIPTOR.full_name:
-        digital_waveform = DigitalWaveformProto()
-        read_value.Unpack(digital_waveform)
-        return digital_waveform_from_protobuf(digital_waveform)
-    elif value_type == DoubleXYData.DESCRIPTOR.full_name:
-        xydata = DoubleXYData()
-        read_value.Unpack(xydata)
-        return float64_xydata_from_protobuf(xydata)
-    elif value_type == VectorProto.DESCRIPTOR.full_name:
-        vector = VectorProto()
-        read_value.Unpack(vector)
-        return vector_from_protobuf(vector)
+def convert_read_measurement_response_from_protobuf(
+    response: ReadMeasurementValueResponse,
+) -> object:
+    """Convert the value in the ReadMeasurementValueResponse from protobuf and return it."""
+    read_data_type = response.WhichOneof("value")
+    if read_data_type == "digital_waveform":
+        return digital_waveform_from_protobuf(response.digital_waveform)
+    elif read_data_type == "double_analog_waveform":
+        return float64_analog_waveform_from_protobuf(response.double_analog_waveform)
+    elif read_data_type == "double_complex_waveform":
+        return float64_complex_waveform_from_protobuf(response.double_complex_waveform)
+    elif read_data_type == "double_spectrum":
+        return float64_spectrum_from_protobuf(response.double_spectrum)
+    elif read_data_type == "i16_analog_waveform":
+        return int16_analog_waveform_from_protobuf(response.i16_analog_waveform)
+    elif read_data_type == "i16_complex_waveform":
+        return int16_complex_waveform_from_protobuf(response.i16_complex_waveform)
+    elif read_data_type == "vector":
+        return vector_from_protobuf(response.vector)
+    elif read_data_type == "x_y_data":
+        return float64_xydata_from_protobuf(response.x_y_data)
+    else:
+        raise TypeError(f"Invalid read type: {read_data_type}")
+
+
+def convert_read_condition_response_from_protobuf(response: ReadConditionValueResponse) -> object:
+    """Convert the value in the ReadConditionValueResponse from protobuf and return it."""
+    read_data_type = response.WhichOneof("value")
+    if read_data_type == "vector":
+        return vector_from_protobuf(response.vector)
     else:
-        raise TypeError(f"Unsupported data type Name: {value_type}")
+        raise TypeError(f"Invalid read type: {read_data_type}")
 
 
 def get_publish_measurement_timestamp(

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_types/_published_condition.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from ni.datastore.data._types._moniker import Moniker
 from ni.measurements.data.v1.data_store_pb2 import (
     PublishedCondition as PublishedConditionProto,
 )
@@ -12,12 +11,11 @@ class PublishedCondition:
     """Represents a condition that has been published to the data store.
 
     A published condition contains metadata about a condition value that was
-    published, including a moniker for data retrieval and associated metadata
+    published, including an id for data retrieval and associated metadata
     like condition name, type, and associated step/test result IDs.
     """
 
     __slots__ = (
-        "moniker",
         "id",
         "name",
         "condition_type",
@@ -28,7 +26,6 @@ class PublishedCondition:
     def __init__(
         self,
         *,
-        moniker: Moniker | None = None,
         id: str = "",
         name: str = "",
         condition_type: str = "",
@@ -38,8 +35,6 @@ class PublishedCondition:
         """Initialize a PublishedCondition instance.
 
         Args:
-            moniker: The moniker of the condition that this value is associated
-                with. This moniker returns a Vector when read.
             id: The unique identifier of the condition. This
                 can be used to reference and find the condition in the data store.
             name: The name of the condition.
@@ -49,7 +44,6 @@ class PublishedCondition:
             test_result_id: The ID of the test result with which this condition
                 is associated.
         """
-        self.moniker = moniker
         self.id = id
         self.name = name
         self.condition_type = condition_type
@@ -60,11 +54,6 @@ class PublishedCondition:
     def from_protobuf(published_condition_proto: PublishedConditionProto) -> "PublishedCondition":
         """Create a PublishedCondition instance from a protobuf PublishedCondition message."""
         return PublishedCondition(
-            moniker=(
-                Moniker.from_protobuf(published_condition_proto.moniker)
-                if published_condition_proto.HasField("moniker")
-                else None
-            ),
             id=published_condition_proto.id,
             name=published_condition_proto.name,
             condition_type=published_condition_proto.condition_type,
@@ -75,7 +64,6 @@ class PublishedCondition:
     def to_protobuf(self) -> PublishedConditionProto:
         """Convert this PublishedCondition instance to a protobuf PublishedCondition message."""
         return PublishedConditionProto(
-            moniker=self.moniker.to_protobuf() if self.moniker is not None else None,
             id=self.id,
             name=self.name,
             condition_type=self.condition_type,
@@ -88,8 +76,7 @@ class PublishedCondition:
         if not isinstance(other, PublishedCondition):
             return NotImplemented
         return (
-            self.moniker == other.moniker
-            and self.id == other.id
+            self.id == other.id
             and self.name == other.name
             and self.condition_type == other.condition_type
             and self.step_id == other.step_id

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_types/_published_measurement.py

@@ -6,7 +6,6 @@ from typing import Iterable, MutableSequence
 
 import hightime as ht
 from ni.datastore.data._types._error_information import ErrorInformation
-from ni.datastore.data._types._moniker import Moniker
 from ni.datastore.data._types._outcome import Outcome
 from ni.datastore.data._types._published_condition import PublishedCondition
 from ni.measurements.data.v1.data_store_pb2 import PublishedMeasurement as PublishedMeasurementProto
@@ -25,7 +24,6 @@ class PublishedMeasurement:
     """
 
     __slots__ = (
-        "moniker",
         "_published_conditions",
         "id",
         "test_result_id",
@@ -66,7 +64,6 @@ class PublishedMeasurement:
     def __init__(
         self,
         *,
-        moniker: Moniker | None = None,
         published_conditions: Iterable[PublishedCondition] | None = None,
         id: str = "",
         test_result_id: str = "",
@@ -86,8 +83,6 @@ class PublishedMeasurement:
         """Initialize a PublishedMeasurement instance.
 
         Args:
-            moniker: The moniker of the measurement that this value is
-                associated with.
             published_conditions: The published conditions associated with this
                 measurement from the test step.
             id: The unique identifier of the measurement.
@@ -116,7 +111,6 @@ class PublishedMeasurement:
             error_information: Error or exception information in case of
                 measurement failure.
         """
-        self.moniker = moniker
         self._published_conditions: MutableSequence[PublishedCondition] = (
             list(published_conditions) if published_conditions is not None else []
         )
@@ -147,11 +141,6 @@ class PublishedMeasurement:
     ) -> "PublishedMeasurement":
         """Create a PublishedMeasurement instance from a protobuf PublishedMeasurement message."""
         return PublishedMeasurement(
-            moniker=(
-                Moniker.from_protobuf(published_measurement_proto.moniker)
-                if published_measurement_proto.HasField("moniker")
-                else None
-            ),
             published_conditions=[
                 PublishedCondition.from_protobuf(cond)
                 for cond in published_measurement_proto.published_conditions
@@ -187,7 +176,6 @@ class PublishedMeasurement:
     def to_protobuf(self) -> PublishedMeasurementProto:
         """Convert this PublishedMeasurement instance to a protobuf PublishedMeasurement message."""
         return PublishedMeasurementProto(
-            moniker=self.moniker.to_protobuf() if self.moniker is not None else None,
             published_conditions=[
                 condition.to_protobuf() for condition in self.published_conditions
             ],
@@ -222,8 +210,7 @@ class PublishedMeasurement:
         if not isinstance(other, PublishedMeasurement):
             return NotImplemented
         return (
-            self.moniker == other.moniker
-            and self.published_conditions == other.published_conditions
+            self.published_conditions == other.published_conditions
             and self.id == other.id
             and self.test_result_id == other.test_result_id
             and self.step_id == other.step_id

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_types/_step.py

@@ -29,11 +29,11 @@ class Step:
     """
 
     __slots__ = (
+        "name",
         "id",
         "parent_step_id",
         "test_result_id",
         "test_id",
-        "name",
         "step_type",
         "notes",
         "start_date_time",
@@ -52,12 +52,12 @@ class Step:
 
     def __init__(
         self,
+        name: str,
         *,
         id: str = "",
         parent_step_id: str = "",
         test_result_id: str = "",
         test_id: str = "",
-        name: str = "",
         step_type: str = "",
         notes: str = "",
         start_date_time: ht.datetime | None = None,
@@ -71,28 +71,28 @@ class Step:
         """Initialize a Step instance.
 
         Args:
-            id: Unique identifier for the step.
-            parent_step_id: ID of the parent step if this is a nested step.
-            test_result_id: ID of the test result this step belongs to.
-            test_id: ID of the test associated with this step.
             name: Human-readable name of the step.
-            step_type: Type or category of the step.
-            notes: Additional notes or comments about the step.
-            start_date_time: The start date and time of the step execution.
-            end_date_time: The end date and time of the step execution.
-            link: Optional link to external resources for this step.
-            extension: Additional custom metadata as key-value pairs.
-            schema_id: ID of the extension schema for validating extensions.
-            error_information: Error or exception information in case of
+            id (optional): Unique identifier for the step.
+            parent_step_id (optional): ID of the parent step if this is a nested step.
+            test_result_id (optional): ID of the test result this step belongs to.
+            test_id (optional): ID of the test associated with this step.
+            step_type (optional): Type or category of the step.
+            notes (optional): Additional notes or comments about the step.
+            start_date_time (optional): The start date and time of the step execution.
+            end_date_time (optional): The end date and time of the step execution.
+            link (optional): Optional link to external resources for this step.
+            extension (optional): Additional extension attributes as key-value pairs.
+            schema_id (optional): ID of the extension schema for validating extensions.
+            error_information (optional): Error or exception information in case of
                 step failure.
-            outcome: The outcome of the step (PASSED, FAILED,
+            outcome (optional): The outcome of the step (PASSED, FAILED,
                 INDETERMINATE, or UNSPECIFIED).
         """
+        self.name = name
         self.id = id
         self.parent_step_id = parent_step_id
         self.test_result_id = test_result_id
         self.test_id = test_id
-        self.name = name
         self.step_type = step_type
         self.notes = notes
         self.start_date_time = start_date_time
@@ -107,11 +107,11 @@ class Step:
     def from_protobuf(step_proto: StepProto) -> "Step":
         """Create a Step instance from a protobuf Step message."""
         step = Step(
+            name=step_proto.name,
             id=step_proto.id,
             parent_step_id=step_proto.parent_step_id,
             test_result_id=step_proto.test_result_id,
             test_id=step_proto.test_id,
-            name=step_proto.name,
             step_type=step_proto.step_type,
             notes=step_proto.notes,
             start_date_time=(

{ni_datastore-0.1.0.dev6 → ni_datastore-2.0.0.dev0}/src/ni/datastore/data/_types/_test_result.py

@@ -29,6 +29,7 @@ class TestResult:
     """
 
     __slots__ = (
+        "name",
         "id",
         "uut_instance_id",
         "operator_id",
@@ -37,7 +38,6 @@ class TestResult:
         "_software_item_ids",
         "_hardware_item_ids",
         "_test_adapter_ids",
-        "name",
         "start_date_time",
         "end_date_time",
         "outcome",
@@ -69,6 +69,7 @@ class TestResult:
 
     def __init__(
         self,
+        name: str,
         *,
         id: str = "",
         uut_instance_id: str = "",
@@ -78,7 +79,6 @@ class TestResult:
         software_item_ids: Iterable[str] | None = None,
         hardware_item_ids: Iterable[str] | None = None,
         test_adapter_ids: Iterable[str] | None = None,
-        name: str = "",
         start_date_time: ht.datetime | None = None,
         end_date_time: ht.datetime | None = None,
         outcome: Outcome = Outcome.UNSPECIFIED,
@@ -90,25 +90,26 @@ class TestResult:
         """Initialize a TestResult instance.
 
         Args:
-            id: Unique identifier for the test result.
-            uut_instance_id: ID of the UUT instance that was tested.
-            operator_id: ID of the operator who ran the test.
-            test_station_id: ID of the test station used.
-            test_description_id: ID of the test description that was executed.
-            software_item_ids: IDs of software items used in the test.
-            hardware_item_ids: IDs of hardware items used in the test.
-            test_adapter_ids: IDs of test adapters used in the test.
             name: Human-readable name for the test result.
-            start_date_time: The start date and time of the test execution.
-            end_date_time: The end date and time of the test execution.
-            outcome: The outcome of the test execution (PASSED, FAILED,
+            id (optional): Unique identifier for the test result.
+            uut_instance_id (optional): ID of the UUT instance that was tested.
+            operator_id (optional): ID of the operator who ran the test.
+            test_station_id (optional): ID of the test station used.
+            test_description_id (optional): ID of the test description that was executed.
+            software_item_ids (optional): IDs of software items used in the test.
+            hardware_item_ids (optional): IDs of hardware items used in the test.
+            test_adapter_ids (optional): IDs of test adapters used in the test.
+            start_date_time (optional): The start date and time of the test execution.
+            end_date_time (optional): The end date and time of the test execution.
+            outcome (optional): The outcome of the test execution (PASSED, FAILED,
                 INDETERMINATE, or UNSPECIFIED).
-            link: Optional link to external resources for this test result.
-            extension: Additional custom metadata as key-value pairs.
-            schema_id: ID of the extension schema for validating extensions.
-            error_information: Error or exception information in case of
+            link (optional): Optional link to external resources for this test result.
+            extension (optional): Additional extension attributes as key-value pairs.
+            schema_id (optional): ID of the extension schema for validating extensions.
+            error_information (optional): Error or exception information in case of
                 test result failure.
         """
+        self.name = name
         self.id = id
         self.uut_instance_id = uut_instance_id
         self.operator_id = operator_id
@@ -123,7 +124,6 @@ class TestResult:
         self._test_adapter_ids: MutableSequence[str] = (
             list(test_adapter_ids) if test_adapter_ids is not None else []
         )
-        self.name = name
         self.start_date_time = start_date_time
         self.end_date_time = end_date_time
         self.outcome = outcome
@@ -136,6 +136,7 @@ class TestResult:
     def from_protobuf(test_result_proto: TestResultProto) -> "TestResult":
         """Create a TestResult instance from a protobuf TestResult message."""
         test_result = TestResult(
+            name=test_result_proto.name,
             id=test_result_proto.id,
             uut_instance_id=test_result_proto.uut_instance_id,
             operator_id=test_result_proto.operator_id,
@@ -144,7 +145,6 @@ class TestResult:
             software_item_ids=test_result_proto.software_item_ids,
             hardware_item_ids=test_result_proto.hardware_item_ids,
             test_adapter_ids=test_result_proto.test_adapter_ids,
-            name=test_result_proto.name,
             start_date_time=(
                 hightime_datetime_from_protobuf(test_result_proto.start_date_time)
                 if test_result_proto.HasField("start_date_time")

ni_datastore-0.1.0.dev6/src/ni/datastore/data/_types/_moniker.py

@@ -1,69 +0,0 @@
-"""Moniker data type for the Data Store Client."""
-
-from __future__ import annotations
-
-from ni.datamonikers.v1.data_moniker_pb2 import Moniker as MonikerProto
-
-
-class Moniker:
-    """Represents a data moniker for retrieving published data.
-
-    A moniker provides the necessary information to locate and retrieve data
-    from the data store, including the service location, data source, and
-    data instance identifiers.
-    """
-
-    __slots__ = (
-        "service_location",
-        "data_source",
-        "data_instance",
-    )
-
-    def __init__(
-        self,
-        *,
-        service_location: str = "",
-        data_source: str = "",
-        data_instance: int = 0,
-    ) -> None:
-        """Initialize a Moniker instance.
-
-        Args:
-            service_location: The location of the service that stores the data.
-            data_source: The identifier for the data source.
-            data_instance: The instance number of the data.
-        """
-        self.service_location = service_location
-        self.data_source = data_source
-        self.data_instance = data_instance
-
-    @staticmethod
-    def from_protobuf(moniker_proto: MonikerProto) -> "Moniker":
-        """Create a Moniker instance from a protobuf Moniker message."""
-        return Moniker(
-            service_location=moniker_proto.service_location,
-            data_source=moniker_proto.data_source,
-            data_instance=moniker_proto.data_instance,
-        )
-
-    def to_protobuf(self) -> MonikerProto:
-        """Convert this Moniker instance to a protobuf Moniker message."""
-        return MonikerProto(
-            service_location=self.service_location,
-            data_source=self.data_source,
-            data_instance=self.data_instance,
-        )
-
-    def __eq__(self, other: object) -> bool:
-        """Determine equality."""
-        if not isinstance(other, Moniker):
-            return NotImplemented
-        return (
-            self.service_location == other.service_location
-            and self.data_source == other.data_source
-            and self.data_instance == other.data_instance
-        )
-
-    def __str__(self) -> str:
-        """Return a string representation of the Moniker."""
-        return str(self.to_protobuf())