Restore session_management module export to service package (#1250)

dixonjoel · web-flow · commit 26808d20b31b · 2025-10-06T15:58:13.000-05:00
* Update examples to &gt;=2.3.1,&lt;4.0

* Restore session_management export from ni_measurement_plugin_sdk_service

* Set version numbers to 3.0.1

* Restore _types module with SessionInitializationBehavior

* Do not reference private modules from ni_measurement_plugin_sdk_service.

* Revert version change so the rest can be cherry picked to main

* Restore more exports from _reservation and _types

* Fix linter errors
diff --git a/examples/game_of_life/pyproject.toml b/examples/game_of_life/pyproject.toml
@@ -7,7 +7,7 @@ authors = ["National Instruments"]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 ni-protobuf-types = { version = ">=0.1.0dev2", allow-prereleases = true }
 
diff --git a/examples/nidaqmx_analog_input/pyproject.toml b/examples/nidaqmx_analog_input/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 nidaqmx = { version = ">=0.8.0", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 
 [tool.poetry.group.dev.dependencies]
diff --git a/examples/nidcpower_source_dc_voltage/pyproject.toml b/examples/nidcpower_source_dc_voltage/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 nidcpower = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/nidcpower_source_dc_voltage_with_multiplexer/pyproject.toml b/examples/nidcpower_source_dc_voltage_with_multiplexer/pyproject.toml
@@ -9,7 +9,7 @@ authors = ["National Instruments"]
 python = "^3.9"
 nidcpower = { version = ">=1.4.4", extras = ["grpc"] }
 niswitch = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/nidigital_spi/pyproject.toml b/examples/nidigital_spi/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 nidigital = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/nidigital_spi/teststand_nidigital.py b/examples/nidigital_spi/teststand_nidigital.py
@@ -8,13 +8,11 @@
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 from ni_measurement_plugin_sdk_service.session_management import (
     INSTRUMENT_TYPE_NI_DIGITAL_PATTERN,
+    MultiSessionReservation,
     PinMapContext,
     SessionInitializationBehavior,
     SessionManagementClient,
 )
-from ni_measurement_plugin_sdk_service.session_management._reservation import (
-    MultiSessionReservation,
-)
 
 
 def create_nidigital_sessions(sequence_context: Any) -> None:
diff --git a/examples/nidmm_measurement/pyproject.toml b/examples/nidmm_measurement/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 nidmm = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/nifgen_standard_function/pyproject.toml b/examples/nifgen_standard_function/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 nifgen = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/niscope_acquire_waveform/pyproject.toml b/examples/niscope_acquire_waveform/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 niscope = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/niswitch_control_relays/pyproject.toml b/examples/niswitch_control_relays/pyproject.toml
@@ -8,7 +8,7 @@ authors = ["National Instruments"]
 [tool.poetry.dependencies]
 python = "^3.9"
 niswitch = { version = ">=1.4.4", extras = ["grpc"] }
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 grpcio = "*"
 
diff --git a/examples/nivisa_dmm_measurement/pyproject.toml b/examples/nivisa_dmm_measurement/pyproject.toml
@@ -7,7 +7,7 @@ authors = ["National Instruments"]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 PyVISA = "^1.13.0"
 PyVISA-sim = "^0.5.1"
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
diff --git a/examples/nivisa_dmm_measurement/teststand_nivisa_dmm.py b/examples/nivisa_dmm_measurement/teststand_nivisa_dmm.py
@@ -11,10 +11,8 @@
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 from ni_measurement_plugin_sdk_service.session_management import (
     PinMapContext,
-    SessionManagementClient,
-)
-from ni_measurement_plugin_sdk_service.session_management._types import (
     SessionInitializationBehavior,
+    SessionManagementClient,
 )
 
 # Search for the `.env` file starting with this code module's parent directory.
diff --git a/examples/output_voltage_measurement/pyproject.toml b/examples/output_voltage_measurement/pyproject.toml
@@ -7,7 +7,7 @@ authors = ["National Instruments"]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 PyVISA = "^1.13.0"
 PyVISA-sim = "^0.5.1"
 nidcpower = { version = ">=1.4.4", extras = ["grpc"] }
diff --git a/examples/output_voltage_measurement/teststand_nivisa_dmm.py b/examples/output_voltage_measurement/teststand_nivisa_dmm.py
@@ -11,10 +11,8 @@
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 from ni_measurement_plugin_sdk_service.session_management import (
     PinMapContext,
-    SessionManagementClient,
-)
-from ni_measurement_plugin_sdk_service.session_management._types import (
     SessionInitializationBehavior,
+    SessionManagementClient,
 )
 
 # Search for the `.env` file starting with this code module's parent directory.
diff --git a/examples/sample_measurement/pyproject.toml b/examples/sample_measurement/pyproject.toml
@@ -7,7 +7,7 @@ authors = ["National Instruments"]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
+ni-measurement-plugin-sdk-service = {version = ">=2.3.1,<4.0"}
 click = ">=7.1.2, !=8.1.4" # mypy fails with click 8.1.4: https://github.com/pallets/click/issues/2558
 ni-protobuf-types = { version = ">=0.1.0dev2", allow-prereleases = true }
 
diff --git a/packages/service/ni_measurement_plugin_sdk_service/__init__.py b/packages/service/ni_measurement_plugin_sdk_service/__init__.py
@@ -4,10 +4,12 @@
 
 from ni.measurementlink.discovery.v1.client import ServiceInfo
 
+from ni_measurement_plugin_sdk_service import session_management
 from ni_measurement_plugin_sdk_service.measurement.info import DataType, MeasurementInfo
 from ni_measurement_plugin_sdk_service.measurement.service import MeasurementService
 
 __all__ = [
+    "session_management",
     "DataType",
     "MeasurementInfo",
     "ServiceInfo",
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
@@ -1,3 +1,13 @@
-from ni.measurementlink.sessionmanagement.v1.client import MultiSessionReservation
+from ni.measurementlink.sessionmanagement.v1.client import (
+    BaseReservation,
+    MultiplexerSessionContainer,
+    MultiSessionReservation,
+    SingleSessionReservation,
+)
 
-__all__ = ["MultiSessionReservation"]
+__all__ = [
+    "BaseReservation",
+    "MultiplexerSessionContainer",
+    "MultiSessionReservation",
+    "SingleSessionReservation",
+]
diff --git a/packages/service/ni_measurement_plugin_sdk_service/session_management/_types.py b/packages/service/ni_measurement_plugin_sdk_service/session_management/_types.py
@@ -0,0 +1,25 @@
+from ni.measurementlink.sessionmanagement.v1.client import (
+    ChannelMapping,
+    Connection,
+    MultiplexerSessionInformation,
+    PinMapContext,
+    SessionInformation,
+    SessionInitializationBehavior,
+    TypedConnection,
+    TypedConnectionWithMultiplexer,
+    TypedMultiplexerSessionInformation,
+    TypedSessionInformation,
+)
+
+__all__ = [
+    "ChannelMapping",
+    "Connection",
+    "MultiplexerSessionInformation",
+    "PinMapContext",
+    "SessionInformation",
+    "SessionInitializationBehavior",
+    "TypedConnection",
+    "TypedConnectionWithMultiplexer",
+    "TypedMultiplexerSessionInformation",
+    "TypedSessionInformation",
+]
