ni.measurements.data.v2.client 1.0.0.dev0__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.
@@ -0,0 +1,58 @@
1
+ Metadata-Version: 2.4
2
+ Name: ni.measurements.data.v2.client
3
+ Version: 1.0.0.dev0
4
+ Summary: gRPC Client for NI Data Store Service
5
+ License-Expression: MIT
6
+ Keywords: data-store,client
7
+ Author: NI
8
+ Author-email: opensource@ni.com
9
+ Requires-Python: >=3.11,<4.0
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Manufacturing
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Operating System :: Microsoft :: Windows
16
+ Classifier: Operating System :: POSIX :: Linux
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Programming Language :: Python :: 3.14
22
+ Classifier: Programming Language :: Python :: 3.15
23
+ Classifier: Programming Language :: Python :: Implementation :: CPython
24
+ Requires-Dist: grpcio (>=1.67.0,<2.0)
25
+ Requires-Dist: ni-grpc-extensions (>=1.1.0)
26
+ Requires-Dist: ni-measurementlink-discovery-v1-client (>=1.1.0)
27
+ Requires-Dist: ni-measurements-data-v2-proto[grpc] (>=1.0.0.dev0)
28
+ Project-URL: Repository, https://github.com/ni/ni-apis-python
29
+ Description-Content-Type: text/markdown
30
+
31
+ # Table of Contents
32
+
33
+ - [Table of Contents](#table-of-contents)
34
+ - [About](#about)
35
+ - [Operating System Support](#operating-system-support)
36
+ - [Python Version Support](#python-version-support)
37
+ - [Installation](#installation)
38
+
39
+ # About
40
+
41
+ `ni.measurements.data.v2.client` is a Python package that provides a gRPC
42
+ client for the NI Data Store Service, version 2.
43
+
44
+ NI created and supports this package.
45
+
46
+ ## Operating System Support
47
+
48
+ `ni.measurements.data.v2.client` supports Windows and Linux operating systems.
49
+
50
+ ## Python Version Support
51
+
52
+ `ni.measurements.data.v2.client` supports CPython 3.10+.
53
+
54
+ ## Installation
55
+
56
+ You can directly install the `ni.measurements.data.v2.client` package using
57
+ `pip` or by listing it as a dependency in your project's `pyproject.toml` file.
58
+
@@ -0,0 +1,27 @@
1
+ # Table of Contents
2
+
3
+ - [Table of Contents](#table-of-contents)
4
+ - [About](#about)
5
+ - [Operating System Support](#operating-system-support)
6
+ - [Python Version Support](#python-version-support)
7
+ - [Installation](#installation)
8
+
9
+ # About
10
+
11
+ `ni.measurements.data.v2.client` is a Python package that provides a gRPC
12
+ client for the NI Data Store Service, version 2.
13
+
14
+ NI created and supports this package.
15
+
16
+ ## Operating System Support
17
+
18
+ `ni.measurements.data.v2.client` supports Windows and Linux operating systems.
19
+
20
+ ## Python Version Support
21
+
22
+ `ni.measurements.data.v2.client` supports CPython 3.10+.
23
+
24
+ ## Installation
25
+
26
+ You can directly install the `ni.measurements.data.v2.client` package using
27
+ `pip` or by listing it as a dependency in your project's `pyproject.toml` file.
@@ -0,0 +1,101 @@
1
+ [project]
2
+ name = "ni.measurements.data.v2.client"
3
+ version = "1.0.0.dev0"
4
+ license = "MIT"
5
+ description = "gRPC Client for NI Data Store Service"
6
+ authors = [{name = "NI", email = "opensource@ni.com"}]
7
+ readme = "README.md"
8
+ keywords = ["data-store", "client"]
9
+ classifiers = [
10
+ "Development Status :: 3 - Alpha",
11
+ "Intended Audience :: Developers",
12
+ "Intended Audience :: Manufacturing",
13
+ "Intended Audience :: Science/Research",
14
+ "License :: OSI Approved :: MIT License",
15
+ "Operating System :: Microsoft :: Windows",
16
+ "Operating System :: POSIX :: Linux",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3.11",
19
+ "Programming Language :: Python :: 3.12",
20
+ "Programming Language :: Python :: 3.13",
21
+ "Programming Language :: Python :: 3.14",
22
+ "Programming Language :: Python :: 3.15",
23
+ "Programming Language :: Python :: Implementation :: CPython",
24
+ ]
25
+ dynamic = ["dependencies"]
26
+ requires-python = '>=3.11,<4.0'
27
+
28
+ [project.urls]
29
+ repository = "https://github.com/ni/ni-apis-python"
30
+
31
+ [tool.poetry]
32
+ packages = [{include = "ni", from = "src"}]
33
+ requires-poetry = '>=2.1,<3.0'
34
+
35
+ [tool.poetry.dependencies]
36
+ grpcio = { version = ">=1.67.0,<2.0" }
37
+ ni-grpc-extensions = { version = ">=1.1.0" }
38
+ ni-measurementlink-discovery-v1-client = { version = ">=1.1.0" }
39
+ ni-measurements-data-v2-proto = { version = ">=1.0.0.dev0", allow-prereleases = true, extras = ["grpc"] }
40
+
41
+ [tool.poetry.group.dev.dependencies]
42
+ types-grpcio = ">=1.0"
43
+ types-protobuf = ">=5.27.2"
44
+ ni-grpc-extensions = { path = "../ni-grpc-extensions", develop = true }
45
+ ni-measurementlink-discovery-v1-client = { path = "../ni.measurementlink.discovery.v1.client", develop = true }
46
+ ni-measurements-data-v2-proto = { path = "../ni.measurements.data.v2.proto", develop = true }
47
+
48
+ [tool.poetry.group.lint.dependencies]
49
+ bandit = { version = ">=1.7", extras = ["toml"] }
50
+ ni-python-styleguide = ">=0.4.1"
51
+ mypy = ">=1.0"
52
+ pyright = { version = ">=1.1.400", extras = ["nodejs"] }
53
+
54
+ [tool.poetry.group.test.dependencies]
55
+ pytest = ">=7.2"
56
+ pytest-cov = ">=4.0"
57
+ pytest-doctestplus = ">=1.4"
58
+ pytest-mock = ">=3.0"
59
+
60
+ [tool.poetry.group.docs]
61
+ optional = true
62
+
63
+ [tool.poetry.group.docs.dependencies]
64
+ Sphinx = ">=8.2"
65
+ sphinx-rtd-theme = ">=1.0.0"
66
+ sphinx-autoapi = ">=1.8.4"
67
+ m2r2 = ">=0.3.2"
68
+ toml = ">=0.10.2"
69
+
70
+ [build-system]
71
+ requires = ["poetry-core>=2.1.0,<3.0"]
72
+ build-backend = "poetry.core.masonry.api"
73
+
74
+
75
+ [tool.bandit]
76
+ skips = [
77
+ "B101", # assert_used
78
+ ]
79
+
80
+ [tool.ni-python-styleguide]
81
+ extend_exclude = "docs"
82
+ application-import-names = "ni.measurements.data.v2.client"
83
+
84
+ [tool.black]
85
+ extend-exclude = 'docs/'
86
+ line-length = 100
87
+
88
+ [tool.mypy]
89
+ mypy_path = "src"
90
+ files = "."
91
+ namespace_packages = true
92
+ strict = true
93
+ explicit_package_bases = true
94
+ exclude = ["docs"]
95
+
96
+ [tool.pyright]
97
+ include = ["src/", "tests/"]
98
+
99
+ [tool.pytest.ini_options]
100
+ addopts = "--doctest-modules --doctest-plus --strict-markers"
101
+ testpaths = ["tests"]
@@ -0,0 +1,5 @@
1
+ """Public API for accessing the NI Data Store Service."""
2
+
3
+ from ni.measurements.data.v2.client._client import DataStoreClient
4
+
5
+ __all__ = ["DataStoreClient"]
@@ -0,0 +1,221 @@
1
+ """Client for accessing the NI Data Store Service."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import grpc
6
+ from google.protobuf import empty_pb2
7
+ from ni.measurementlink.discovery.v1.client import DiscoveryClient
8
+ from ni.measurements.data.v2 import data_store_pb2, data_store_service_pb2
9
+ from ni.measurements.data.v2.data_store_service_pb2_grpc import DataStoreServiceStub
10
+ from ni_grpc_extensions.channelpool import GrpcChannelPool
11
+
12
+ from ni.measurements.data.v2.client._client_base import GrpcServiceClientBase
13
+
14
+
15
+ class DataStoreClient(GrpcServiceClientBase[DataStoreServiceStub]):
16
+ """Client for accessing the NI Data Store Service."""
17
+
18
+ __slots__ = ()
19
+
20
+ def __init__(
21
+ self,
22
+ *,
23
+ discovery_client: DiscoveryClient | None = None,
24
+ grpc_channel: grpc.Channel | None = None,
25
+ grpc_channel_pool: GrpcChannelPool | None = None,
26
+ ) -> None:
27
+ """Initialize the Data Store Client.
28
+
29
+ Args:
30
+ discovery_client: An optional discovery client (recommended).
31
+
32
+ grpc_channel: An optional data store gRPC channel.
33
+
34
+ grpc_channel_pool: An optional gRPC channel pool (recommended).
35
+ """
36
+ super().__init__(
37
+ discovery_client=discovery_client,
38
+ grpc_channel=grpc_channel,
39
+ grpc_channel_pool=grpc_channel_pool,
40
+ service_interface_name="ni.measurements.data.v2.DataStoreService",
41
+ service_class="",
42
+ stub_class=DataStoreServiceStub,
43
+ )
44
+
45
+ def create_test_result(
46
+ self, request: data_store_service_pb2.CreateTestResultRequest
47
+ ) -> data_store_pb2.TestResult:
48
+ """Create a test result object for publishing measurements."""
49
+ return self._get_stub().CreateTestResult(request)
50
+
51
+ def batch_create_test_results(
52
+ self, request: data_store_service_pb2.BatchCreateTestResultsRequest
53
+ ) -> data_store_service_pb2.BatchCreateTestResultsResponse:
54
+ """Create multiple test results at once."""
55
+ return self._get_stub().BatchCreateTestResults(request)
56
+
57
+ def get_test_result(
58
+ self, request: data_store_service_pb2.GetTestResultRequest
59
+ ) -> data_store_pb2.TestResult:
60
+ """Get the test result associated with the identifier given in the request."""
61
+ return self._get_stub().GetTestResult(request)
62
+
63
+ def query_test_results(
64
+ self, request: data_store_service_pb2.QueryTestResultsRequest
65
+ ) -> data_store_service_pb2.QueryTestResultsResponse:
66
+ """Query for test results matching the given OData query."""
67
+ return self._get_stub().QueryTestResults(request)
68
+
69
+ def update_test_result(
70
+ self, request: data_store_service_pb2.UpdateTestResultRequest
71
+ ) -> data_store_pb2.TestResult:
72
+ """Update the test result associated with the identifier given in the request."""
73
+ return self._get_stub().UpdateTestResult(request)
74
+
75
+ def batch_update_test_results(
76
+ self, request: data_store_service_pb2.BatchUpdateTestResultsRequest
77
+ ) -> data_store_service_pb2.BatchUpdateTestResultsResponse:
78
+ """Update multiple test results at once."""
79
+ return self._get_stub().BatchUpdateTestResults(request)
80
+
81
+ def add_test_result_metadata(
82
+ self, request: data_store_service_pb2.AddTestResultMetadataRequest
83
+ ) -> data_store_service_pb2.AddTestResultMetadataResponse:
84
+ """Add metadata to the test result identified by the request."""
85
+ return self._get_stub().AddTestResultMetadata(request)
86
+
87
+ def remove_test_result_metadata(
88
+ self, request: data_store_service_pb2.RemoveTestResultMetadataRequest
89
+ ) -> data_store_service_pb2.RemoveTestResultMetadataResponse:
90
+ """Remove metadata from the test result identified by the request."""
91
+ return self._get_stub().RemoveTestResultMetadata(request)
92
+
93
+ def delete_test_result(
94
+ self, request: data_store_service_pb2.DeleteTestResultRequest
95
+ ) -> empty_pb2.Empty:
96
+ """Delete the test result associated with the identifier given in the request."""
97
+ return self._get_stub().DeleteTestResult(request)
98
+
99
+ def batch_delete_test_results(
100
+ self, request: data_store_service_pb2.BatchDeleteTestResultsRequest
101
+ ) -> data_store_service_pb2.BatchDeleteTestResultsResponse:
102
+ """Delete multiple test results at once."""
103
+ return self._get_stub().BatchDeleteTestResults(request)
104
+
105
+ def create_step(self, request: data_store_service_pb2.CreateStepRequest) -> data_store_pb2.Step:
106
+ """Create a new step in the data store."""
107
+ return self._get_stub().CreateStep(request)
108
+
109
+ def batch_create_steps(
110
+ self, request: data_store_service_pb2.BatchCreateStepsRequest
111
+ ) -> data_store_service_pb2.BatchCreateStepsResponse:
112
+ """Create multiple steps at once."""
113
+ return self._get_stub().BatchCreateSteps(request)
114
+
115
+ def get_step(self, request: data_store_service_pb2.GetStepRequest) -> data_store_pb2.Step:
116
+ """Get the step associated with the identifier given in the request."""
117
+ return self._get_stub().GetStep(request)
118
+
119
+ def query_steps(
120
+ self, request: data_store_service_pb2.QueryStepsRequest
121
+ ) -> data_store_service_pb2.QueryStepsResponse:
122
+ """Query for steps matching the given OData query."""
123
+ return self._get_stub().QuerySteps(request)
124
+
125
+ def update_step(self, request: data_store_service_pb2.UpdateStepRequest) -> data_store_pb2.Step:
126
+ """Update the step associated with the identifier given in the request."""
127
+ return self._get_stub().UpdateStep(request)
128
+
129
+ def batch_update_steps(
130
+ self, request: data_store_service_pb2.BatchUpdateStepsRequest
131
+ ) -> data_store_service_pb2.BatchUpdateStepsResponse:
132
+ """Update multiple steps at once."""
133
+ return self._get_stub().BatchUpdateSteps(request)
134
+
135
+ def add_condition(
136
+ self, request: data_store_service_pb2.AddConditionRequest
137
+ ) -> data_store_service_pb2.AddConditionResponse:
138
+ """Add a condition to the step associated with the identifier given in the request."""
139
+ return self._get_stub().AddCondition(request)
140
+
141
+ def remove_condition(
142
+ self, request: data_store_service_pb2.RemoveConditionRequest
143
+ ) -> data_store_service_pb2.RemoveConditionResponse:
144
+ """Remove a condition from the step associated with the identifier given in the request."""
145
+ return self._get_stub().RemoveCondition(request)
146
+
147
+ def delete_step(self, request: data_store_service_pb2.DeleteStepRequest) -> empty_pb2.Empty:
148
+ """Delete the step associated with the identifier given in the request."""
149
+ return self._get_stub().DeleteStep(request)
150
+
151
+ def batch_delete_steps(
152
+ self, request: data_store_service_pb2.BatchDeleteStepsRequest
153
+ ) -> data_store_service_pb2.BatchDeleteStepsResponse:
154
+ """Delete multiple steps at once."""
155
+ return self._get_stub().BatchDeleteSteps(request)
156
+
157
+ def create_measurement(
158
+ self, request: data_store_service_pb2.CreateMeasurementRequest
159
+ ) -> data_store_pb2.Measurement:
160
+ """Create a new measurement in the data store."""
161
+ return self._get_stub().CreateMeasurement(request)
162
+
163
+ def batch_create_measurements(
164
+ self, request: data_store_service_pb2.BatchCreateMeasurementsRequest
165
+ ) -> data_store_service_pb2.BatchCreateMeasurementsResponse:
166
+ """Create multiple measurements at once."""
167
+ return self._get_stub().BatchCreateMeasurements(request)
168
+
169
+ def get_measurement(
170
+ self, request: data_store_service_pb2.GetMeasurementRequest
171
+ ) -> data_store_pb2.Measurement:
172
+ """Get the measurement associated with the identifier given in the request."""
173
+ return self._get_stub().GetMeasurement(request)
174
+
175
+ def query_measurements(
176
+ self, request: data_store_service_pb2.QueryMeasurementsRequest
177
+ ) -> data_store_service_pb2.QueryMeasurementsResponse:
178
+ """Query measurements using OData query syntax."""
179
+ return self._get_stub().QueryMeasurements(request)
180
+
181
+ def update_measurement(
182
+ self, request: data_store_service_pb2.UpdateMeasurementRequest
183
+ ) -> data_store_pb2.Measurement:
184
+ """Update the measurement associated with the identifier given in the request."""
185
+ return self._get_stub().UpdateMeasurement(request)
186
+
187
+ def batch_update_measurements(
188
+ self, request: data_store_service_pb2.BatchUpdateMeasurementsRequest
189
+ ) -> data_store_service_pb2.BatchUpdateMeasurementsResponse:
190
+ """Update multiple measurements at once."""
191
+ return self._get_stub().BatchUpdateMeasurements(request)
192
+
193
+ def add_measurement_metadata(
194
+ self, request: data_store_service_pb2.AddMeasurementMetadataRequest
195
+ ) -> data_store_service_pb2.AddMeasurementMetadataResponse:
196
+ """Add metadata to the measurement identified by the request."""
197
+ return self._get_stub().AddMeasurementMetadata(request)
198
+
199
+ def remove_measurement_metadata(
200
+ self, request: data_store_service_pb2.RemoveMeasurementMetadataRequest
201
+ ) -> data_store_service_pb2.RemoveMeasurementMetadataResponse:
202
+ """Remove metadata from the measurement identified by the request."""
203
+ return self._get_stub().RemoveMeasurementMetadata(request)
204
+
205
+ def delete_measurement(
206
+ self, request: data_store_service_pb2.DeleteMeasurementRequest
207
+ ) -> empty_pb2.Empty:
208
+ """Delete the measurement associated with the identifier given in the request."""
209
+ return self._get_stub().DeleteMeasurement(request)
210
+
211
+ def batch_delete_measurements(
212
+ self, request: data_store_service_pb2.BatchDeleteMeasurementsRequest
213
+ ) -> data_store_service_pb2.BatchDeleteMeasurementsResponse:
214
+ """Delete multiple measurements at once."""
215
+ return self._get_stub().BatchDeleteMeasurements(request)
216
+
217
+ def read_measurement_values(
218
+ self, request: data_store_service_pb2.ReadMeasurementValuesRequest
219
+ ) -> data_store_service_pb2.ReadMeasurementValuesResponse:
220
+ """Read the value and limits of a measurement selected by the read mask."""
221
+ return self._get_stub().ReadMeasurementValues(request)
@@ -0,0 +1,135 @@
1
+ from __future__ import annotations
2
+
3
+ import logging
4
+ import sys
5
+ import threading
6
+ from types import TracebackType
7
+ from typing import TYPE_CHECKING, Generic, Protocol, TypeVar
8
+
9
+ import grpc
10
+ from ni.measurementlink.discovery.v1.client import DiscoveryClient
11
+ from ni_grpc_extensions.channelpool import GrpcChannelPool
12
+
13
+ if TYPE_CHECKING:
14
+ if sys.version_info >= (3, 11):
15
+ from typing import Self
16
+ else:
17
+ from typing_extensions import Self
18
+
19
+ _logger = logging.getLogger(__name__)
20
+
21
+
22
+ class StubProtocol(Protocol):
23
+ """Protocol for gRPC stub classes."""
24
+
25
+ def __init__(self, channel: grpc.Channel) -> None:
26
+ """Initialize the gRPC client."""
27
+
28
+
29
+ TStub = TypeVar("TStub", bound=StubProtocol)
30
+
31
+
32
+ class GrpcServiceClientBase(Generic[TStub]):
33
+ """Base class for NI gRPC service clients."""
34
+
35
+ __slots__ = (
36
+ "_lock",
37
+ "_owns_grpc_channel_pool",
38
+ "_discovery_client",
39
+ "_grpc_channel_pool",
40
+ "_stub",
41
+ "_service_interface_name",
42
+ "_service_class",
43
+ "_stub_class",
44
+ )
45
+
46
+ _lock: threading.Lock
47
+ _owns_grpc_channel_pool: bool
48
+ _discovery_client: DiscoveryClient | None
49
+ _grpc_channel_pool: GrpcChannelPool | None
50
+ _stub: TStub | None
51
+ _service_interface_name: str
52
+ _service_class: str
53
+ _stub_class: type[TStub]
54
+
55
+ def __init__(
56
+ self,
57
+ service_interface_name: str,
58
+ service_class: str,
59
+ stub_class: type[TStub],
60
+ *,
61
+ discovery_client: DiscoveryClient | None = None,
62
+ grpc_channel: grpc.Channel | None = None,
63
+ grpc_channel_pool: GrpcChannelPool | None = None,
64
+ ) -> None:
65
+ """Initialize the gRPC client.
66
+
67
+ Args:
68
+ service_interface_name: The fully qualified name of the service interface.
69
+ service_class: The name of the service class.
70
+ stub_class: The gRPC stub class for the service.
71
+ discovery_client: An optional discovery client (recommended).
72
+ grpc_channel: An optional pin map gRPC channel.
73
+ grpc_channel_pool: An optional gRPC channel pool (recommended).
74
+ """
75
+ self._lock = threading.Lock()
76
+ self._owns_grpc_channel_pool = False
77
+ self._discovery_client = discovery_client
78
+ self._grpc_channel_pool = grpc_channel_pool
79
+ self._stub = stub_class(grpc_channel) if grpc_channel is not None else None
80
+ self._service_interface_name = service_interface_name
81
+ self._service_class = service_class
82
+ self._stub_class = stub_class
83
+
84
+ def __enter__(self) -> Self:
85
+ """Enter the runtime context of the GrpcServiceClientBase."""
86
+ return self
87
+
88
+ def __exit__(
89
+ self,
90
+ exc_type: type[BaseException] | None,
91
+ exc_val: BaseException | None,
92
+ traceback: TracebackType | None,
93
+ ) -> None:
94
+ """Exit the runtime context of the GrpcServiceClientBase."""
95
+ self.close()
96
+
97
+ def close(self) -> None:
98
+ """Close the client and clean up resources that it owns."""
99
+ with self._lock:
100
+ self._stub = None
101
+ self._discovery_client = None
102
+ if self._owns_grpc_channel_pool and self._grpc_channel_pool:
103
+ self._grpc_channel_pool.close()
104
+ self._grpc_channel_pool = None
105
+ self._owns_grpc_channel_pool = False
106
+
107
+ def _get_stub(self) -> TStub:
108
+ if self._stub is None:
109
+ with self._lock:
110
+ if self._grpc_channel_pool is None:
111
+ _logger.debug("Creating unshared GrpcChannelPool.")
112
+ self._grpc_channel_pool = GrpcChannelPool()
113
+ self._owns_grpc_channel_pool = True
114
+
115
+ if self._discovery_client is None:
116
+ _logger.debug("Creating unshared DiscoveryClient.")
117
+ self._discovery_client = DiscoveryClient(
118
+ grpc_channel_pool=self._grpc_channel_pool
119
+ )
120
+
121
+ if self._stub is None:
122
+ compute_nodes = self._discovery_client.enumerate_compute_nodes()
123
+ remote_nodes = [node for node in compute_nodes if not node.is_local]
124
+ target_url = remote_nodes[0].url if len(remote_nodes) == 1 else ""
125
+
126
+ service_location = self._discovery_client.resolve_service(
127
+ provided_interface=self._service_interface_name,
128
+ deployment_target=target_url,
129
+ service_class=self._service_class,
130
+ )
131
+
132
+ channel = self._grpc_channel_pool.get_channel(service_location.insecure_address)
133
+ self._stub = self._stub_class(channel)
134
+
135
+ return self._stub