Skip to content

feat: Improve BlueapiClient to add plan parameter type hints#1469

Open
oliwenmandiamond wants to merge 18 commits intomainfrom
Improve-BlueapiClient-plan-repr-to-add-parameter-types
Open

feat: Improve BlueapiClient to add plan parameter type hints#1469
oliwenmandiamond wants to merge 18 commits intomainfrom
Improve-BlueapiClient-plan-repr-to-add-parameter-types

Conversation

@oliwenmandiamond
Copy link
Copy Markdown
Contributor

@oliwenmandiamond oliwenmandiamond commented Apr 1, 2026

Fixes #1505

Improves the help text for a plan to add the type hints and correct default values.

Before change:

>>> bc.plans.grid_analyserscan
grid_analyserscan(analyser, sequence, detectors, args, snake_axes=None, md=None)

>>> bc.plans.count
count(detectors, num=None, delay=None, metadata=None)

With this change

>>> bc.plans.grid_analyserscan
grid_analyserscan(
    analyser: ElectronAnalyserDetector,
    sequence: AbstractBaseSequence,
    detectors: list[Readable],
    args: Any,
    snake_axes: list[Any] | bool | None = None,
    md: dict | None = None
)

>>> bc.plans.count
count(
    detectors: list[Readable],
    num: int = 1,
    delay: float = 0,
    metadata: dict | None = None
)

@oliwenmandiamond oliwenmandiamond changed the title Imrpove BlueapiClient to add plan parameter type hints Improve BlueapiClient to add plan parameter type hints Apr 1, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.29%. Comparing base (107d54e) to head (6272b42).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1469      +/-   ##
==========================================
+ Coverage   95.25%   95.29%   +0.03%     
==========================================
  Files          43       43              
  Lines        3163     3186      +23     
==========================================
+ Hits         3013     3036      +23     
  Misses        150      150              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@oliwenmandiamond oliwenmandiamond changed the title Improve BlueapiClient to add plan parameter type hints feat: Improve BlueapiClient to add plan parameter type hints Apr 7, 2026
@oliwenmandiamond oliwenmandiamond marked this pull request as ready for review April 7, 2026 12:49
@oliwenmandiamond oliwenmandiamond requested a review from a team as a code owner April 7, 2026 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BlueapiClient doesn't report the correct default values or display types for plans

1 participant