ni.datamonikers.v1.client 0.1.0.dev0__tar.gz

ni_datamonikers_v1_client-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.3
+Name: ni.datamonikers.v1.client
+Version: 0.1.0.dev0
+Summary: gRPC Client for NI Data Moniker Service
+License: MIT
+Keywords: data-moniker,client
+Author: NI
+Author-email: opensource@ni.com
+Maintainer: Joe Friedrichsen
+Maintainer-email: joe.friedrichsen@emerson.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: ni-datamonikers-v1-proto (>=0.1.0.dev0)
+Requires-Dist: ni-grpc-extensions (>=0.1.0.dev0)
+Project-URL: Repository, https://github.com/ni/ni-apis-python
+Description-Content-Type: text/markdown
+
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# About
+
+`ni.datamonikers.v1.client` is a Python package that provides a gRPC client for the
+NI Data Moniker Service, version 1. The corresponding service is defined in the
+[ni.datamonikers.v1 package](https://github.com/ni/ni-apis/tree/main/ni/datamonikers/v1).
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.datamonikers.v1.client` supports Windows operating systems.
+
+## Python Version Support
+
+`ni.datamonikers.v1.client` supports CPython 3.9+.
+
+## Installation
+
+You can directly install the `ni.datamonikers.v1.client` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.

ni_datamonikers_v1_client-0.1.0.dev0/README.md

@@ -0,0 +1,27 @@
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+  - [Operating System Support](#operating-system-support)
+  - [Python Version Support](#python-version-support)
+
+# About
+
+`ni.datamonikers.v1.client` is a Python package that provides a gRPC client for the
+NI Data Moniker Service, version 1. The corresponding service is defined in the
+[ni.datamonikers.v1 package](https://github.com/ni/ni-apis/tree/main/ni/datamonikers/v1).
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.datamonikers.v1.client` supports Windows operating systems.
+
+## Python Version Support
+
+`ni.datamonikers.v1.client` supports CPython 3.9+.
+
+## Installation
+
+You can directly install the `ni.datamonikers.v1.client` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.

ni_datamonikers_v1_client-0.1.0.dev0/pyproject.toml

@@ -0,0 +1,106 @@
+[project]
+name = "ni.datamonikers.v1.client"
+version = "0.1.0-dev0"
+license = "MIT"
+description = "gRPC Client for NI Data Moniker Service"
+authors = [{name = "NI", email = "opensource@ni.com"}]
+maintainers = [
+  {name = "Joe Friedrichsen", email = "joe.friedrichsen@emerson.com"},
+  {name = "Brad Keryan", email = "brad.keryan@emerson.com"}
+]
+readme = "README.md"
+keywords = ["data-moniker", "client"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Manufacturing",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: Microsoft :: Windows",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: CPython",
+]
+dynamic = ["dependencies"]
+requires-python = '>=3.9,<4.0'
+
+[project.urls]
+repository = "https://github.com/ni/ni-apis-python"
+
+[tool.poetry]
+packages = [{include = "ni", from = "src"}]
+requires-poetry = '>=2.1,<3.0'
+
+[tool.poetry.dependencies]
+ni-grpc-extensions = { version = ">=0.1.0.dev0", allow-prereleases = true }
+ni-datamonikers-v1-proto = { version = ">=0.1.0.dev0", allow-prereleases = true }
+
+[tool.poetry.group.dev.dependencies]
+types-grpcio = ">=1.0"
+types-protobuf = ">=4.21"
+ni-grpc-extensions = { path = "../ni-grpc-extensions", develop = true }
+ni-datamonikers-v1-proto = { path = "../ni.datamonikers.v1.proto", develop = true }
+
+[tool.poetry.group.lint.dependencies]
+bandit = { version = ">=1.7", extras = ["toml"] }
+ni-python-styleguide = ">=0.4.1"
+mypy = ">=1.0"
+pyright = { version = ">=1.1.400", extras = ["nodejs"] }
+
+[tool.poetry.group.test.dependencies]
+pytest = ">=7.2"
+pytest-cov = ">=4.0"
+pytest-doctestplus = ">=1.4"
+pytest-mock = ">=3.0"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+# The latest Sphinx requires a recent Python version.
+Sphinx = [
+  { version = ">=7.4", python = ">=3.9,<3.10" },
+  { version = ">=8.1", python = ">=3.10,<3.11" },
+  { version = ">=8.2", python = "^3.11" },
+]
+sphinx-rtd-theme = ">=1.0.0"
+sphinx-autoapi = ">=1.8.4"
+m2r2 = ">=0.3.2"
+toml = ">=0.10.2"
+
+[build-system]
+requires = ["poetry-core>=2.1.0,<3.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.bandit]
+skips = [
+  "B101", # assert_used
+]
+
+[tool.ni-python-styleguide]
+extend_exclude = "docs"
+application-import-names = "ni.datamonikers.v1.client"
+
+[tool.black]
+extend-exclude = 'docs/'
+line-length = 100
+
+[tool.mypy]
+mypy_path = "src"
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+exclude = ["docs"]
+
+[tool.pyright]
+include = ["src/", "tests/"]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --doctest-plus --strict-markers"
+testpaths = ["tests"]

ni_datamonikers_v1_client-0.1.0.dev0/src/ni/datamonikers/v1/client/__init__.py

@@ -0,0 +1,5 @@
+"""Public API for accessing the NI Data Moniker Service."""
+
+from ni.datamonikers.v1.client._client import MonikerClient
+
+__all__ = ["MonikerClient"]

ni_datamonikers_v1_client-0.1.0.dev0/src/ni/datamonikers/v1/client/_client.py

@@ -0,0 +1,110 @@
+"""Client for accessing the NI Data Moniker Service."""
+
+from __future__ import annotations
+
+import logging
+import threading
+from typing import Iterator
+
+import grpc
+import ni.datamonikers.v1.data_moniker_pb2 as data_moniker_pb2
+import ni.datamonikers.v1.data_moniker_pb2_grpc as data_moniker_pb2_grpc
+from ni_grpc_extensions.channelpool import GrpcChannelPool
+
+_logger = logging.getLogger(__name__)
+
+
+class MonikerClient:
+    """Client for accessing the NI Data Moniker Service."""
+
+    __slots__ = (
+        "_initialization_lock",
+        "_service_location",
+        "_grpc_channel_pool",
+        "_stub",
+    )
+
+    _initialization_lock: threading.Lock
+    _service_location: str | None
+    _grpc_channel_pool: GrpcChannelPool | None
+    _stub: data_moniker_pb2_grpc.MonikerServiceStub | None
+
+    def __init__(
+        self,
+        *,
+        service_location: str | None = None,
+        grpc_channel: grpc.Channel | None = None,
+        grpc_channel_pool: GrpcChannelPool | None = None,
+    ) -> None:
+        """Initialize the Moniker Client.
+
+        Args:
+            service_location: The address of the data moniker service location (recommended).
+
+            grpc_channel: A data moniker gRPC channel (optional).
+
+            grpc_channel_pool: A gRPC channel pool (recommended).
+
+        Either `service_location` or `grpc_channel` must be provided. If both are provided,
+        `grpc_channel` takes precedence.
+        """
+        if service_location is None and grpc_channel is None:
+            raise ValueError("Either 'service_location' or 'grpc_channel' must be provided.")
+
+        self._initialization_lock = threading.Lock()
+        self._service_location = service_location
+        self._grpc_channel_pool = grpc_channel_pool
+        self._stub = (
+            data_moniker_pb2_grpc.MonikerServiceStub(grpc_channel)
+            if grpc_channel is not None
+            else None
+        )
+
+    def _get_stub(self) -> data_moniker_pb2_grpc.MonikerServiceStub:
+        if self._stub is None:
+            with self._initialization_lock:
+                if self._grpc_channel_pool is None:
+                    _logger.debug("Creating unshared GrpcChannelPool.")
+                    self._grpc_channel_pool = GrpcChannelPool()
+
+                if self._stub is None:
+                    channel = self._grpc_channel_pool.get_channel(self._service_location)  # type: ignore
+                    self._stub = data_moniker_pb2_grpc.MonikerServiceStub(channel)
+
+        return self._stub
+
+    def begin_sideband_stream(
+        self, request: data_moniker_pb2.BeginMonikerSidebandStreamRequest
+    ) -> data_moniker_pb2.BeginMonikerSidebandStreamResponse:
+        """Begin a sideband stream."""
+        return self._get_stub().BeginSidebandStream(request)
+
+    def stream_read(
+        self, moniker_list: data_moniker_pb2.MonikerList
+    ) -> Iterator[data_moniker_pb2.MonikerReadResult]:
+        """Stream read data from monikers."""
+        return self._get_stub().StreamRead(moniker_list)
+
+    def stream_write(
+        self, requests: Iterator[data_moniker_pb2.MonikerWriteRequest]
+    ) -> Iterator[data_moniker_pb2.StreamWriteResponse]:
+        """Stream write data to monikers."""
+        return self._get_stub().StreamWrite(requests)
+
+    def stream_read_write(
+        self, requests: Iterator[data_moniker_pb2.MonikerWriteRequest]
+    ) -> Iterator[data_moniker_pb2.MonikerReadResult]:
+        """Stream read and write data with monikers."""
+        return self._get_stub().StreamReadWrite(requests)
+
+    def read_from_moniker(
+        self, moniker: data_moniker_pb2.Moniker
+    ) -> data_moniker_pb2.ReadFromMonikerResult:
+        """Read data from a moniker."""
+        return self._get_stub().ReadFromMoniker(moniker)
+
+    def write_to_moniker(
+        self, request: data_moniker_pb2.WriteToMonikerRequest
+    ) -> data_moniker_pb2.WriteToMonikerResponse:
+        """Write data to a moniker."""
+        return self._get_stub().WriteToMoniker(request)