Correct return types to match current bluesky protocols

[evvaaaa]

Ophyd still uses older and less specific return types for some of the bluesky protocols.

class SomeDevice(Device):
    readable_sig = Component(SignalRO, "prefix")


def read_stuff(signal: Readable):
    pass


my_device = SomeDevice("prefix", name="name")

read_stuff(my_device.readable_sig)

gives type errors

Argument of type "SignalRO" cannot be assigned to parameter "signal" of type "Readable" in function "read_stuff"
  "SignalRO" is incompatible with protocol "Readable"
    "read" is an incompatible type
      Type "() -> dict[str | Unknown, dict[str, float | Unknown]]" cannot be assigned to type "() -> SyncOrAsync[Dict[str, Reading[Unknown]]]"
        Function return type "dict[str | Unknown, dict[str, float | Unknown]]" is incompatible with type "SyncOrAsync[Dict[str, Reading[Unknown]]]"
          Type "dict[str | Unknown, dict[str, float | Unknown]]" cannot be assigned to type "SyncOrAsync[Dict[str, Reading[Unknown]]]"
    "describe" is an incompatible type
      Type "() -> dict[str | Unknown, dict[str, Unknown]]" cannot be assigned to type "() -> SyncOrAsync[Dict[str, DataKey]]"
        Function return type "dict[str | Unknown, dict[str, Unknown]]" is incompatible with type "SyncOrAsync[Dict[str, DataKey]]"

Correcting

ophyd/ophyd/device.py

Line 563 in 1e5f037

def read(self) -> OrderedDictType[str, Dict[str, Any]]:

and

ophyd/ophyd/device.py

Line 590 in 1e5f037

def describe(self) -> OrderedDictType[str, Dict[str, Any]]:

to match

https://github.com/bluesky/bluesky/blob/88c403ffbfb539edfb74240703caca6c228480b7/src/bluesky/protocols.py#L269

and

https://github.com/bluesky/bluesky/blob/88c403ffbfb539edfb74240703caca6c228480b7/src/bluesky/protocols.py#L287

would fix the above.

There may be other places, e.g

ophyd/ophyd/flyers.py

Line 77 in 1e5f037

def describe_collect(self) -> Dict[str, Dict]:

and

https://github.com/bluesky/bluesky/blob/88c403ffbfb539edfb74240703caca6c228480b7/src/bluesky/protocols.py#L312

@olliesilvester

[NoxHarmonium]

We're getting the same type errors when trying to pass devices/signals from our beamline library into the Bluesky plan stubs like read or mv.

I wanted to have a look into it and see if I could help. The first idea I had was to create a test suite to check if the Ophyd devices conform to the various Bluesky protocols. Turns out there is already a comprehensive test suite that does exactly that!

It also seems to be passing at the moment:

https://github.com/bluesky/ophyd/actions/runs/14726448528/job/41330113376#step:11:1537

It does use mypy, and we are using pyright so I suppose it might be that pyright is more strict. I'll see if I can determine whether it is a pyright specific thing.

Edit: oops its pyright, not pylance (although they are related)

[NoxHarmonium]

Interestingly enough, pyright seems happy enough with the test suite too.

Edit: ah I wasn't flushing the file that pyright was checking. I've confirmed it is a pyright specific issue in the commit below

NoxHarmonium@1a56a2a

Now I've got a failing test suite I can work on getting it to pass

[NoxHarmonium]

I've got a very rough branch in my fork that at least fixes the common classes like Device/Signal for Readable and Movable.

https://github.com/NoxHarmonium/ophyd/pull/1/files

I went down a bit of a rabbit hole because it seems like some of the current tests are sometimes not actually testing anything. For example, there is a test for the Hinted protocol at https://github.com/bluesky/ophyd/blob/main/ophyd/tests/test_bluesky_protocols.py#L32 which is passing, but it doesn't seem like Hinted exists in Bluesky anymore.

For modules that don't exist, mypy is just defaulting to Any.

So for example, the following in the following test:

from bluesky.protocols import Hinted
foo: Hinted = ophyd.Signal(name='test')

Hinted is converted to Any

from bluesky.protocols import Hinted
foo: Any = ophyd.Signal(name='test')

and anything is assignable to Any so the test always passes.
I'm adding the switches "--follow-imports=silent", "--disallow-any-unimported" and going through and fixing them up as I find issues. Hopefully I can work on it a bit more tomorrow.

[NoxHarmonium]

I've opened a draft PR now which I've tested against our beamline library. Let me know if that seems like the right approach:
https://github.com/bluesky/ophyd/pull/1248/files