Generate cache type stubs to help edit user scripts #1338
+489
−174
Conversation
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
Mainly to make supporting type stubs easier
When editing scripts that make use of the dynamic plan/device access in
the new client, there is no type checking available by default (as the
available plans are unknown. This adds a subcommand to generate a
type-stubs package for the currently running server to help write scripts.
blueapi generate-stubs /tmp/blueapi-stubs
pip install --editable /tmp/blueapi-stubs
type checkers and LSPs will then be able to check scripts for correct plan
names/arguments/etc as well as providing completions while editing.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## user-client #1338 +/- ##
===============================================
- Coverage 95.34% 94.42% -0.93%
===============================================
Files 42 44 +2
Lines 2900 2995 +95
===============================================
+ Hits 2765 2828 +63
- Misses 135 167 +32 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Enable testing with StringIO
It was already included via fastapi but if we're using it directly we should probably include it.
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.
When editing scripts that make use of the dynamic plan/device access in
the new client, there is no type checking available by default (as the
available plans are unknown). This adds a subcommand to generate a
type-stubs package for the currently running server to help write scripts.
type checkers and LSPs will then be able to check scripts for correct plan
names/arguments/etc as well as providing completions while editing.