ni.datastore 3.0.0.dev0__tar.gz → 3.0.0.dev1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/PKG-INFO +4 -4
  2. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/pyproject.toml +4 -4
  3. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_data_store_client.py +52 -13
  4. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_create.py +1 -0
  5. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_measurement.py +13 -0
  6. ni_datastore-3.0.0.dev1/src/ni/datastore/data/v2/_types/_query_results.py +41 -0
  7. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_read_fields.py +2 -0
  8. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_step.py +6 -0
  9. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_metadata_store_client.py +184 -1
  10. ni_datastore-3.0.0.dev0/src/ni/datastore/data/v2/_types/_query_results.py +0 -29
  11. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/LICENSE +0 -0
  12. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/README.md +0 -0
  13. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/__init__.py +0 -0
  14. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/__init__.py +0 -0
  15. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_data_store_client.py +0 -0
  16. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_grpc_conversion.py +0 -0
  17. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/__init__.py +0 -0
  18. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_error_information.py +0 -0
  19. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_outcome.py +0 -0
  20. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_published_condition.py +0 -0
  21. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_published_measurement.py +0 -0
  22. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_step.py +0 -0
  23. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/_test_result.py +0 -0
  24. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/_types/py.typed +0 -0
  25. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/py.typed +0 -0
  26. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/__init__.py +0 -0
  27. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_grpc_conversion.py +0 -0
  28. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/__init__.py +0 -0
  29. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_condition.py +0 -0
  30. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_error_information.py +0 -0
  31. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_json_value.py +0 -0
  32. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_measurement_value.py +0 -0
  33. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_outcome.py +0 -0
  34. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_status.py +0 -0
  35. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_test_result.py +0 -0
  36. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_types/_update.py +0 -0
  37. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/data/v2/_update_conversion.py +0 -0
  38. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/__init__.py +0 -0
  39. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_grpc_conversion.py +0 -0
  40. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/__init__.py +0 -0
  41. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_alias.py +0 -0
  42. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_alias_target_type.py +0 -0
  43. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_extension_schema.py +0 -0
  44. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_hardware_item.py +0 -0
  45. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_metadata_items.py +0 -0
  46. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_operator.py +0 -0
  47. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_software_item.py +0 -0
  48. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_test.py +0 -0
  49. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_test_adapter.py +0 -0
  50. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_test_description.py +0 -0
  51. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_test_station.py +0 -0
  52. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_uut.py +0 -0
  53. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/_uut_instance.py +0 -0
  54. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/_types/py.typed +0 -0
  55. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/metadata/py.typed +0 -0
  56. {ni_datastore-3.0.0.dev0 → ni_datastore-3.0.0.dev1}/src/ni/datastore/py.typed +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ni.datastore
3
- Version: 3.0.0.dev0
3
+ Version: 3.0.0.dev1
4
4
  Summary: APIs for publishing and retrieving data from NI Measurement Data Services
5
5
  License-Expression: MIT
6
6
  License-File: LICENSE
@@ -26,9 +26,9 @@ Classifier: Programming Language :: Python :: 3.15
26
26
  Classifier: Programming Language :: Python :: Implementation :: CPython
27
27
  Requires-Dist: hightime (>=1.0.0)
28
28
  Requires-Dist: ni-measurements-data-v1-client (>=1.2.0.dev0)
29
- Requires-Dist: ni-measurements-data-v2-client (>=1.0.0.dev0)
30
- Requires-Dist: ni-measurements-data-v2-proto (>=1.0.0.dev0)
31
- Requires-Dist: ni-measurements-metadata-v1-client (>=1.0.0)
29
+ Requires-Dist: ni-measurements-data-v2-client (>=1.0.0.dev1)
30
+ Requires-Dist: ni-measurements-data-v2-proto (>=1.0.0.dev1)
31
+ Requires-Dist: ni-measurements-metadata-v1-client (>=1.1.0.dev1)
32
32
  Requires-Dist: ni-protobuf-types (>=1.3.0.dev0)
33
33
  Requires-Dist: protobuf (>=4.21)
34
34
  Project-URL: Documentation, https://datastorepython.readthedocs.io/en/latest/
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "ni.datastore"
3
- version = "3.0.0.dev0"
3
+ version = "3.0.0.dev1"
4
4
  license = "MIT"
5
5
  description = "APIs for publishing and retrieving data from NI Measurement Data Services"
6
6
  authors = [{name = "NI", email = "opensource@ni.com"}]
@@ -41,9 +41,9 @@ requires-poetry = '>=2.1,<3.0'
41
41
  python = "^3.11"
42
42
  protobuf = {version=">=4.21"}
43
43
  ni-measurements-data-v1-client = { version = ">=1.2.0.dev0", allow-prereleases = true }
44
- ni-measurements-metadata-v1-client = { version = ">=1.0.0" }
45
- ni-measurements-data-v2-client = { version = ">=1.0.0.dev0", allow-prereleases = true }
46
- ni-measurements-data-v2-proto = { version = ">=1.0.0.dev0", allow-prereleases = true }
44
+ ni-measurements-metadata-v1-client = { version = ">=1.1.0.dev1", allow-prereleases = true }
45
+ ni-measurements-data-v2-client = { version = ">=1.0.0.dev1", allow-prereleases = true }
46
+ ni-measurements-data-v2-proto = { version = ">=1.0.0.dev1", allow-prereleases = true }
47
47
  ni-protobuf-types = { version = ">=1.3.0.dev0", allow-prereleases = true }
48
48
  hightime = { version = ">=1.0.0" }
49
49
 
@@ -591,7 +591,12 @@ class DataStoreClient:
591
591
  return Measurement.from_protobuf(self._get_data_store_client().get_measurement(get_request))
592
592
 
593
593
  def query_test_results(
594
- self, odata_query: str = "", *, read_fields: Iterable[TestResultField | str] = ()
594
+ self,
595
+ odata_query: str = "",
596
+ *,
597
+ read_fields: Iterable[TestResultField | str] = (),
598
+ page_size: int = 0,
599
+ page_token: str = "",
595
600
  ) -> QueryResults[TestResult]:
596
601
  """Query test results using OData query syntax.
597
602
 
@@ -602,21 +607,34 @@ class DataStoreClient:
602
607
  read_fields: Optional fields to return for each test result, such as
603
608
  TestResultField.NAME. Field names as strings are also accepted.
604
609
 
610
+ page_size: Maximum number of test results to return. Zero uses the service default.
611
+
612
+ page_token: Token from a previous response used to retrieve the next page. An empty
613
+ string (the default) requests the first page.
614
+
605
615
  Returns:
606
- QueryResults[TestResult]: The matching test results, with next_link
607
- set when more results are available.
616
+ QueryResults[TestResult]: The matching test results, with next_page_token set when
617
+ more results are available.
608
618
  """
609
619
  query_request = QueryTestResultsRequest(
610
- odata_query=odata_query, read_mask=_read_mask(read_fields)
620
+ odata_query=odata_query,
621
+ read_mask=_read_mask(read_fields),
622
+ page_size=page_size,
623
+ page_token=page_token,
611
624
  )
612
625
  query_response = self._get_data_store_client().query_test_results(query_request)
613
626
  return QueryResults(
614
627
  (TestResult.from_protobuf(proto) for proto in query_response.test_results),
615
- query_response.next_link,
628
+ next_page_token=query_response.next_page_token,
616
629
  )
617
630
 
618
631
  def query_steps(
619
- self, odata_query: str = "", *, read_fields: Iterable[StepField | str] = ()
632
+ self,
633
+ odata_query: str = "",
634
+ *,
635
+ read_fields: Iterable[StepField | str] = (),
636
+ page_size: int = 0,
637
+ page_token: str = "",
620
638
  ) -> QueryResults[Step]:
621
639
  """Query steps using OData query syntax.
622
640
 
@@ -627,21 +645,34 @@ class DataStoreClient:
627
645
  read_fields: Optional fields to return for each step, such as
628
646
  StepField.CONDITIONS. Field names as strings are also accepted.
629
647
 
648
+ page_size: Maximum number of steps to return. Zero uses the service default.
649
+
650
+ page_token: Token from a previous response used to retrieve the next page. An empty
651
+ string (the default) requests the first page.
652
+
630
653
  Returns:
631
- QueryResults[Step]: The matching steps, with next_link set when more
654
+ QueryResults[Step]: The matching steps, with next_page_token set when more
632
655
  results are available.
633
656
  """
634
657
  query_request = QueryStepsRequest(
635
- odata_query=odata_query, read_mask=_read_mask(read_fields)
658
+ odata_query=odata_query,
659
+ read_mask=_read_mask(read_fields),
660
+ page_size=page_size,
661
+ page_token=page_token,
636
662
  )
637
663
  query_response = self._get_data_store_client().query_steps(query_request)
638
664
  return QueryResults(
639
665
  (Step.from_protobuf(proto) for proto in query_response.steps),
640
- query_response.next_link,
666
+ next_page_token=query_response.next_page_token,
641
667
  )
642
668
 
643
669
  def query_measurements(
644
- self, odata_query: str = "", *, read_fields: Iterable[MeasurementField | str] = ()
670
+ self,
671
+ odata_query: str = "",
672
+ *,
673
+ read_fields: Iterable[MeasurementField | str] = (),
674
+ page_size: int = 0,
675
+ page_token: str = "",
645
676
  ) -> QueryResults[Measurement]:
646
677
  """Query measurements using OData query syntax.
647
678
 
@@ -653,17 +684,25 @@ class DataStoreClient:
653
684
  read_fields: Optional fields to return for each measurement, such as
654
685
  MeasurementField.CONDITIONS. Field names as strings are also accepted.
655
686
 
687
+ page_size: Maximum number of measurements to return. Zero uses the service default.
688
+
689
+ page_token: Token from a previous response used to retrieve the next page. An empty
690
+ string (the default) requests the first page.
691
+
656
692
  Returns:
657
- QueryResults[Measurement]: The matching measurements, with next_link
693
+ QueryResults[Measurement]: The matching measurements, with next_page_token
658
694
  set when more results are available.
659
695
  """
660
696
  query_request = QueryMeasurementsRequest(
661
- odata_query=odata_query, read_mask=_read_mask(read_fields)
697
+ odata_query=odata_query,
698
+ read_mask=_read_mask(read_fields),
699
+ page_size=page_size,
700
+ page_token=page_token,
662
701
  )
663
702
  query_response = self._get_data_store_client().query_measurements(query_request)
664
703
  return QueryResults(
665
704
  (Measurement.from_protobuf(proto) for proto in query_response.measurements),
666
- query_response.next_link,
705
+ next_page_token=query_response.next_page_token,
667
706
  )
668
707
 
669
708
  @overload
@@ -103,6 +103,7 @@ class MeasurementCreateFields(TypedDict, total=False):
103
103
  upper_limit: MeasurementValue | None
104
104
  lower_limit: MeasurementValue | None
105
105
  comparison_type: str
106
+ keywords: Iterable[str] | None
106
107
  notes: str
107
108
  start_date_time: ht.datetime | None
108
109
  end_date_time: ht.datetime | None
@@ -18,6 +18,7 @@ from ni.datastore.data.v2._grpc_conversion import (
18
18
  id_string,
19
19
  measurement_value_from_protobuf,
20
20
  measurement_value_to_protobuf,
21
+ string_list,
21
22
  timestamp_from_protobuf,
22
23
  timestamp_to_protobuf,
23
24
  )
@@ -61,6 +62,7 @@ class Measurement:
61
62
  "_hardware_items",
62
63
  "_test_adapters",
63
64
  "comparison_type",
65
+ "_keywords",
64
66
  "_conditions",
65
67
  "created_at",
66
68
  "updated_at",
@@ -110,6 +112,11 @@ class Measurement:
110
112
  """Read-only output-only conditions copied from the owning step."""
111
113
  return self._conditions
112
114
 
115
+ @property
116
+ def keywords(self) -> MutableSequence[str]:
117
+ """Labels used to classify the measurement."""
118
+ return self._keywords
119
+
113
120
  @property
114
121
  def value(self) -> MeasurementValue | None:
115
122
  """The measured value.
@@ -151,6 +158,7 @@ class Measurement:
151
158
  hardware_items: Iterable[HardwareItem] | None = None,
152
159
  test_adapters: Iterable[TestAdapter] | None = None,
153
160
  comparison_type: str = "",
161
+ keywords: Iterable[str] | None = None,
154
162
  conditions: Iterable[Condition] | None = None,
155
163
  created_at: ht.datetime | None = None,
156
164
  updated_at: ht.datetime | None = None,
@@ -198,6 +206,7 @@ class Measurement:
198
206
  test_adapters (optional): Test adapters to find or create on create. Each
199
207
  item must already be linked to the owning test result.
200
208
  comparison_type (optional): The publisher-defined comparison operation.
209
+ keywords (optional): Labels used to classify the measurement.
201
210
  conditions (optional): Output only. Read-only conditions copied from the
202
211
  owning step.
203
212
  created_at (optional): Output only. When the measurement was created.
@@ -239,6 +248,7 @@ class Measurement:
239
248
  list(test_adapters) if test_adapters is not None else []
240
249
  )
241
250
  self.comparison_type = comparison_type
251
+ self._keywords = string_list(keywords, "keywords")
242
252
  self._conditions: tuple[Condition, ...] = (
243
253
  tuple(conditions) if conditions is not None else ()
244
254
  )
@@ -285,6 +295,7 @@ class Measurement:
285
295
  TestAdapter.from_protobuf(adapter) for adapter in measurement_proto.test_adapters
286
296
  ],
287
297
  comparison_type=measurement_proto.comparison_type,
298
+ keywords=measurement_proto.keywords,
288
299
  conditions=[
289
300
  Condition.from_protobuf(condition) for condition in measurement_proto.conditions
290
301
  ],
@@ -326,6 +337,7 @@ class Measurement:
326
337
  hardware_items=[item.to_protobuf() for item in self.hardware_items],
327
338
  test_adapters=[adapter.to_protobuf() for adapter in self.test_adapters],
328
339
  comparison_type=self.comparison_type,
340
+ keywords=self.keywords,
329
341
  )
330
342
 
331
343
  def __eq__(self, other: object) -> bool:
@@ -357,6 +369,7 @@ class Measurement:
357
369
  and self.hardware_items == other.hardware_items
358
370
  and self.test_adapters == other.test_adapters
359
371
  and self.comparison_type == other.comparison_type
372
+ and self.keywords == other.keywords
360
373
  and self.conditions == other.conditions
361
374
  and self.created_at == other.created_at
362
375
  and self.updated_at == other.updated_at
@@ -0,0 +1,41 @@
1
+ """Query results data type for the V2 Data Store Client."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from collections.abc import Iterable
6
+ from typing import TypeVar
7
+
8
+ T = TypeVar("T")
9
+
10
+
11
+ class QueryResults(list[T]):
12
+ """One page of query results with a continuation token when more results exist."""
13
+
14
+ next_page_token: str
15
+ """Opaque token for retrieving the next page, or an empty string when there is none."""
16
+
17
+ def __init__(
18
+ self,
19
+ items: Iterable[T] = (),
20
+ next_link: str = "",
21
+ *,
22
+ next_page_token: str | None = None,
23
+ ) -> None:
24
+ """Initialize a QueryResults instance.
25
+
26
+ Args:
27
+ items: The results on this page.
28
+ next_link: Legacy name for the continuation token.
29
+ next_page_token: Token returned by the service for retrieving the next page.
30
+ """
31
+ super().__init__(items)
32
+ self.next_page_token = next_page_token if next_page_token is not None else next_link
33
+
34
+ @property
35
+ def next_link(self) -> str:
36
+ """Legacy alias for next_page_token."""
37
+ return self.next_page_token
38
+
39
+ @next_link.setter
40
+ def next_link(self, value: str) -> None:
41
+ self.next_page_token = value
@@ -72,6 +72,7 @@ class StepField(str, Enum):
72
72
  CONDITIONS = "conditions"
73
73
  MEASUREMENTS = "measurements"
74
74
  CHILDREN = "children"
75
+ HAS_CHILDREN = "has_children"
75
76
  TEST = "test"
76
77
 
77
78
 
@@ -107,6 +108,7 @@ class MeasurementField(str, Enum):
107
108
  HARDWARE_ITEMS = "hardware_items"
108
109
  TEST_ADAPTERS = "test_adapters"
109
110
  COMPARISON_TYPE = "comparison_type"
111
+ KEYWORDS = "keywords"
110
112
 
111
113
 
112
114
  class MeasurementValueField(str, Enum):
@@ -58,6 +58,7 @@ class Step:
58
58
  "_children",
59
59
  "_path",
60
60
  "_path_ids",
61
+ "has_children",
61
62
  "created_at",
62
63
  "updated_at",
63
64
  "created_by",
@@ -125,6 +126,7 @@ class Step:
125
126
  children: Iterable[Step] | None = None,
126
127
  path: Iterable[str] | None = None,
127
128
  path_ids: Iterable[str] | None = None,
129
+ has_children: bool = False,
128
130
  created_at: ht.datetime | None = None,
129
131
  updated_at: ht.datetime | None = None,
130
132
  created_by: str = "",
@@ -158,6 +160,7 @@ class Step:
158
160
  children (optional): Child steps created with the step.
159
161
  path (optional): Output only. The step-name path, including this step.
160
162
  path_ids (optional): Output only. The step-identifier path, including this step.
163
+ has_children (optional): Output only. Whether this step has ever had a child step.
161
164
  created_at (optional): Output only. When the step was created.
162
165
  updated_at (optional): Output only. When the step was last updated.
163
166
  created_by (optional): Output only. Who created the step.
@@ -190,6 +193,7 @@ class Step:
190
193
  self._children: MutableSequence[Step] = list(children) if children is not None else []
191
194
  self._path: MutableSequence[str] = string_list(path, "path")
192
195
  self._path_ids: MutableSequence[str] = string_list(path_ids, "path_ids")
196
+ self.has_children = has_children
193
197
  self.created_at = created_at
194
198
  self.updated_at = updated_at
195
199
  self.created_by = created_by
@@ -228,6 +232,7 @@ class Step:
228
232
  children=[Step.from_protobuf(child) for child in step_proto.children],
229
233
  path=step_proto.path,
230
234
  path_ids=step_proto.path_ids,
235
+ has_children=getattr(step_proto, "has_children", False),
231
236
  created_at=timestamp_from_protobuf(step_proto, "created_at"),
232
237
  updated_at=timestamp_from_protobuf(step_proto, "updated_at"),
233
238
  created_by=step_proto.created_by,
@@ -293,6 +298,7 @@ class Step:
293
298
  and self.children == other.children
294
299
  and self.path == other.path
295
300
  and self.path_ids == other.path_ids
301
+ and self.has_children == other.has_children
296
302
  and self.created_at == other.created_at
297
303
  and self.updated_at == other.updated_at
298
304
  and self.created_by == other.created_by
@@ -4,7 +4,7 @@ from __future__ import annotations
4
4
 
5
5
  import logging
6
6
  import sys
7
- from collections.abc import Sequence
7
+ from collections.abc import Iterable, Sequence
8
8
  from pathlib import Path
9
9
  from threading import Lock
10
10
  from types import TracebackType
@@ -16,6 +16,17 @@ from ni.measurements.metadata.v1.client import (
16
16
  MetadataStoreClient as MetadataStoreServiceClient,
17
17
  )
18
18
  from ni.measurements.metadata.v1.metadata_store_service_pb2 import (
19
+ BatchDeleteAliasesRequest,
20
+ BatchDeleteHardwareItemsRequest,
21
+ BatchDeleteOperatorsRequest,
22
+ BatchDeleteSchemasRequest,
23
+ BatchDeleteSoftwareItemsRequest,
24
+ BatchDeleteTestAdaptersRequest,
25
+ BatchDeleteTestDescriptionsRequest,
26
+ BatchDeleteTestsRequest,
27
+ BatchDeleteTestStationsRequest,
28
+ BatchDeleteUutInstancesRequest,
29
+ BatchDeleteUutsRequest,
19
30
  CreateAliasRequest,
20
31
  CreateFromJsonDocumentRequest,
21
32
  CreateHardwareItemRequest,
@@ -28,6 +39,16 @@ from ni.measurements.metadata.v1.metadata_store_service_pb2 import (
28
39
  CreateUutInstanceRequest,
29
40
  CreateUutRequest,
30
41
  DeleteAliasRequest,
42
+ DeleteHardwareItemRequest,
43
+ DeleteOperatorRequest,
44
+ DeleteSchemaRequest,
45
+ DeleteSoftwareItemRequest,
46
+ DeleteTestAdapterRequest,
47
+ DeleteTestDescriptionRequest,
48
+ DeleteTestRequest,
49
+ DeleteTestStationRequest,
50
+ DeleteUutInstanceRequest,
51
+ DeleteUutRequest,
31
52
  GetAliasRequest,
32
53
  GetHardwareItemRequest,
33
54
  GetOperatorRequest,
@@ -189,6 +210,23 @@ class MetadataStoreClient:
189
210
  UutInstance.from_protobuf(uut_instance) for uut_instance in query_response.uut_instances
190
211
  ]
191
212
 
213
+ def delete_uut_instance(self, uut_instance_id: str, *, force: bool = False) -> None:
214
+ """Delete a UUT instance by ID, optionally removing references that block deletion."""
215
+ request = DeleteUutInstanceRequest(uut_instance_id=uut_instance_id, force=force)
216
+ self._get_metadata_store_client().delete_uut_instance(request)
217
+
218
+ def batch_delete_uut_instances(
219
+ self, uut_instance_ids: Iterable[str], *, force: bool = False
220
+ ) -> None:
221
+ """Delete UUT instances by ID; force applies to every requested ID."""
222
+ request = BatchDeleteUutInstancesRequest(
223
+ requests=[
224
+ DeleteUutInstanceRequest(uut_instance_id=uut_instance_id, force=force)
225
+ for uut_instance_id in uut_instance_ids
226
+ ]
227
+ )
228
+ self._get_metadata_store_client().batch_delete_uut_instances(request)
229
+
192
230
  def create_uut(self, uut: Uut) -> str:
193
231
  """Create a new UUT in the metadata store.
194
232
 
@@ -229,6 +267,18 @@ class MetadataStoreClient:
229
267
  query_response = self._get_metadata_store_client().query_uuts(query_request)
230
268
  return [Uut.from_protobuf(uut) for uut in query_response.uuts]
231
269
 
270
+ def delete_uut(self, uut_id: str, *, force: bool = False) -> None:
271
+ """Delete a UUT by ID, optionally deleting its instances and references."""
272
+ request = DeleteUutRequest(uut_id=uut_id, force=force)
273
+ self._get_metadata_store_client().delete_uut(request)
274
+
275
+ def batch_delete_uuts(self, uut_ids: Iterable[str], *, force: bool = False) -> None:
276
+ """Delete UUTs by ID; force applies to every requested ID."""
277
+ request = BatchDeleteUutsRequest(
278
+ requests=[DeleteUutRequest(uut_id=uut_id, force=force) for uut_id in uut_ids]
279
+ )
280
+ self._get_metadata_store_client().batch_delete_uuts(request)
281
+
232
282
  def create_operator(self, operator: Operator) -> str:
233
283
  """Create a new operator in the metadata store.
234
284
 
@@ -269,6 +319,21 @@ class MetadataStoreClient:
269
319
  query_response = self._get_metadata_store_client().query_operators(query_request)
270
320
  return [Operator.from_protobuf(operator) for operator in query_response.operators]
271
321
 
322
+ def delete_operator(self, operator_id: str, *, force: bool = False) -> None:
323
+ """Delete an operator by ID, optionally removing references that block deletion."""
324
+ request = DeleteOperatorRequest(operator_id=operator_id, force=force)
325
+ self._get_metadata_store_client().delete_operator(request)
326
+
327
+ def batch_delete_operators(self, operator_ids: Iterable[str], *, force: bool = False) -> None:
328
+ """Delete operators by ID; force applies to every requested ID."""
329
+ request = BatchDeleteOperatorsRequest(
330
+ requests=[
331
+ DeleteOperatorRequest(operator_id=operator_id, force=force)
332
+ for operator_id in operator_ids
333
+ ]
334
+ )
335
+ self._get_metadata_store_client().batch_delete_operators(request)
336
+
272
337
  def create_test_description(self, test_description: TestDescription) -> str:
273
338
  """Create a test description in the metadata store.
274
339
 
@@ -315,6 +380,23 @@ class MetadataStoreClient:
315
380
  for test_description in query_response.test_descriptions
316
381
  ]
317
382
 
383
+ def delete_test_description(self, test_description_id: str, *, force: bool = False) -> None:
384
+ """Delete a test description by ID, optionally removing references."""
385
+ request = DeleteTestDescriptionRequest(test_description_id=test_description_id, force=force)
386
+ self._get_metadata_store_client().delete_test_description(request)
387
+
388
+ def batch_delete_test_descriptions(
389
+ self, test_description_ids: Iterable[str], *, force: bool = False
390
+ ) -> None:
391
+ """Delete test descriptions by ID; force applies to every requested ID."""
392
+ request = BatchDeleteTestDescriptionsRequest(
393
+ requests=[
394
+ DeleteTestDescriptionRequest(test_description_id=test_description_id, force=force)
395
+ for test_description_id in test_description_ids
396
+ ]
397
+ )
398
+ self._get_metadata_store_client().batch_delete_test_descriptions(request)
399
+
318
400
  def create_test(self, test: Test) -> str:
319
401
  """Create a test in the metadata store.
320
402
 
@@ -347,6 +429,18 @@ class MetadataStoreClient:
347
429
  query_response = self._get_metadata_store_client().query_tests(query_request)
348
430
  return [Test.from_protobuf(test) for test in query_response.tests]
349
431
 
432
+ def delete_test(self, test_id: str, *, force: bool = False) -> None:
433
+ """Delete a test by ID, optionally removing references that block deletion."""
434
+ request = DeleteTestRequest(test_id=test_id, force=force)
435
+ self._get_metadata_store_client().delete_test(request)
436
+
437
+ def batch_delete_tests(self, test_ids: Iterable[str], *, force: bool = False) -> None:
438
+ """Delete tests by ID; force applies to every requested ID."""
439
+ request = BatchDeleteTestsRequest(
440
+ requests=[DeleteTestRequest(test_id=test_id, force=force) for test_id in test_ids]
441
+ )
442
+ self._get_metadata_store_client().batch_delete_tests(request)
443
+
350
444
  def create_test_station(self, test_station: TestStation) -> str:
351
445
  """Create a test station in the metadata store.
352
446
 
@@ -381,6 +475,23 @@ class MetadataStoreClient:
381
475
  TestStation.from_protobuf(test_station) for test_station in query_response.test_stations
382
476
  ]
383
477
 
478
+ def delete_test_station(self, test_station_id: str, *, force: bool = False) -> None:
479
+ """Delete a test station by ID, optionally removing references."""
480
+ request = DeleteTestStationRequest(test_station_id=test_station_id, force=force)
481
+ self._get_metadata_store_client().delete_test_station(request)
482
+
483
+ def batch_delete_test_stations(
484
+ self, test_station_ids: Iterable[str], *, force: bool = False
485
+ ) -> None:
486
+ """Delete test stations by ID; force applies to every requested ID."""
487
+ request = BatchDeleteTestStationsRequest(
488
+ requests=[
489
+ DeleteTestStationRequest(test_station_id=test_station_id, force=force)
490
+ for test_station_id in test_station_ids
491
+ ]
492
+ )
493
+ self._get_metadata_store_client().batch_delete_test_stations(request)
494
+
384
495
  def create_hardware_item(self, hardware_item: HardwareItem) -> str:
385
496
  """Create a hardware item in the metadata store.
386
497
 
@@ -416,6 +527,23 @@ class MetadataStoreClient:
416
527
  for hardware_item in query_response.hardware_items
417
528
  ]
418
529
 
530
+ def delete_hardware_item(self, hardware_item_id: str, *, force: bool = False) -> None:
531
+ """Delete a hardware item by ID, optionally removing references."""
532
+ request = DeleteHardwareItemRequest(hardware_item_id=hardware_item_id, force=force)
533
+ self._get_metadata_store_client().delete_hardware_item(request)
534
+
535
+ def batch_delete_hardware_items(
536
+ self, hardware_item_ids: Iterable[str], *, force: bool = False
537
+ ) -> None:
538
+ """Delete hardware items by ID; force applies to every requested ID."""
539
+ request = BatchDeleteHardwareItemsRequest(
540
+ requests=[
541
+ DeleteHardwareItemRequest(hardware_item_id=hardware_item_id, force=force)
542
+ for hardware_item_id in hardware_item_ids
543
+ ]
544
+ )
545
+ self._get_metadata_store_client().batch_delete_hardware_items(request)
546
+
419
547
  def create_software_item(self, software_item: SoftwareItem) -> str:
420
548
  """Create a software item in the metadata store.
421
549
 
@@ -451,6 +579,23 @@ class MetadataStoreClient:
451
579
  for software_item in query_response.software_items
452
580
  ]
453
581
 
582
+ def delete_software_item(self, software_item_id: str, *, force: bool = False) -> None:
583
+ """Delete a software item by ID, optionally removing references."""
584
+ request = DeleteSoftwareItemRequest(software_item_id=software_item_id, force=force)
585
+ self._get_metadata_store_client().delete_software_item(request)
586
+
587
+ def batch_delete_software_items(
588
+ self, software_item_ids: Iterable[str], *, force: bool = False
589
+ ) -> None:
590
+ """Delete software items by ID; force applies to every requested ID."""
591
+ request = BatchDeleteSoftwareItemsRequest(
592
+ requests=[
593
+ DeleteSoftwareItemRequest(software_item_id=software_item_id, force=force)
594
+ for software_item_id in software_item_ids
595
+ ]
596
+ )
597
+ self._get_metadata_store_client().batch_delete_software_items(request)
598
+
454
599
  def create_test_adapter(self, test_adapter: TestAdapter) -> str:
455
600
  """Create a test adapter in the metadata store.
456
601
 
@@ -485,6 +630,23 @@ class MetadataStoreClient:
485
630
  TestAdapter.from_protobuf(test_adapter) for test_adapter in query_response.test_adapters
486
631
  ]
487
632
 
633
+ def delete_test_adapter(self, test_adapter_id: str, *, force: bool = False) -> None:
634
+ """Delete a test adapter by ID, optionally removing references."""
635
+ request = DeleteTestAdapterRequest(test_adapter_id=test_adapter_id, force=force)
636
+ self._get_metadata_store_client().delete_test_adapter(request)
637
+
638
+ def batch_delete_test_adapters(
639
+ self, test_adapter_ids: Iterable[str], *, force: bool = False
640
+ ) -> None:
641
+ """Delete test adapters by ID; force applies to every requested ID."""
642
+ request = BatchDeleteTestAdaptersRequest(
643
+ requests=[
644
+ DeleteTestAdapterRequest(test_adapter_id=test_adapter_id, force=force)
645
+ for test_adapter_id in test_adapter_ids
646
+ ]
647
+ )
648
+ self._get_metadata_store_client().batch_delete_test_adapters(request)
649
+
488
650
  def register_schema_from_file(self, schema_file_path: Path | str) -> str:
489
651
  """Register a schema obtained from the specified file in the metadata store.
490
652
 
@@ -531,6 +693,18 @@ class MetadataStoreClient:
531
693
  list_response = self._get_metadata_store_client().list_schemas(list_request)
532
694
  return [ExtensionSchema.from_protobuf(schema) for schema in list_response.schemas]
533
695
 
696
+ def delete_schema(self, schema_id: str) -> None:
697
+ """Delete a schema by ID and clear its metadata associations."""
698
+ request = DeleteSchemaRequest(schema_id=schema_id)
699
+ self._get_metadata_store_client().delete_schema(request)
700
+
701
+ def batch_delete_schemas(self, schema_ids: Iterable[str]) -> None:
702
+ """Delete schemas by ID and clear their metadata associations."""
703
+ request = BatchDeleteSchemasRequest(
704
+ requests=[DeleteSchemaRequest(schema_id=schema_id) for schema_id in schema_ids]
705
+ )
706
+ self._get_metadata_store_client().batch_delete_schemas(request)
707
+
534
708
  def get_alias(self, alias_name: str) -> Alias:
535
709
  """Get an alias and its target (the underlying metadata it represents).
536
710
 
@@ -628,6 +802,15 @@ class MetadataStoreClient:
628
802
  delete_response = self._get_metadata_store_client().delete_alias(delete_request)
629
803
  return delete_response.unregistered
630
804
 
805
+ def batch_delete_aliases(self, alias_names: Iterable[str]) -> None:
806
+ """Delete aliases by name without deleting their target metadata."""
807
+ if isinstance(alias_names, str):
808
+ raise TypeError("alias_names must be an iterable of alias names, not a single string.")
809
+ request = BatchDeleteAliasesRequest(
810
+ requests=[DeleteAliasRequest(alias_name=alias_name) for alias_name in alias_names]
811
+ )
812
+ self._get_metadata_store_client().batch_delete_aliases(request)
813
+
631
814
  def create_from_json_file(self, metadata_file_path: Path | str) -> MetadataItems:
632
815
  """Create metadata items from a JSON file.
633
816
 
@@ -1,29 +0,0 @@
1
- """Query results data type for the V2 Data Store Client."""
2
-
3
- from __future__ import annotations
4
-
5
- from collections.abc import Iterable
6
- from typing import TypeVar
7
-
8
- T = TypeVar("T")
9
-
10
-
11
- class QueryResults(list[T]):
12
- """One page of query results with a continuation link when more results exist.
13
-
14
- Page size is not configured by this class; it contains the items and link
15
- returned by the query.
16
- """
17
-
18
- next_link: str
19
- """The link for retrieving the next page, or an empty string when there is none."""
20
-
21
- def __init__(self, items: Iterable[T] = (), next_link: str = "") -> None:
22
- """Initialize a QueryResults instance.
23
-
24
- Args:
25
- items: The results on this page.
26
- next_link: The OData link to the next page, or an empty string.
27
- """
28
- super().__init__(items)
29
- self.next_link = next_link