Add redirects for modules and classes that were moved to ni-apis-python (#1228)

dixonjoel · web-flow · commit 3da9aed882e5 · 2025-09-18T14:39:42.000-05:00
* Add redirects for modules and classes that were moved to ni-apis-python

* Fix linter errors

* Add more constants to session_management.

* Restore more redirects and constants

* Fix linter errors

* Remove ServiceInfo export from discovery module

* Mostly updating doc strings

* Update doc string

* Change loggers and channelpool back to submodules not subpackages

* Fix typo
diff --git a/examples/nidaqmx_analog_input/pyproject.toml b/examples/nidaqmx_analog_input/pyproject.toml
@@ -17,7 +17,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nidaqmx = { git = "https://github.com/ni/nidaqmx-python.git", branch = "master", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/nidcpower_source_dc_voltage/pyproject.toml b/examples/nidcpower_source_dc_voltage/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nidcpower = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/nidcpower", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/nidcpower_source_dc_voltage_with_multiplexer/pyproject.toml b/examples/nidcpower_source_dc_voltage_with_multiplexer/pyproject.toml
@@ -20,7 +20,7 @@ types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nidcpower = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/nidcpower", extras = ["grpc"] }
 # niswitch = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/niswitch", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/nidigital_spi/pyproject.toml b/examples/nidigital_spi/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nidigital = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/nidigital", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/nidmm_measurement/pyproject.toml b/examples/nidmm_measurement/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nidmm = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/nidmm", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/nifgen_standard_function/pyproject.toml b/examples/nifgen_standard_function/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # nifgen = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/nifgen", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/niscope_acquire_waveform/pyproject.toml b/examples/niscope_acquire_waveform/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # niscope = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/niscope", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/niswitch_control_relays/pyproject.toml b/examples/niswitch_control_relays/pyproject.toml
@@ -18,7 +18,7 @@ mypy = ">=1.0"
 types-grpcio = ">=1.0"
 # Uncomment to use prerelease dependencies.
 # niswitch = { git = "https://github.com/ni/nimi-python.git", subdirectory = "generated/niswitch", extras = ["grpc"] }
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/examples/sample_measurement/pyproject.toml b/examples/sample_measurement/pyproject.toml
@@ -19,7 +19,7 @@ grpcio-tools = "1.49.1"
 mypy-protobuf = "^3.6.0"
 types-protobuf = ">=4.21"
 # Uncomment to use prerelease dependencies.
-# ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
+ni-measurement-plugin-sdk-service = {path = "../../packages/service", develop = true}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/discovery/__init__.py b/packages/service/ni_measurement_plugin_sdk_service/discovery/__init__.py
@@ -0,0 +1,13 @@
+"""Compatibility API for accessing the NI Discovery Service.
+
+The public API for accessing the NI Discovery Service has moved to the
+:mod:`ni.measurementlink.discovery.v1.client` package.
+
+The :mod:`ni_measurement_plugin_sdk_service.discovery` subpackage provides
+compatibility with existing applications and will be deprecated in a future
+release.
+"""
+
+from ni.measurementlink.discovery.v1.client import DiscoveryClient, ServiceLocation
+
+__all__ = ["DiscoveryClient", "ServiceLocation"]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/grpc/__init__.py b/packages/service/ni_measurement_plugin_sdk_service/grpc/__init__.py
@@ -0,0 +1,9 @@
+"""Compatibility API for gRPC extensions.
+
+The public gRPC extensions API has moved to the :mod:`ni_grpc_extensions`
+package.
+
+The :mod:`ni_measurement_plugin_sdk_service.grpc` subpackage provides
+compatibility with existing applications and will be deprecated in a future
+release.
+"""
diff --git a/packages/service/ni_measurement_plugin_sdk_service/grpc/channelpool.py b/packages/service/ni_measurement_plugin_sdk_service/grpc/channelpool.py
@@ -0,0 +1,13 @@
+"""Compatibility API for gRPC channel pool.
+
+The :obj:`GrpcChannelPool` class has moved to the :mod:`ni_grpc_extensions`
+package.
+
+The :mod:`ni_measurement_plugin_sdk_service.grpc.channelpool` submodule provides
+compatibility with existing applications and will be deprecated in a future
+release.
+"""
+
+from ni_grpc_extensions.channelpool import GrpcChannelPool
+
+__all__ = ["GrpcChannelPool"]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/grpc/loggers.py b/packages/service/ni_measurement_plugin_sdk_service/grpc/loggers.py
@@ -0,0 +1,13 @@
+"""Compatibility API for gRPC logging interceptors.
+
+The gRPC logging interceptor classes have moved to the :mod:`ni_grpc_extensions`
+package.
+
+The :mod:`ni_measurement_plugin_sdk_service.grpc.loggers` submodule provides
+compatibility with existing applications and will be deprecated in a future
+release.
+"""
+
+from ni_grpc_extensions.loggers import ClientLogger, ServerLogger
+
+__all__ = ["ClientLogger", "ServerLogger"]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/measurement/info.py b/packages/service/ni_measurement_plugin_sdk_service/measurement/info.py
@@ -6,6 +6,10 @@
 from pathlib import Path
 from typing import NamedTuple
 
+from ni.measurementlink.discovery.v1.client import ServiceInfo
+
+__all__ = ["ServiceInfo", "MeasurementInfo", "TypeSpecialization", "DataType"]
+
 
 class MeasurementInfo(NamedTuple):
     """A named tuple providing information about a measurement."""
diff --git a/packages/service/ni_measurement_plugin_sdk_service/pin_map/__init__.py b/packages/service/ni_measurement_plugin_sdk_service/pin_map/__init__.py
@@ -0,0 +1,13 @@
+"""Compatibility API for accessing the NI Pin Map Service.
+
+The public API for accessing the NI Pin Map Service has moved to the
+:mod:`ni.measurementlink.pinmap.v1.client` package.
+
+The :mod:`ni_measurement_plugin_sdk_service.pin_map` subpackage provides
+compatibility with existing applications and will be deprecated in a future
+release.
+"""
+
+from ni.measurementlink.pinmap.v1.client import PinMapClient
+
+__all__ = ["PinMapClient"]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/session_management/__init__.py b/packages/service/ni_measurement_plugin_sdk_service/session_management/__init__.py
@@ -0,0 +1,84 @@
+"""Compatibility API for accessing the NI Session Management Service.
+
+The public API for accessing the NI Session Management Service has moved to the
+:mod:`ni.measurementlink.sessionmanagement.v1.client` package.
+
+The :mod:`ni_measurement_plugin_sdk_service.session_management` subpackage
+provides compatibility with existing applications and will be deprecated in a
+future release.
+"""
+
+from ni.measurementlink.sessionmanagement.v1.client 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,
+    BaseReservation,
+    ChannelMapping,
+    Connection,
+    MultiplexerSessionContainer,
+    MultiplexerSessionInformation,
+    MultiSessionReservation,
+    PinMapContext,
+    SessionInformation,
+    SessionInitializationBehavior,
+    SessionManagementClient,
+    SingleSessionReservation,
+    TypedConnection,
+    TypedConnectionWithMultiplexer,
+    TypedMultiplexerSessionInformation,
+    TypedSessionInformation,
+)
+
+__all__ = [
+    "GRPC_SERVICE_CLASS",
+    "GRPC_SERVICE_INTERFACE_NAME",
+    "INSTRUMENT_TYPE_NONE",
+    "INSTRUMENT_TYPE_NI_DCPOWER",
+    "INSTRUMENT_TYPE_NI_HSDIO",
+    "INSTRUMENT_TYPE_NI_RFSA",
+    "INSTRUMENT_TYPE_NI_RFMX",
+    "INSTRUMENT_TYPE_NI_RFSG",
+    "INSTRUMENT_TYPE_NI_RFPM",
+    "INSTRUMENT_TYPE_NI_DMM",
+    "INSTRUMENT_TYPE_NI_DIGITAL_PATTERN",
+    "INSTRUMENT_TYPE_NI_SCOPE",
+    "INSTRUMENT_TYPE_NI_FGEN",
+    "INSTRUMENT_TYPE_NI_DAQMX",
+    "INSTRUMENT_TYPE_NI_RELAY_DRIVER",
+    "INSTRUMENT_TYPE_NI_MODEL_BASED_INSTRUMENT",
+    "INSTRUMENT_TYPE_NI_SWITCH_EXECUTIVE_VIRTUAL_DEVICE",
+    "SITE_SYSTEM_PINS",
+    "BaseReservation",
+    "ChannelMapping",
+    "Connection",
+    "MultiplexerSessionInformation",
+    "MultiplexerSessionContainer",
+    "MultiSessionReservation",
+    "PinMapContext",
+    "SessionInformation",
+    "SessionInitializationBehavior",
+    "SessionManagementClient",
+    "SingleSessionReservation",
+    "TypedConnection",
+    "TypedConnectionWithMultiplexer",
+    "TypedMultiplexerSessionInformation",
+    "TypedSessionInformation",
+]
+
+Client = SessionManagementClient
+"""Alias for compatibility with code that uses session_management.Client."""
diff --git a/packages/service/ni_measurement_plugin_sdk_service/session_management/_reservation.py b/packages/service/ni_measurement_plugin_sdk_service/session_management/_reservation.py
@@ -0,0 +1,3 @@
+from ni.measurementlink.sessionmanagement.v1.client import MultiSessionReservation
+
+__all__ = ["MultiSessionReservation"]
