Fix pyright issues

Fixes #346

pyproject.toml

@@ -136,7 +136,7 @@ allowlist_externals =
  sphinx-autobuild
 commands =
  pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
- type-checking: pyright src tests {posargs}
+ type-checking: pyright src {posargs}
  tests: pytest --cov=ophyd-async --cov-report term --cov-report xml:cov.xml {posargs}
  docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
 """

src/ophyd_async/core/__init__.py

@@ -70,9 +70,9 @@
 from ._status import AsyncStatus, WatchableAsyncStatus, completed_status
 from ._table import Table
 from ._utils import (
+ CALCULATE_TIMEOUT,
  DEFAULT_TIMEOUT,
  CalculatableTimeout,
- CalculateTimeout,
  NotConnected,
  ReadingValueCallback,
  T,
@@ -154,7 +154,7 @@
  "WatchableAsyncStatus",
  "DEFAULT_TIMEOUT",
  "CalculatableTimeout",
- "CalculateTimeout",
+ "CALCULATE_TIMEOUT",
  "NotConnected",
  "ReadingValueCallback",
  "Table",

src/ophyd_async/core/_detector.py

@@ -11,7 +11,6 @@
 
 from bluesky.protocols import (
  Collectable,
- DataKey,
  Flyable,
  Preparable,
  Reading,
@@ -20,10 +19,12 @@
  Triggerable,
  WritesStreamAssets,
 )
+from event_model import DataKey
 from pydantic import BaseModel, Field
 
 from ._device import Device
 from ._protocol import AsyncConfigurable, AsyncReadable
+from ._signal import SignalR
 from ._status import AsyncStatus, WatchableAsyncStatus
 from ._utils import DEFAULT_TIMEOUT, T, WatcherUpdate, merge_gathered_dicts
 
@@ -168,7 +169,7 @@ def __init__(
  self,
  controller: DetectorControl,
  writer: DetectorWriter,
- config_sigs: Sequence[AsyncReadable] = (),
+ config_sigs: Sequence[SignalR] = (),
  name: str = "",
  ) -> None:
  """

src/ophyd_async/core/_device.py

@@ -190,6 +190,9 @@ def _caller_locals(self):
  caller_frame = tb.tb_frame
  while caller_frame.f_locals.get("self", None) is self:
  caller_frame = caller_frame.f_back
+ assert (
+ caller_frame
+ ), "No previous frame to the one with self in it, this shouldn't happen"
  return caller_frame.f_locals
 
  def __enter__(self) -> "DeviceCollector":

src/ophyd_async/core/_device_save_loader.py

@@ -1,5 +1,6 @@
 from collections.abc import Callable, Generator, Sequence
 from enum import Enum
+from pathlib import Path
 from typing import Any
 
 import numpy as np
@@ -68,8 +69,8 @@ def get_signal_values(
  selected_values = yield Msg("locate", *selected_signals.values())
 
  # TODO: investigate wrong type hints
- if isinstance(selected_values, dict):
- selected_values = [selected_values] # type: ignore
+ # if isinstance(selected_values, dict):
+ # selected_values = [selected_values] # type: ignore
 
  assert selected_values is not None, "No signalRW's were able to be located"
  named_values = {
@@ -123,7 +124,7 @@ def walk_rw_signals(
  return signals
 
 
-def save_to_yaml(phases: Sequence[dict[str, Any]], save_path: str) -> None:
+def save_to_yaml(phases: Sequence[dict[str, Any]], save_path: str | Path) -> None:
  """Plan which serialises a phase or set of phases of SignalRWs to a yaml file.
 
  Parameters

src/ophyd_async/core/_flyer.py

@@ -2,7 +2,8 @@
 from collections.abc import Sequence
 from typing import Generic
 
-from bluesky.protocols import DataKey, Flyable, Preparable, Reading, Stageable
+from bluesky.protocols import Flyable, Preparable, Reading, Stageable
+from event_model import DataKey
 
 from ._device import Device
 from ._signal import SignalR

src/ophyd_async/core/_hdf_dataset.py

@@ -7,6 +7,7 @@
  ComposeStreamResource,
  ComposeStreamResourceBundle,
  StreamDatum,
+ StreamRange,
  StreamResource,
 )
 
@@ -79,15 +80,10 @@ def stream_resources(self) -> Iterator[StreamResource]:
  def stream_data(self, indices_written: int) -> Iterator[StreamDatum]:
  # Indices are relative to resource
  if indices_written > self._last_emitted:
- indices = {
+ indices: StreamRange = {
  "start": self._last_emitted,
  "stop": indices_written,
  }
  self._last_emitted = indices_written
  for bundle in self._bundles:
  yield bundle.compose_stream_datum(indices)
- return None
-
- def close(self) -> None:
- for bundle in self._bundles:
- bundle.close()

src/ophyd_async/core/_log.py

@@ -29,7 +29,7 @@ class ColoredFormatterWithDeviceName(colorlog.ColoredFormatter):
  def format(self, record):
  message = super().format(record)
  if hasattr(record, "ophyd_async_device_name"):
- message = f"[{record.ophyd_async_device_name}]{message}"
+ message = f"[{record.ophyd_async_device_name}]{message}" # type: ignore
  return message
 
 
@@ -39,6 +39,8 @@ def _validate_level(level) -> int:
  levelno = level
  elif isinstance(level, str):
  levelno = logging.getLevelName(level)
+ else:
+ raise TypeError(f"Level {level!r} is not an int or str")
 
  if isinstance(levelno, int):
  return levelno

src/ophyd_async/core/_protocol.py

@@ -10,7 +10,8 @@
  runtime_checkable,
 )
 
-from bluesky.protocols import DataKey, HasName, Reading
+from bluesky.protocols import HasName, Reading
+from event_model import DataKey
 
 if TYPE_CHECKING:
  from ._status import AsyncStatus
@@ -56,7 +57,7 @@ async def describe(self) -> dict[str, DataKey]:
 
 
 @runtime_checkable
-class AsyncConfigurable(Protocol):
+class AsyncConfigurable(HasName, Protocol):
  @abstractmethod
  async def read_configuration(self) -> dict[str, Reading]:
  """Same API as ``read`` but for slow-changing fields related to configuration.

src/ophyd_async/core/_providers.py

@@ -129,7 +129,7 @@ def __init__(
  num_calls_per_inc: int = 1,
  increment: int = 1,
  inc_delimeter: str = "_",
- base_name: str = None,
+ base_name: str | None = None,
  ) -> None:
  self._filename_provider = filename_provider
  self._base_directory_path = base_directory_path

src/ophyd_async/core/_readable.py

@@ -2,7 +2,8 @@
 from collections.abc import Callable, Generator, Sequence
 from contextlib import contextmanager
 
-from bluesky.protocols import DataKey, HasHints, Hints, Reading
+from bluesky.protocols import HasHints, Hints, Reading
+from event_model import DataKey
 
 from ._device import Device, DeviceVector
 from ._protocol import AsyncConfigurable, AsyncReadable, AsyncStageable
@@ -170,7 +171,7 @@ def add_children_as_readables(
 
  def add_readables(
  self,
- devices: Sequence[Device],
+ devices: Sequence[ReadableChild],
  wrapper: ReadableChildWrapper | None = None,
  ) -> None:
  """Add the given devices to the lists of known Devices
@@ -225,6 +226,10 @@ async def read_configuration(self) -> dict[str, Reading]:
  async def describe_configuration(self) -> dict[str, DataKey]:
  return await self.signal.describe()
 
+ @property
+ def name(self) -> str:
+ return self.signal.name
+
 
 class HintedSignal(HasHints, AsyncReadable):
  def __init__(self, signal: ReadableChild, allow_cache: bool = True) -> None:

src/ophyd_async/core/_signal.py

@@ -3,29 +3,25 @@
 import asyncio
 import functools
 from collections.abc import AsyncGenerator, Callable, Mapping
-from typing import (
- Any,
- Generic,
- TypeVar,
-)
+from typing import Any, Generic, TypeVar, cast
 
 from bluesky.protocols import (
- DataKey,
  Locatable,
  Location,
  Movable,
  Reading,
  Status,
  Subscribable,
 )
+from event_model import DataKey
 
 from ._device import Device
 from ._mock_signal_backend import MockSignalBackend
 from ._protocol import AsyncConfigurable, AsyncReadable, AsyncStageable
 from ._signal_backend import SignalBackend
 from ._soft_signal_backend import SignalMetadata, SoftSignalBackend
 from ._status import AsyncStatus
-from ._utils import DEFAULT_TIMEOUT, CalculatableTimeout, CalculateTimeout, Callback, T
+from ._utils import CALCULATE_TIMEOUT, DEFAULT_TIMEOUT, CalculatableTimeout, Callback, T
 
 S = TypeVar("S")
 
@@ -38,12 +34,25 @@ async def wrapper(self: Signal, *args, **kwargs):
  return wrapper
 
 
+def _fail(*args, **kwargs):
+ raise RuntimeError("Signal has not been supplied a backend yet")
+
+
+class DisconnectedBackend(SignalBackend):
+ source = connect = put = get_datakey = get_reading = get_value = get_setpoint = (
+ set_callback
+ ) = _fail
+
+
+DISCONNECTED_BACKEND = DisconnectedBackend()
+
+
 class Signal(Device, Generic[T]):
  """A Device with the concept of a value, with R, RW, W and X flavours"""
 
  def __init__(
  self,
- backend: SignalBackend[T] | None = None,
+ backend: SignalBackend[T] = DISCONNECTED_BACKEND,
  timeout: float | None = DEFAULT_TIMEOUT,
  name: str = "",
  ) -> None:
@@ -59,7 +68,10 @@ async def connect(
  backend: SignalBackend[T] | None = None,
  ):
  if backend:
- if self._backend and backend is not self._backend:
+ if (
+ self._backend is not DISCONNECTED_BACKEND
+ and backend is not self._backend
+ ):
  raise ValueError("Backend at connection different from previous one.")
 
  self._backend = backend
@@ -230,10 +242,10 @@ class SignalW(Signal[T], Movable):
  """Signal that can be set"""
 
  def set(
- self, value: T, wait=True, timeout: CalculatableTimeout = CalculateTimeout
+ self, value: T, wait=True, timeout: CalculatableTimeout = CALCULATE_TIMEOUT
  ) -> AsyncStatus:
  """Set the value and return a status saying when it's done"""
- if timeout is CalculateTimeout:
+ if timeout is CALCULATE_TIMEOUT:
  timeout = self._timeout
 
  async def do_set():
@@ -261,10 +273,10 @@ class SignalX(Signal):
  """Signal that puts the default value"""
 
  def trigger(
- self, wait=True, timeout: CalculatableTimeout = CalculateTimeout
+ self, wait=True, timeout: CalculatableTimeout = CALCULATE_TIMEOUT
  ) -> AsyncStatus:
  """Trigger the action and return a status saying when it's done"""
- if timeout is CalculateTimeout:
+ if timeout is CALCULATE_TIMEOUT:
  timeout = self._timeout
  coro = self._backend.put(None, wait=wait, timeout=timeout)
  return AsyncStatus(coro)
@@ -307,9 +319,7 @@ def soft_signal_r_and_setter(
  return (signal, backend.set_value)
 
 
-def _generate_assert_error_msg(
- name: str, expected_result: str, actual_result: str
-) -> str:
+def _generate_assert_error_msg(name: str, expected_result, actual_result) -> str:
  WARNING = "\033[93m"
  FAIL = "\033[91m"
  ENDC = "\033[0m"
@@ -475,7 +485,7 @@ async def get_value():
  else:
  break
  else:
- yield item
+ yield cast(T, item)
  finally:
  signal.clear_sub(q.put_nowait)
 
@@ -531,7 +541,7 @@ async def wait_for_value(
  wait_for_value(device.num_captured, lambda v: v > 45, timeout=1)
  """
  if callable(match):
- checker = _ValueChecker(match, match.__name__)
+ checker = _ValueChecker(match, match.__name__) # type: ignore
  else:
  checker = _ValueChecker(lambda v: v == match, repr(match))
  await checker.wait_for_value(signal, timeout)

src/ophyd_async/core/_signal_backend.py

@@ -1,12 +1,15 @@
 from abc import abstractmethod
 from typing import (
  TYPE_CHECKING,
+ Any,
  ClassVar,
  Generic,
  Literal,
 )
 
-from ._protocol import DataKey, Reading
+from bluesky.protocols import Reading
+from event_model import DataKey
+
 from ._utils import DEFAULT_TIMEOUT, ReadingValueCallback, T
 
 
@@ -18,7 +21,7 @@ class SignalBackend(Generic[T]):
 
  @classmethod
  @abstractmethod
- def datatype_allowed(cls, dtype: type):
+ def datatype_allowed(cls, dtype: Any) -> bool:
  """Check if a given datatype is acceptable for this signal backend."""
 
  #: Like ca://PV_PREFIX:SIGNAL
@@ -59,7 +62,7 @@ def set_callback(self, callback: ReadingValueCallback[T] | None) -> None:
 class _RuntimeSubsetEnumMeta(type):
  def __str__(cls):
  if hasattr(cls, "choices"):
- return f"SubsetEnum{list(cls.choices)}"
+ return f"SubsetEnum{list(cls.choices)}" # type: ignore
  return "SubsetEnum"
 
  def __getitem__(cls, _choices):