Show how to auto-import plugin custom messages#12
Merged
Conversation
Import generated custom message bindings from the sample plugin package initializer before loading SWIG module wrappers. This mirrors Basilisk's core messaging auto-import behavior and lets plugin users create recorders for generated custom messages without importing message types manually. Update the custom plugin docs and tests to demonstrate package-level messaging exposure, and add context to generated messaging package init files explaining why importing them registers custom Message<T> and Recorder<T> proxies.
c81c508 to
2d22d70
Compare
schaubh
added a commit
that referenced
this pull request
May 28, 2026
schaubh
added a commit
that referenced
this pull request
May 28, 2026
5ed3eaa to
01605f3
Compare
Collaborator
|
Thanks for the fixes! In the future we probably want to update the cmake with a I think this solution you have done is good for now though while we flesh out the SDK as it will unblock early adopters of it! |
ReeceHumphreys
approved these changes
May 29, 2026
Contributor
Author
|
Thanks for the feedback @ReeceHumphreys. The current solution does mimic what we are doing with BSK itself as well. So, at least we are consistent. If there is a better way to do this we can update both BSK and BSK-SDK. |
schaubh
added a commit
that referenced
this pull request
May 29, 2026
Import generated custom message bindings from the sample plugin package initializer before loading SWIG module wrappers. This mirrors Basilisk's core messaging auto-import behavior and lets plugin users create recorders for generated custom messages without importing message types manually. Update the custom plugin docs and tests to demonstrate package-level messaging exposure, and add context to generated messaging package init files explaining why importing them registers custom Message<T> and Recorder<T> proxies.
schaubh
added a commit
that referenced
this pull request
May 29, 2026
schaubh
added a commit
that referenced
this pull request
May 29, 2026
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.
Summary
Document the required package initialization pattern for SDK plugins with custom messages.
Plugins that generate custom message bindings should import their generated
messagingpackage before importing SWIG module wrappers:This mirrors Basilisk’s own package-level messaging import and ensures custom
Message<T>/Recorder<T>SWIG proxy classes are registered before users access module message fields.Changes
custom_atm.messagingfromcustom_atm.__init__.messaging/__init__.pydocstring describing recorder proxy registration.Testing
git diff --checkpython3 -m py_compile examples/custom-atm-plugin/custom_atm/__init__.py examples/custom-atm-plugin/customExponentialAtmosphere/_UnitTest/test_customExponentialAtmosphere.pypytestwas not run locally because this environment does not havepytestinstalled.