Generate cache type stubs to help edit user scripts#1338
Draft
Generate cache type stubs to help edit user scripts#1338
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## user-client #1338 +/- ##
===============================================
+ Coverage 95.16% 95.32% +0.15%
===============================================
Files 43 45 +2
Lines 3002 3099 +97
===============================================
+ Hits 2857 2954 +97
Misses 145 145 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tpoliaw
force-pushed
the
user-client
branch
3 times, most recently
from
2af7483 to
cb9ed3e
Compare
Allows autocomplete to work when working in a REPL
* Support args as well as kwargs when running plans * Get child devices via attributes on parent devices * Make more methods into properties
For some reason pyright can't figure out what the return type is otherwise and you don't get completion.
It broke type checking
Maintain backwards compatibility for now
And a new test for the login
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.
Enable testing with StringIO
It was already included via fastapi but if we're using it directly we should probably include it.
abbiemery
reviewed
Feb 18, 2026
| instance.model = model | ||
| instance._cache = cache | ||
| return instance | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| def __getattribute__(self, name: str) -> Any: | |
| if name.startswith("_"): | |
| return super().__getattribute__(name) | |
| if name == "model": | |
| return super().__getattribute__(name) | |
| return self._cache[f"{self}.{name}"] |
we added this to address device access auto completes.
Contributor
Author
There was a problem hiding this comment.
I think this was to avoid str methods preventing sub-devices being accessed. I do not like how this is done - there might be some way of getting custom data types to serialize correctly.
| def __repr__(self) -> str: ... | ||
|
|
||
|
|
||
| class DeviceRef(str): |
Contributor
There was a problem hiding this comment.
Suggested change
| class DeviceRef(str): | |
| class DeviceRef: |
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
2 participants
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.