ni.measurementlink.sessionmanagement.v1.client 0.1.0.dev0__py3-none-any.whl → 0.1.0.dev2__py3-none-any.whl

ni/measurementlink/sessionmanagement/v1/client/_annotations.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+import os
+import socket
+import sys
+
+from ni.measurementlink.sessionmanagement.v1.annotations import (
+    REGISTERED_HOSTNAME,
+    REGISTERED_IPADDRESS,
+    REGISTERED_USERNAME,
+    RESERVED_HOSTNAME,
+    RESERVED_IPADDRESS,
+    RESERVED_USERNAME,
+)
+
+
+def get_machine_details() -> tuple[dict[str, str], dict[str, str]]:
+    """Get the machine details for reserved and registered annotations."""
+    hostname = _get_hostname()
+    username = _get_username()
+    ip_address = _get_ip_address()
+
+    reserved = {
+        RESERVED_HOSTNAME: hostname,
+        RESERVED_USERNAME: username,
+        RESERVED_IPADDRESS: ip_address,
+    }
+
+    registered = {
+        REGISTERED_HOSTNAME: hostname,
+        REGISTERED_USERNAME: username,
+        REGISTERED_IPADDRESS: ip_address,
+    }
+
+    return reserved, registered
+
+
+def remove_reservation_annotations(annotations: dict[str, str] | None) -> dict[str, str]:
+    """Remove reserved annotations from the provided annotations."""
+    if annotations is None:
+        return {}
+    reservation_keys = {
+        RESERVED_HOSTNAME,
+        RESERVED_USERNAME,
+        RESERVED_IPADDRESS,
+    }
+    return {k: v for k, v in annotations.items() if k not in reservation_keys}
+
+
+def _get_hostname() -> str:
+    if sys.platform == "win32":
+        try:
+            import win32api  # pyright: ignore[reportMissingModuleSource]
+
+            return win32api.GetComputerName()
+        except Exception:
+            return ""
+    else:
+        return socket.gethostname()
+
+
+def _get_username() -> str:
+    if sys.platform == "win32":
+        try:
+            import win32api  # pyright: ignore[reportMissingModuleSource]
+
+            return win32api.GetUserName()
+        except Exception:
+            return ""
+    else:
+        return os.environ.get("USER", "")
+
+
+def _get_ip_address() -> str:
+    try:
+        ipv4_addresses = [
+            info[4][0] for info in socket.getaddrinfo(socket.gethostname(), None, socket.AF_INET)
+        ]
+        return str(ipv4_addresses[0]) if ipv4_addresses else ""
+    except Exception:
+        return ""

ni/measurementlink/sessionmanagement/v1/client/_client.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import logging
-import threading
 import warnings
 from collections.abc import Iterable, Mapping
 
@@ -14,6 +13,13 @@ import ni.measurementlink.sessionmanagement.v1.session_management_service_pb2_gr
 from ni.measurementlink.discovery.v1.client import DiscoveryClient
 from ni_grpc_extensions.channelpool import GrpcChannelPool
 
+from ni.measurementlink.sessionmanagement.v1.client._annotations import (
+    get_machine_details,
+    remove_reservation_annotations,
+)
+from ni.measurementlink.sessionmanagement.v1.client._client_base import (
+    GrpcServiceClientBase,
+)
 from ni.measurementlink.sessionmanagement.v1.client._constants import (
     GRPC_SERVICE_CLASS,
     GRPC_SERVICE_INTERFACE_NAME,
@@ -32,8 +38,12 @@ from ni.measurementlink.sessionmanagement.v1.client._types import (
 _logger = logging.getLogger(__name__)
 
 
-class SessionManagementClient:
-    """Client for accessing the measurement plug-in session management service."""
+class SessionManagementClient(
+    GrpcServiceClientBase[session_management_service_pb2_grpc.SessionManagementServiceStub]
+):
+    """Client for accessing the NI Session Management Service via gRPC."""
+
+    __slots__ = ("_reserved_annotations", "_registered_annotations")
 
     def __init__(
         self,
@@ -42,54 +52,16 @@ class SessionManagementClient:
         grpc_channel: grpc.Channel | None = None,
         grpc_channel_pool: GrpcChannelPool | None = None,
     ) -> None:
-        """Initialize session management client.
-
-        Args:
-            discovery_client: An optional discovery client (recommended).
-
-            grpc_channel: An optional session management gRPC channel.
-
-            grpc_channel_pool: An optional gRPC channel pool (recommended).
-        """
-        self._initialization_lock = threading.Lock()
-        self._discovery_client = discovery_client
-        self._grpc_channel_pool = grpc_channel_pool
-        self._stub: session_management_service_pb2_grpc.SessionManagementServiceStub | None = None
-
-        if grpc_channel is not None:
-            self._stub = session_management_service_pb2_grpc.SessionManagementServiceStub(
-                grpc_channel
-            )
-
-    def _get_stub(self) -> session_management_service_pb2_grpc.SessionManagementServiceStub:
-        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._discovery_client is None:
-                    _logger.debug("Creating unshared DiscoveryClient.")
-                    self._discovery_client = DiscoveryClient(
-                        grpc_channel_pool=self._grpc_channel_pool
-                    )
-                if self._stub is None:
-                    compute_nodes = self._discovery_client.enumerate_compute_nodes()
-                    remote_compute_nodes = [node for node in compute_nodes if not node.is_local]
-                    # Use remote node URL as deployment target if only one remote node is found.
-                    # If more than one remote node exists, use empty string for deployment target.
-                    first_remote_node_url = (
-                        remote_compute_nodes[0].url if len(remote_compute_nodes) == 1 else ""
-                    )
-                    service_location = self._discovery_client.resolve_service(
-                        provided_interface=GRPC_SERVICE_INTERFACE_NAME,
-                        deployment_target=first_remote_node_url,
-                        service_class=GRPC_SERVICE_CLASS,
-                    )
-                    channel = self._grpc_channel_pool.get_channel(service_location.insecure_address)
-                    self._stub = session_management_service_pb2_grpc.SessionManagementServiceStub(
-                        channel
-                    )
-        return self._stub
+        """Initialize a SessionManagementClient instance."""
+        self._reserved_annotations, self._registered_annotations = get_machine_details()
+        super().__init__(
+            discovery_client=discovery_client,
+            grpc_channel=grpc_channel,
+            grpc_channel_pool=grpc_channel_pool,
+            service_interface_name=GRPC_SERVICE_INTERFACE_NAME,
+            service_class=GRPC_SERVICE_CLASS,
+            stub_class=session_management_service_pb2_grpc.SessionManagementServiceStub,
+        )
 
     def reserve_session(
         self,
@@ -214,6 +186,7 @@ class SessionManagementClient:
         request = session_management_service_pb2.ReserveSessionsRequest(
             pin_map_context=context._to_grpc(),
             timeout_in_milliseconds=_timeout_to_milliseconds(timeout),
+            annotations=self._reserved_annotations,
         )
         if instrument_type_id is not None:
             request.instrument_type_id = instrument_type_id
@@ -239,6 +212,15 @@ class SessionManagementClient:
         Args:
             session_info: Sessions to register.
         """
+        session_info = [
+            info._replace(
+                annotations={
+                    **remove_reservation_annotations(info.annotations),
+                    **self._registered_annotations,
+                }
+            )
+            for info in session_info
+        ]
         request = session_management_service_pb2.RegisterSessionsRequest(
             sessions=(info._to_grpc_v1() for info in session_info),
         )
@@ -287,7 +269,8 @@ class SessionManagementClient:
             unreserve them.
         """
         request = session_management_service_pb2.ReserveAllRegisteredSessionsRequest(
-            timeout_in_milliseconds=_timeout_to_milliseconds(timeout)
+            timeout_in_milliseconds=_timeout_to_milliseconds(timeout),
+            annotations=self._reserved_annotations,
         )
         if instrument_type_id is not None:
             request.instrument_type_id = instrument_type_id
@@ -307,6 +290,15 @@ class SessionManagementClient:
         Args:
             multiplexer_session_info: Sessions to register.
         """
+        multiplexer_session_info = [
+            info._replace(
+                annotations={
+                    **remove_reservation_annotations(info.annotations),
+                    **self._registered_annotations,
+                }
+            )
+            for info in multiplexer_session_info
+        ]
         request = session_management_service_pb2.RegisterMultiplexerSessionsRequest(
             multiplexer_sessions=(info._to_grpc_v1() for info in multiplexer_session_info),
         )

ni/measurementlink/sessionmanagement/v1/client/_client_base.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+import logging
+import threading
+from typing import Generic, Protocol, TypeVar
+
+import grpc
+from ni.measurementlink.discovery.v1.client import DiscoveryClient
+from ni_grpc_extensions.channelpool import GrpcChannelPool
+
+_logger = logging.getLogger(__name__)
+
+
+class StubProtocol(Protocol):
+    """Protocol for gRPC stub classes."""
+
+    def __init__(self, channel: grpc.Channel) -> None:
+        """Initialize the gRPC client."""
+
+
+TStub = TypeVar("TStub", bound=StubProtocol)
+
+
+class GrpcServiceClientBase(Generic[TStub]):
+    """Base class for NI gRPC service clients."""
+
+    __slots__ = (
+        "_initialization_lock",
+        "_discovery_client",
+        "_grpc_channel_pool",
+        "_stub",
+        "_service_interface_name",
+        "_service_class",
+        "_stub_class",
+    )
+
+    _initialization_lock: threading.Lock
+    _discovery_client: DiscoveryClient | None
+    _grpc_channel_pool: GrpcChannelPool | None
+    _stub: TStub | None
+    _service_interface_name: str
+    _service_class: str
+    _stub_class: type[TStub]
+
+    def __init__(
+        self,
+        service_interface_name: str,
+        service_class: str,
+        stub_class: type[TStub],
+        *,
+        discovery_client: DiscoveryClient | None = None,
+        grpc_channel: grpc.Channel | None = None,
+        grpc_channel_pool: GrpcChannelPool | None = None,
+    ) -> None:
+        """Initialize the gRPC client.
+
+        Args:
+            service_interface_name: The fully qualified name of the service interface.
+            service_class: The name of the service class.
+            stub_class: The gRPC stub class for the service.
+            discovery_client: An optional discovery client (recommended).
+            grpc_channel: An optional pin map gRPC channel.
+            grpc_channel_pool: An optional gRPC channel pool (recommended).
+        """
+        self._initialization_lock = threading.Lock()
+        self._discovery_client = discovery_client
+        self._grpc_channel_pool = grpc_channel_pool
+        self._stub = stub_class(grpc_channel) if grpc_channel is not None else None
+        self._service_interface_name = service_interface_name
+        self._service_class = service_class
+        self._stub_class = stub_class
+
+    def _get_stub(self) -> TStub:
+        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._discovery_client is None:
+                    _logger.debug("Creating unshared DiscoveryClient.")
+                    self._discovery_client = DiscoveryClient(
+                        grpc_channel_pool=self._grpc_channel_pool
+                    )
+
+                if self._stub is None:
+                    compute_nodes = self._discovery_client.enumerate_compute_nodes()
+                    remote_nodes = [node for node in compute_nodes if not node.is_local]
+                    target_url = remote_nodes[0].url if len(remote_nodes) == 1 else ""
+
+                    service_location = self._discovery_client.resolve_service(
+                        provided_interface=self._service_interface_name,
+                        deployment_target=target_url,
+                        service_class=self._service_class,
+                    )
+
+                    channel = self._grpc_channel_pool.get_channel(service_location.insecure_address)
+                    self._stub = self._stub_class(channel)
+
+        return self._stub

ni/measurementlink/sessionmanagement/v1/client/_drivers/_configuration.py

@@ -20,8 +20,6 @@ if TYPE_CHECKING:
 
 _PREFIX = "MEASUREMENT_PLUGIN"
 
-_config = AutoConfig(str(get_dotenv_search_path()))
-
 if TYPE_CHECKING:
     # Work around decouple's lack of type hints.
     _T = TypeVar("_T")
@@ -32,6 +30,9 @@ if TYPE_CHECKING:
         cast: Callable[[str], _T] | Undefined = undefined,
     ) -> _T: ...
 
+else:
+    _config = AutoConfig(str(get_dotenv_search_path()))
+
 
 # ----------------------------------------------------------------------
 # NI Modular Instrument Driver Options

ni/measurementlink/sessionmanagement/v1/client/_reservation.py

@@ -172,15 +172,17 @@ class _BaseSessionContainer(abc.ABC):
 
     @property
     def _discovery_client(self) -> DiscoveryClient:
-        if not self._session_management_client._discovery_client:
+        client = self._session_management_client._discovery_client
+        if client is None:
             raise ValueError("This method requires a discovery client.")
-        return self._session_management_client._discovery_client
+        return client
 
     @property
     def _grpc_channel_pool(self) -> GrpcChannelPool:
-        if not self._session_management_client._grpc_channel_pool:
+        pool = self._session_management_client._grpc_channel_pool
+        if pool is None:
             raise ValueError("This method requires a gRPC channel pool.")
-        return self._session_management_client._grpc_channel_pool
+        return pool
 
 
 class MultiplexerSessionContainer(_BaseSessionContainer):
@@ -274,9 +276,7 @@ class MultiplexerSessionContainer(_BaseSessionContainer):
         return multiplexer_session_infos
 
     @contextlib.contextmanager
-    def _cache_multiplexer_session(
-        self, session_name: str, session: TMultiplexerSession
-    ) -> Generator[None]:  # pyright: ignore[reportInvalidTypeVarUse]
+    def _cache_multiplexer_session(self, session_name: str, session: object) -> Generator[None]:
         if session_name in self._multiplexer_session_cache:
             raise RuntimeError(f"Multiplexer session '{session_name}' already exists.")
         self._multiplexer_session_cache[session_name] = session
@@ -664,7 +664,7 @@ class BaseReservation(_BaseSessionContainer):
         self._session_management_client._unreserve_sessions(self._grpc_session_info)
 
     @contextlib.contextmanager
-    def _cache_session(self, session_name: str, session: TSession) -> Generator[None]:
+    def _cache_session(self, session_name: str, session: object) -> Generator[None]:
         if session_name in self._session_cache:
             raise RuntimeError(f"Session '{session_name}' already exists.")
         self._session_cache[session_name] = session

ni/measurementlink/sessionmanagement/v1/client/_types.py

@@ -139,6 +139,13 @@ class SessionInformation(NamedTuple):
     This field is None until the appropriate initialize_session(s) method is called.
     """
 
+    annotations: dict[str, str] | None = None
+    """Annotations to attach to the session.
+
+    This field is optional and can be used to store any additional metadata
+    related to the session.
+    """
+
     def _check_runtime_type(self, session_type: type) -> None:
         if not isinstance(self.session, session_type):
             raise TypeError(
@@ -162,6 +169,7 @@ class SessionInformation(NamedTuple):
             instrument_type_id=other.instrument_type_id,
             session_exists=other.session_exists,
             channel_mappings=[ChannelMapping._from_grpc_v1(m) for m in other.channel_mappings],
+            annotations=dict(other.annotations) if other.annotations else None,
         )
 
     def _to_grpc_v1(
@@ -174,6 +182,7 @@ class SessionInformation(NamedTuple):
             instrument_type_id=self.instrument_type_id,
             session_exists=self.session_exists,
             channel_mappings=[m._to_grpc_v1() for m in self.channel_mappings],
+            annotations=self.annotations if self.annotations else {},
         )
 
 
@@ -253,6 +262,13 @@ class MultiplexerSessionInformation(NamedTuple):
     This field is None until the appropriate initialize_multiplexer_session(s) method is called.
     """
 
+    annotations: dict[str, str] = {}
+    """Annotations to attach to the session.
+
+    This field is optional and can be used to store any additional metadata
+    related to the session.
+    """
+
     def _check_runtime_type(self, multiplexer_session_type: type) -> None:
         if not isinstance(self.session, multiplexer_session_type):
             raise TypeError(
@@ -274,6 +290,7 @@ class MultiplexerSessionInformation(NamedTuple):
             resource_name=other.resource_name,
             multiplexer_type_id=other.multiplexer_type_id,
             session_exists=other.session_exists,
+            annotations=dict(other.annotations),
         )
 
     def _to_grpc_v1(self) -> session_management_service_pb2.MultiplexerSessionInformation:
@@ -282,6 +299,7 @@ class MultiplexerSessionInformation(NamedTuple):
             resource_name=self.resource_name,
             multiplexer_type_id=self.multiplexer_type_id,
             session_exists=self.session_exists,
+            annotations=self.annotations,
         )
 
 

{ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev0.dist-info → ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev2.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.3
 Name: ni.measurementlink.sessionmanagement.v1.client
-Version: 0.1.0.dev0
+Version: 0.1.0.dev2
 Summary: Client gRPC APIs for the session management service
 License: MIT
 Keywords: ni-apis,sessionmanagement
 Author: NI
 Author-email: opensource@ni.com
-Maintainer: Brad Keryan
-Maintainer-email: brad.keryan@emerson.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
@@ -49,6 +49,7 @@ Requires-Dist: protobuf (>=4.21)
 Requires-Dist: python-decouple (>=3.8)
 Requires-Dist: pywin32 (>=303) ; sys_platform == "win32"
 Requires-Dist: traceloggingdynamic (>=1.0) ; sys_platform == "win32"
+Project-URL: Documentation, https://nimeasurementlinksessionmanagementclient.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/ni/ni-apis-python
 Description-Content-Type: text/markdown
 

{ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev0.dist-info → ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev2.dist-info}/RECORD

@@ -1,8 +1,10 @@
 ni/measurementlink/sessionmanagement/v1/client/__init__.py,sha256=cUrRh3Be6kKh9KVZ5xeZgxzR-dMcJvIc5Xgq5tf3Xwg,3141
-ni/measurementlink/sessionmanagement/v1/client/_client.py,sha256=dG3eTIo8CKOWz_LgxhYZD1rIbhFH1YKfOSXBcJX883A,17420
+ni/measurementlink/sessionmanagement/v1/client/_annotations.py,sha256=rmUu2zyqnJSOaDhGwMO3iqu_s_lr4XZgWVYssMYaZ0Y,2106
+ni/measurementlink/sessionmanagement/v1/client/_client.py,sha256=C6A7F8hB0U6nP5jTMH9XfUP37zVZ1GKk9-lA6bycV3k,16509
+ni/measurementlink/sessionmanagement/v1/client/_client_base.py,sha256=tL0kkDQdKwrWEI34Y7DnoqIXv_EGA39q7YPWrN9lpJs,3606
 ni/measurementlink/sessionmanagement/v1/client/_constants.py,sha256=rGRguoyy-ovtkP4jMtVoab4WFdj5WOWn65rkV-1DqkM,1243
 ni/measurementlink/sessionmanagement/v1/client/_drivers/__init__.py,sha256=7p6Ap81Hyfg_qIMZPPeKuQXf3eMhgpKHBwsFbjWZvXc,1707
-ni/measurementlink/sessionmanagement/v1/client/_drivers/_configuration.py,sha256=ZROS5pKaqyDKf_tTlyxcb6MM2tACxmcUBqp-tTI74u4,3863
+ni/measurementlink/sessionmanagement/v1/client/_drivers/_configuration.py,sha256=FWvPOuDIcJ_GdkpPDWO2m2sFdq27bB7SsbJey6g5q68,3873
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_dotenvpath.py,sha256=dKGHIb_M60z8FkNN0_3Gl2Xk_GoufnXZy3McmjU8d_c,2347
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_grpcdevice.py,sha256=zMcUJe1WHSqNd09BIkNj6pcdC5jRdRYA-4fo4jmvq5k,3798
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_nidaqmx.py,sha256=Q1U-yYvc8bSh4EKZUvVqqXi4qgja6lACgcYqWGY-aeg,2230
@@ -12,9 +14,9 @@ ni/measurementlink/sessionmanagement/v1/client/_drivers/_nidmm.py,sha256=wJJzIZB
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_nifgen.py,sha256=zauQkkgTur8Ww0vhWPvwEi2zC9kTcmu-wqlh-DMAP2s,2605
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_niscope.py,sha256=V0EVuSj08DaeUAQ3uB7GEAWZM19Si49wuPA-PW6pKDQ,2667
 ni/measurementlink/sessionmanagement/v1/client/_drivers/_niswitch.py,sha256=TXE--U5xIlyumBMkqRx8S6qDu6OI1-BH8gRosVgT7t0,3394
-ni/measurementlink/sessionmanagement/v1/client/_reservation.py,sha256=vb4hvuclxNacS9u7zrT-zNf4_8NtZp7DE0x80O2ulMM,110007
-ni/measurementlink/sessionmanagement/v1/client/_types.py,sha256=Cg2TUtipPWujxGJn5dlewxUsWs0kiavEELpxtis7Ol0,17892
+ni/measurementlink/sessionmanagement/v1/client/_reservation.py,sha256=CVm07PHqC9LAEVsSKLbPnF3Vxh4NV02utJIA7uxyP_A,109897
+ni/measurementlink/sessionmanagement/v1/client/_types.py,sha256=plIrRwSFZNK-ivtKkmU4pn5WG_2wb3Ves19MP4e88_o,18534
 ni/measurementlink/sessionmanagement/v1/client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev0.dist-info/METADATA,sha256=KsPHM9cCpowF_yxaII2C9I78IgB4pHTIDNf6pBa6JoU,3411
-ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev0.dist-info/RECORD,,
+ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev2.dist-info/METADATA,sha256=cuc3oaj1siSkUYHz45k0EIWsTXTRPYAbYWOgmPE0Wz4,3524
+ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+ni_measurementlink_sessionmanagement_v1_client-0.1.0.dev2.dist-info/RECORD,,