Replace ni.protobuf.types stubs with dependency on ni.protobuf.types package (#1212)

* First pass at removing protobuf and panel generated stubs and pulling them in from ni.protobuf.types

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Fix linting errors.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Modified stub generation to exclude protobuf and panels

* Lint

* Add code to stop adding the _internal stub path to ni.protobuf.types and ni.panels.v1.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Fix example_renders to match what is generated and add them to the styleguide exclude list since they don't conform to the styleguide as generated.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Missing a comma.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Re-lock dependencies after simplifying numpy deps

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Run poetry lock on the examples.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Refactor stub namespace exclusions.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

* Add dev dependencies for numpy to fix errors on python 3.13.

Signed-off-by: Michael Johansen <michael.johansen@ni.com>

---------

Signed-off-by: Michael Johansen <michael.johansen@ni.com>
Co-authored-by: Michael Johansen <michael.johansen@ni.com>
Co-authored-by: Johann Scholtz <johann.scholtz@ni.com>

Author: 3 people

examples/game_of_life/measurement.py

@@ -11,9 +11,8 @@
 import grpc
 import ni_measurement_plugin_sdk_service as nims
 from _helpers import configure_logging, verbosity_option
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types import (
-    xydata_pb2,
-)
+from ni.protobuf.types import xydata_pb2
+
 
 service_directory = pathlib.Path(__file__).resolve().parent
 measurement_service = nims.MeasurementService(

examples/game_of_life/pyproject.toml

@@ -9,6 +9,7 @@ authors = ["National Instruments"]
 python = "^3.9"
 ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
 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 }
 
 [tool.poetry.group.dev.dependencies]
 ni-python-styleguide = ">=0.4.1"

examples/sample_measurement/_array_utils.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING
 
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types import array_pb2
+from ni.protobuf.types import array_pb2
 
 if TYPE_CHECKING:
     import numpy as np

examples/sample_measurement/measurement.py

@@ -10,7 +10,7 @@
 import click
 import ni_measurement_plugin_sdk_service as nims
 from _helpers import configure_logging, verbosity_option
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types import (
+from ni.protobuf.types import (
     array_pb2,
 )
 

examples/sample_measurement/pyproject.toml

@@ -9,6 +9,7 @@ authors = ["National Instruments"]
 python = "^3.9"
 ni-measurement-plugin-sdk-service = {version = "^2.3.1"}
 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 }
 
 [tool.poetry.group.dev.dependencies]
 ni-python-styleguide = ">=0.4.1"

packages/generator/ni_measurement_plugin_sdk_generator/client/_support.py

@@ -34,9 +34,9 @@
 
 _INVALID_CHARS = "`~!@#$%^&*()-+={}[]\\|:;',<>.?/ \n"
 
-_XY_DATA_IMPORT = "from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.xydata_pb2 import DoubleXYData"
-_DOUBLE2DARRAY_DATA_IMPORT = "from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.array_pb2 import Double2DArray"
-_STRING2DARRAY_DATA_IMPORT = "from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.array_pb2 import String2DArray"
+_XY_DATA_IMPORT = "from ni.protobuf.types.xydata_pb2 import DoubleXYData"
+_DOUBLE2DARRAY_DATA_IMPORT = "from ni.protobuf.types.array_pb2 import Double2DArray"
+_STRING2DARRAY_DATA_IMPORT = "from ni.protobuf.types.array_pb2 import String2DArray"
 _PATH_IMPORT = "import pathlib"
 
 _PROTO_DATATYPE_TO_PYTYPE_LOOKUP = {

packages/generator/poetry.lock

@@ -31,6 +31,7 @@ protobuf = ">=4.21"
 black = ">=24.8.0"
 click-option-group = ">=0.5.6"
 ni-measurement-plugin-sdk-service = {version = "^2.2.0"}
+ni-protobuf-types = { version = ">=0.1.0dev2", allow-prereleases = true }
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.2.0"
@@ -50,6 +51,13 @@ grpcio-tools = [
   {version = "1.59.0", python = ">=3.12,<3.13"},
   {version = "1.67.0", python = "^3.13"},
 ]
+# NumPy dropped support for Python 3.8 before adding support for Python 3.12, so
+# we need to include multiple NumPy versions in poetry.lock.
+numpy = [
+  { version = ">=1.22", python = ">=3.9,<3.12"},
+  { version = ">=1.26", python = ">=3.12,<3.13"},
+  { version = ">=2.1", python = "^3.13"},
+]
 
 [tool.poetry.scripts]
 ni-measurement-plugin-generator = "ni_measurement_plugin_sdk_generator.plugin:create_measurement"
@@ -64,7 +72,7 @@ extend_exclude = '\.tox/|_pb2(_grpc)?\.(py|pyi)$'
 line-length = 100
 
 [tool.ni-python-styleguide]
-extend_exclude = '.tox/,*_pb2_grpc.py,*_pb2_grpc.pyi,*_pb2.py,*_pb2.pyi'
+extend_exclude = 'tests/test_assets/example_renders/,.tox/,*_pb2_grpc.py,*_pb2_grpc.pyi,*_pb2.py,*_pb2.pyi'
 
 [tool.mypy]
 files = "ni_measurement_plugin_sdk_generator/,tests/"

packages/generator/pyproject.toml

@@ -8,9 +8,7 @@
 from typing import Any
 
 import pytest
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types import (
-    array_pb2,
-)
+from ni.protobuf.types import array_pb2
 from ni_measurement_plugin_sdk_service.measurement.service import MeasurementService
 
 from tests.conftest import CliRunnerFunction

packages/generator/tests/acceptance/test_non_streaming_measurement_client.py

@@ -16,15 +16,9 @@
     measurement_service_pb2 as v2_measurement_service_pb2,
     measurement_service_pb2_grpc as v2_measurement_service_pb2_grpc,
 )
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.array_pb2 import (
-    Double2DArray,
-)
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.array_pb2 import (
-    String2DArray,
-)
-from ni_measurement_plugin_sdk_service._internal.stubs.ni.protobuf.types.xydata_pb2 import (
-    DoubleXYData,
-)
+from ni.protobuf.types.array_pb2 import Double2DArray
+from ni.protobuf.types.array_pb2 import String2DArray
+from ni.protobuf.types.xydata_pb2 import DoubleXYData
 from ni_measurement_plugin_sdk_service.discovery import DiscoveryClient
 from ni_measurement_plugin_sdk_service.grpc.channelpool import GrpcChannelPool
 from ni_measurement_plugin_sdk_service.measurement import WrongMessageTypeWarning