ni.measurementlink.sessionmanagement.v1.client 1.1.0__tar.gz

ni_measurementlink_sessionmanagement_v1_client-1.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.3
+Name: ni.measurementlink.sessionmanagement.v1.client
+Version: 1.1.0
+Summary: Client gRPC APIs for the session management service
+License: MIT
+Keywords: ni-apis,sessionmanagement
+Author: NI
+Author-email: opensource@ni.com
+Maintainer: Joe Friedrichsen
+Maintainer-email: joe.friedrichsen@emerson.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+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: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+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 :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Provides-Extra: drivers
+Provides-Extra: nidaqmx
+Provides-Extra: nidcpower
+Provides-Extra: nidigital
+Provides-Extra: nidmm
+Provides-Extra: nifgen
+Provides-Extra: niscope
+Provides-Extra: niswitch
+Requires-Dist: deprecation (>=2.1)
+Requires-Dist: ni-grpc-extensions (>=1.1.0)
+Requires-Dist: ni-grpcdevice-v1-proto (>=1.1.0)
+Requires-Dist: ni-measurementlink-discovery-v1-client (>=1.1.0)
+Requires-Dist: ni-measurementlink-pinmap-v1-proto (>=1.1.0)
+Requires-Dist: ni-measurementlink-proto (>=1.1.0)
+Requires-Dist: ni-measurementlink-sessionmanagement-v1-proto (>=1.1.0)
+Requires-Dist: nidaqmx[grpc] (>=0.8.0) ; extra == "drivers" or extra == "nidaqmx"
+Requires-Dist: nidcpower[grpc] (>=1.4.4) ; extra == "drivers" or extra == "nidcpower"
+Requires-Dist: nidigital[grpc] (>=1.4.4) ; extra == "drivers" or extra == "nidigital"
+Requires-Dist: nidmm[grpc] (>=1.4.4) ; extra == "drivers" or extra == "nidmm"
+Requires-Dist: nifgen[grpc] (>=1.4.4) ; extra == "drivers" or extra == "nifgen"
+Requires-Dist: niscope[grpc] (>=1.4.4) ; extra == "drivers" or extra == "niscope"
+Requires-Dist: niswitch[grpc] (>=1.4.4) ; extra == "drivers" or extra == "niswitch"
+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
+
+# 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.measurementlink.sessionmanagement.v1.client` is a Python package that provides a client API for
+the [ni.measurementlink.sessionmanagement.v1 package](https://github.com/ni/ni-apis/tree/main/ni/measurementlink/sessionmanagement/v1).
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.measurementlink.sessionmanagement.v1.client` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`ni.measurementlink.sessionmanagement.v1.client` supports CPython 3.10+.
+
+## Installation
+
+You can directly install the `ni.measurementlink.sessionmanagement.v1.client` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.

ni_measurementlink_sessionmanagement_v1_client-1.1.0/README.md

@@ -0,0 +1,26 @@
+# 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.measurementlink.sessionmanagement.v1.client` is a Python package that provides a client API for
+the [ni.measurementlink.sessionmanagement.v1 package](https://github.com/ni/ni-apis/tree/main/ni/measurementlink/sessionmanagement/v1).
+
+NI created and supports this package.
+
+## Operating System Support
+
+`ni.measurementlink.sessionmanagement.v1.client` supports Windows and Linux operating systems.
+
+## Python Version Support
+
+`ni.measurementlink.sessionmanagement.v1.client` supports CPython 3.10+.
+
+## Installation
+
+You can directly install the `ni.measurementlink.sessionmanagement.v1.client` package using `pip` or by listing it as a
+dependency in your project's `pyproject.toml` file.

ni_measurementlink_sessionmanagement_v1_client-1.1.0/pyproject.toml

@@ -0,0 +1,167 @@
+[project]
+name = "ni.measurementlink.sessionmanagement.v1.client"
+version = "1.1.0"
+license = "MIT"
+description = "Client gRPC APIs for the session management 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 = ["ni-apis", "sessionmanagement"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Manufacturing",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: Implementation :: CPython",
+]
+dynamic = ["dependencies"]
+requires-python = '>=3.10,<4.0'
+
+[project.urls]
+repository = "https://github.com/ni/ni-apis-python"
+documentation = "https://nimeasurementlinksessionmanagementclient.readthedocs.io/en/latest/"
+
+[tool.poetry]
+packages = [{include = "ni", from = "src"}]
+requires-poetry = '>=2.1,<3.0'
+
+[tool.poetry.dependencies]
+protobuf = {version=">=4.21"}
+pywin32 = { version = ">=303", platform = "win32" }
+deprecation = ">=2.1"
+traceloggingdynamic = { version = ">=1.0", platform = "win32" }
+python-decouple = ">=3.8"
+nidaqmx = { version = ">=0.8.0", extras = ["grpc"], optional = true }
+nidcpower = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+nidigital = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+nidmm = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+nifgen = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+niscope = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+niswitch = { version = ">=1.4.4", extras = ["grpc"], optional = true }
+ni-measurementlink-sessionmanagement-v1-proto = { version = ">=1.1.0" }
+ni-measurementlink-pinmap-v1-proto = { version = ">=1.1.0" }
+ni-measurementlink-proto = { version = ">=1.1.0" }
+ni-grpcdevice-v1-proto = { version = ">=1.1.0" }
+ni-grpc-extensions = { version = ">=1.1.0" }
+ni-measurementlink-discovery-v1-client = { version = ">=1.1.0" }
+
+[tool.poetry.group.dev.dependencies]
+types-grpcio = ">=1.0"
+types-protobuf = ">=4.21"
+types-pywin32 = ">=311.0.0.20250822"
+
+[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"
+# Use a prerelease version of hightime for testing.
+hightime = { version = ">=0.3.0.dev0", allow-prereleases = true }
+
+[tool.poetry.extras]
+drivers = [
+  "nidaqmx",
+  "nidcpower",
+  "nidigital",
+  "nidmm",
+  "nifgen",
+  "niscope",
+  "niswitch",
+]
+nidaqmx = ["nidaqmx"]
+nidcpower = ["nidcpower"]
+nidigital = ["nidigital"]
+nidmm = ["nidmm"]
+nifgen = ["nifgen"]
+niscope = ["niscope"]
+niswitch = ["niswitch"]
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+# The latest Sphinx requires a recent Python version.
+Sphinx = [
+  { 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,*_pb2_grpc.py,*_pb2_grpc.pyi,*_pb2.py,*_pb2.pyi"
+application-import-names = "ni.measurementlink.sessionmanagement.v1.client"
+
+[tool.black]
+extend-exclude = 'docs/|_pb2(_grpc)?\.(py|pyi)$'
+line-length = 100
+
+[tool.mypy]
+mypy_path = "src"
+files = "."
+namespace_packages = true
+strict = true
+explicit_package_bases = true
+exclude = ["docs"]
+
+[[tool.mypy.overrides]]
+module = [
+  "decouple",
+  "deprecation",
+  "ni_grpc_extensions.channelpool",
+  "nidaqmx",
+  "nidcpower",
+  "nidigital",
+  "nidmm",
+  "nifgen",
+  "niscope",
+  "niswitch"
+]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "ni.measurementlink.sessionmanagement.v1.client._drivers._grpcdevice"
+disable_error_code = ["no-any-return"]
+
+
+[[tool.mypy.overrides]]
+module = "ni_grpc_extensions.channelpool"
+ignore_missing_imports = true
+
+[tool.pyright]
+include = ["src/"]
+exclude = ["**/*_pb2_grpc.py", "**/*_pb2_grpc.pyi", "**/*_pb2.py", "**/*_pb2.pyi"]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --doctest-plus --strict-markers"
+testpaths = ["tests"]

ni_measurementlink_sessionmanagement_v1_client-1.1.0/src/ni/measurementlink/sessionmanagement/v1/client/__init__.py

@@ -0,0 +1,107 @@
+"""Public API for accessing the measurement plug-in management service."""
+
+from __future__ import annotations
+
+import warnings
+from typing import Any
+
+from deprecation import DeprecatedWarning
+
+from ni.measurementlink.sessionmanagement.v1.client._client import (
+    SessionManagementClient,
+)
+from ni.measurementlink.sessionmanagement.v1.client._constants import (
+    GRPC_SERVICE_CLASS,
+    GRPC_SERVICE_INTERFACE_NAME,
+    INSTRUMENT_TYPE_NI_DAQMX,
+    INSTRUMENT_TYPE_NI_DCPOWER,
+    INSTRUMENT_TYPE_NI_DIGITAL_PATTERN,
+    INSTRUMENT_TYPE_NI_DMM,
+    INSTRUMENT_TYPE_NI_FGEN,
+    INSTRUMENT_TYPE_NI_HSDIO,
+    INSTRUMENT_TYPE_NI_MODEL_BASED_INSTRUMENT,
+    INSTRUMENT_TYPE_NI_RELAY_DRIVER,
+    INSTRUMENT_TYPE_NI_RFMX,
+    INSTRUMENT_TYPE_NI_RFPM,
+    INSTRUMENT_TYPE_NI_RFSA,
+    INSTRUMENT_TYPE_NI_RFSG,
+    INSTRUMENT_TYPE_NI_SCOPE,
+    INSTRUMENT_TYPE_NI_SWITCH_EXECUTIVE_VIRTUAL_DEVICE,
+    INSTRUMENT_TYPE_NONE,
+    SITE_SYSTEM_PINS,
+)
+from ni.measurementlink.sessionmanagement.v1.client._reservation import (
+    BaseReservation,
+    MultiplexerSessionContainer,
+    MultiSessionReservation,
+    SingleSessionReservation,
+)
+from ni.measurementlink.sessionmanagement.v1.client._types import (
+    ChannelMapping,
+    Connection,
+    MultiplexerSessionInformation,
+    PinMapContext,
+    SessionInformation,
+    SessionInitializationBehavior,
+    TypedConnection,
+    TypedConnectionWithMultiplexer,
+    TypedMultiplexerSessionInformation,
+    TypedSessionInformation,
+)
+
+__all__ = [
+    "BaseReservation",
+    "ChannelMapping",
+    "Client",
+    "Connection",
+    "GRPC_SERVICE_CLASS",
+    "GRPC_SERVICE_INTERFACE_NAME",
+    "INSTRUMENT_TYPE_NI_DAQMX",
+    "INSTRUMENT_TYPE_NI_DCPOWER",
+    "INSTRUMENT_TYPE_NI_DIGITAL_PATTERN",
+    "INSTRUMENT_TYPE_NI_DMM",
+    "INSTRUMENT_TYPE_NI_FGEN",
+    "INSTRUMENT_TYPE_NI_HSDIO",
+    "INSTRUMENT_TYPE_NI_MODEL_BASED_INSTRUMENT",
+    "INSTRUMENT_TYPE_NI_RELAY_DRIVER",
+    "INSTRUMENT_TYPE_NI_RFMX",
+    "INSTRUMENT_TYPE_NI_RFPM",
+    "INSTRUMENT_TYPE_NI_RFSA",
+    "INSTRUMENT_TYPE_NI_RFSG",
+    "INSTRUMENT_TYPE_NI_SCOPE",
+    "INSTRUMENT_TYPE_NI_SWITCH_EXECUTIVE_VIRTUAL_DEVICE",
+    "INSTRUMENT_TYPE_NONE",
+    "MultiSessionReservation",
+    "PinMapContext",
+    "MultiplexerSessionContainer",
+    "MultiplexerSessionInformation",
+    "SessionInformation",
+    "SessionInitializationBehavior",
+    "SessionManagementClient",
+    "SingleSessionReservation",
+    "SITE_SYSTEM_PINS",
+    "TypedConnection",
+    "TypedConnectionWithMultiplexer",
+    "TypedMultiplexerSessionInformation",
+    "TypedSessionInformation",
+]
+
+
+def __getattr__(name: str) -> Any:
+    if name == "Reservation":
+        warnings.warn(
+            DeprecatedWarning(
+                name,
+                deprecated_in="1.1.0",
+                removed_in=None,
+                details="Use MultiSessionReservation instead.",
+            ),
+            stacklevel=2,
+        )
+        return MultiSessionReservation
+    else:
+        raise AttributeError(f"module {__name__} has no attribute {name}")
+
+
+Client = SessionManagementClient
+"""Alias for compatibility with code that uses session_management.Client."""

ni_measurementlink_sessionmanagement_v1_client-1.1.0/src/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 ""