Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make an ADR on signal types and enforce #601

Open
DominicOram opened this issue Oct 4, 2024 · 1 comment
Open

Make an ADR on signal types and enforce #601

DominicOram opened this issue Oct 4, 2024 · 1 comment
Milestone

Comments

@DominicOram
Copy link
Contributor

Following #310 (comment) we have a well defined list of types that signals are allowed. However, there are still old devices in dodal that use different types e.g. https://github.com/DiamondLightSource/dodal/blob/f2e63c2c55d49ed35cef73531be7d4bcceb42546/src/dodal/devices/zocalo/zocalo_results.py#L133. To make sure these get phased out and more don't get introduced we should prohibit other types ideally through the typing system. To make it clear why this is the case we should make an ADR too.

Acceptance Criteria

  • An ADR is made on the types that signals are allowed
  • If try and make a signal with an unsupported type e.g. soft_signal_r_and_setter(MyArbitraryType) the type system will complain
@coretl
Copy link
Collaborator

coretl commented Oct 7, 2024

Agreed.

#594 will do the type checking.

https://github.com/bluesky/ophyd-async/pull/594/files#r1790651259 shows the types that will be in the ADR

@coretl coretl added this to the 1.0 milestone Oct 7, 2024
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

No branches or pull requests

2 participants