Remove duplicate session_pb2 codegen, add ni-apis submodule and dependency on ni.grpcdevice.v1.proto by rahur-NI · Pull Request #2176 · ni/nimi-python

rahur-NI · 2026-04-13T19:18:16Z

This contribution adheres to CONTRIBUTING.md.
~~I've updated CHANGELOG.md if applicable.~~
~~I've added tests applicable for this pull request~~

What does this Pull Request accomplish?

Replaces the duplicate session_pb2 protobuf codegen in each nimi-python driver modules with a dependency on ni.grpcdevice.v1.proto (similar to [ni/nidaqmx-python#859].

Replaced relative import from . import session_pb2 with absolute import session_pb2 in _grpc_stub_interpreter.py.mako
Install ni.grpcdevice.v1.proto>=1.0.0 as part of installers for modules that support grpc.
Updated mak files to remeve generation of session_pb2.py and session_pb2_grpc.py
Added third_party/ni-apis as a git submodule pointing to [https://github.com/ni/ni-apis]
Deleted session.proto file

List issues fixed by this Pull Request below, if any.

Fix session.proto should be replaced with a dependency on ni.grpcdevice.v1.proto #2146

What testing has been done?

A successful tox.
Codegen files have no changes other than importing from installed ni.grpcdevice.v1.proto package than importing from locally generated session_pb2 file as before.

codecov-commenter · 2026-04-13T19:28:19Z

Codecov Report

❌ Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 88.73%. Comparing base (304563a) to head (2f8c08f).

Files with missing lines	Patch %	Lines
generated/nirfsg/nirfsg/_grpc_stub_interpreter.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2176      +/-   ##
==========================================
- Coverage   89.85%   88.73%   -1.12%     
==========================================
  Files          73       73              
  Lines       19006    19006              
==========================================
- Hits        17077    16865     -212     
- Misses       1929     2141     +212

Flag	Coverage Δ
codegenunittests	`84.90% <ø> (ø)`
nidcpowersystemtests	`94.61% <100.00%> (ø)`
nidcpowerunittests	`89.53% <ø> (ø)`
nidigitalsystemtests	`92.26% <100.00%> (ø)`
nidigitalunittests	`68.44% <ø> (ø)`
nidmmsystemtests	`92.72% <100.00%> (ø)`
nifakeunittests	`86.01% <100.00%> (ø)`
nifgensystemtests	`94.61% <100.00%> (ø)`
nimodinstsystemtests	`73.85% <ø> (ø)`
nimodinstunittests	`94.20% <ø> (ø)`
nirfsgsystemtests	`72.70% <0.00%> (-8.43%)`	⬇️
niscopesystemtests	`92.94% <100.00%> (ø)`
niscopeunittests	`43.20% <ø> (ø)`
nisesystemtests	`91.50% <ø> (ø)`
niswitchsystemtests	`82.03% <100.00%> (ø)`
nitclksystemtests	`94.87% <ø> (ø)`
nitclkunittests	`98.26% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ated/nidcpower/nidcpower/_grpc_stub_interpreter.py	`89.40% <100.00%> (ø)`
...ated/nidigital/nidigital/_grpc_stub_interpreter.py	`89.60% <100.00%> (ø)`
generated/nidmm/nidmm/_grpc_stub_interpreter.py	`87.91% <100.00%> (ø)`
generated/nifake/nifake/_grpc_stub_interpreter.py	`85.11% <100.00%> (ø)`
generated/nifgen/nifgen/_grpc_stub_interpreter.py	`88.03% <100.00%> (ø)`
...enerated/niscope/niscope/_grpc_stub_interpreter.py	`85.57% <100.00%> (ø)`
...erated/niswitch/niswitch/_grpc_stub_interpreter.py	`81.45% <100.00%> (ø)`
generated/nirfsg/nirfsg/_grpc_stub_interpreter.py	`0.00% <0.00%> (-78.33%)`	⬇️

... and 2 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 304563a...2f8c08f. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ady installing through tox.ini files

ni-jfitzger · 2026-04-15T20:07:20Z

~~Please revert these ni-api changes until there's actually something to pull in.~~

I've been told we actually do need these, so disregard this comment.

bkeryan · 2026-04-15T20:17:48Z

Please revert these ni-api changes until there's actually something to pull in.

protoc needs a copy of session.proto in order to handle import "session.proto";

ni-jfitzger · 2026-04-15T21:11:39Z

Please revert these ni-api changes until there's actually something to pull in.

protoc needs a copy of session.proto in order to handle import "session.proto";

@bkeryan I don't understand. Doesn't ni.grpcdevice.v1.proto have the results of compiling the session.proto?

ni-jfitzger · 2026-04-15T21:13:08Z

Please revert these ni-api changes until there's actually something to pull in.

protoc needs a copy of session.proto in order to handle import "session.proto";

@bkeryan I don't understand. Doesn't ni.grpcdevice.v1.proto have the results of compiling the session.proto?

Oh, dang. We need it in order to compile our api-specific .proto files? That's annoying.

ni-jfitzger · 2026-04-15T21:20:58Z

+          with:
+            submodules: true


I don't think we need this.
This action is for running system tests. System tests do not involve tox -e codegen.

ni-jfitzger · 2026-04-15T21:23:12Z

+        with:
+          submodules: true


Like the other workflows in this folder, this is just runs system tests and examples.
I don't think we'll need submodules for that because it shouldn't involve codegen.

ni-jfitzger · 2026-04-15T21:31:34Z

 METADATA_FILES := $(wildcard $(METADATA_DIR)/*.py)
 SHARED_PROTOS_DIR := $(ROOT_DIR)/src/shared_protos
-PROTO_DIRS := $(METADATA_DIR) $(SHARED_PROTOS_DIR)
+NI_APIS_PROTOS_DIR := $(ROOT_DIR)/third_party/ni-apis/ni/grpcdevice/v1


Is this the right place to get session.proto from or should it be this one?
https://github.com/ni/ni-apis-python/blob/main/proto/session.proto

The one in ni-apis is pretty bare.

Initial Version

7d0c0e0

rahur-NI marked this pull request as ready for review April 13, 2026 19:18

rahur-NI requested review from marcoskirsch, ni-jfitzger and vnktshr21 as code owners April 13, 2026 19:18

Including ni.grpcdevice.v1.proto in tox-travis.ini as well.

a7de82f

ni-jfitzger reviewed Apr 13, 2026

View reviewed changes

Comment thread tox.ini Outdated

Remove install of ni.grpcdevice.v1.proto for docs in ini files.

0388514

ni-jfitzger reviewed Apr 13, 2026

View reviewed changes

Comment thread tools/install_local_wheel.py Outdated

ni-jfitzger reviewed Apr 13, 2026

View reviewed changes

Comment thread src/shared_protos/session.proto Outdated

rahur-NI mentioned this pull request Apr 14, 2026

Testing with replace of session.proto codegen with ni.grpcdevice.v1.proto dependency #2175

Closed

3 tasks

rahur-NI added 2 commits April 14, 2026 00:31

Removing prc extra install from install_local_wheel.py as we are alre…

8fac88b

…ady installing through tox.ini files

Add ni-apis submodule and remove local session.proto

6a40e64

rahur-NI changed the title ~~Remove duplicate session_pb2 codegen and add dependency on ni.grpcdevice.v1.proto~~ Remove duplicate session_pb2 codegen, add ni-apis submodule and dependency on ni.grpcdevice.v1.proto Apr 14, 2026

ni-jfitzger reviewed Apr 15, 2026

View reviewed changes

Update GitHub actions to remove check out of submodules

2f8c08f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove duplicate session_pb2 codegen, add ni-apis submodule and dependency on ni.grpcdevice.v1.proto#2176

Remove duplicate session_pb2 codegen, add ni-apis submodule and dependency on ni.grpcdevice.v1.proto#2176
rahur-NI wants to merge 6 commits intoni:masterfrom
rahur-NI:sessionProtoFileFromNiApisRepo

rahur-NI commented Apr 13, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented Apr 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ni-jfitzger commented Apr 15, 2026 •

edited

Loading

Uh oh!

bkeryan commented Apr 15, 2026

Uh oh!

ni-jfitzger commented Apr 15, 2026

Uh oh!

ni-jfitzger commented Apr 15, 2026

Uh oh!

ni-jfitzger Apr 15, 2026

Uh oh!

ni-jfitzger Apr 15, 2026

Uh oh!

ni-jfitzger Apr 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

rahur-NI commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this Pull Request accomplish?

List issues fixed by this Pull Request below, if any.

What testing has been done?

Uh oh!

codecov-commenter commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ni-jfitzger commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bkeryan commented Apr 15, 2026

Uh oh!

ni-jfitzger commented Apr 15, 2026

Uh oh!

ni-jfitzger commented Apr 15, 2026

Uh oh!

ni-jfitzger Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

ni-jfitzger Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

ni-jfitzger Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rahur-NI commented Apr 13, 2026 •

edited

Loading

codecov-commenter commented Apr 13, 2026 •

edited

Loading

ni-jfitzger commented Apr 15, 2026 •

edited

Loading