Skip to content

Improve BlueapiClient to add plan parameter type hints#1469

Draft
oliwenmandiamond wants to merge 9 commits intomainfrom
Improve-BlueapiClient-plan-repr-to-add-parameter-types
Draft

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

Conversation

@oliwenmandiamond
Copy link
Copy Markdown
Contributor

@oliwenmandiamond oliwenmandiamond commented Apr 1, 2026

Improves the help text for a plan to add the type hints

Before change:

>>> bc.plans.grid_analyserscan
grid_analyserscan(analyser, sequence, detectors, args, snake_axes=None, md=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
)

@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

❌ Patch coverage is 96.87500% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.21%. Comparing base (0f4cf89) to head (a8aa805).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/blueapi/client/client.py 96.87% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1469   +/-   ##
=======================================
  Coverage   95.20%   95.21%           
=======================================
  Files          43       43           
  Lines        3128     3154   +26     
=======================================
+ Hits         2978     3003   +25     
- Misses        150      151    +1     

☔ 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.

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.

1 participant