Change 'create_grpc_client_channel' to 'create_grpc_device_channel' - #13
Merged
alexdubois-ni merged 1 commit intoAug 24, 2026
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
alexdubois-ni
force-pushed
the
users/adubois/changeCreateGrpcClientChannelToBeRestrictedToGrpcDevice
branch
from
August 24, 2026 21:37
2475090 to
5b384ff
Compare
Test Results 12 files ±0 12 suites ±0 17s ⏱️ -1s Results for commit 5b384ff. ± Comparison against base commit b329f64. This pull request removes 1 and adds 1 tests. Note that renamed tests count towards both. |
alexdubois-ni
marked this pull request as ready for review
August 24, 2026 21:47
There was a problem hiding this comment.
Pull request overview
Renames and narrows the public gRPC channel factory specifically for the NI gRPC Device Server.
Changes:
- Replaces
create_grpc_client_channelwithcreate_grpc_device_channel. - Fixes the NI-TLS service name to
ni-grpc-deviceand centralizes it. - Updates exports, documentation, CI, and unit tests.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/nitlsconfig/grpc_channel.py |
Renames and restricts the channel factory. |
src/nitlsconfig/service.py |
Defines the shared device service name. |
src/nitlsconfig/audit.py |
Uses the shared service name for auditing. |
src/nitlsconfig/__init__.py |
Updates public and lazy exports. |
tests/unit/test_grpc_channel.py |
Updates factory and fixed-service tests. |
tests/unit/test_grpc_channel_tls.py |
Updates TLS integration tests. |
tests/unit/test_grpc_channel_real.py |
Updates real-channel tests. |
tests/unit/test_nitlsconfig.py |
Updates configuration integration tests. |
README.md |
Documents the renamed API. |
.github/workflows/run_unit_tests.yml |
Updates optional-dependency verification. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
ckoellin
approved these changes
Aug 24, 2026
alexdubois-ni
deleted the
users/adubois/changeCreateGrpcClientChannelToBeRestrictedToGrpcDevice
branch
August 24, 2026 22:05
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this Pull Request accomplish?
Change the public API 'create_grpc_client_channel' to 'create_grpc_device_channel'
Why should this Pull Request be merged?
Originally, this code was based off existing code that allows us to configure any service for usage with NI-TLS. However, there is no need for that in the public github repo for Python as the only known NI-TLS usage we intend to have today that needs Python access and NI-TLS integration is gRPC device.
Obviously, this is subject to change in the future, but it is easier to make our interface more restrictive at first and then extend it later to be more flexible as opposed to the other way around.
I want to ensure we have the least code and complexity to maintain for now, so I am opting to simplify this a bit, and make the interface to be clearer for users. But, we have every ability to make this more generic in the future if the need arises and have most of the re-usable code ready and in-place for extending.
Furthermore, the terminology from gRPC is that a channel is essentially a client, so having "client channel" in the name is rather redundant as it stands today. I'd rather make this specifically mention grpc_device.
Note: I am not worried about backwards compatibility. We are only NOW beginning to bubble this into nimi-python and eventually DAQmx Python, so I'm trying to make this change now as opposed to later.
What testing has been done?
Unit-tests.