Skip to content

Removed is_array_flag #20

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.

Sign up for GitHub

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

Merged
JeanLucPons merged 1 commit into from
Jun 5, 2026
Merged

Removed is_array_flag #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions pyaml_cs_oa/controlsystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,11 @@ def __init__(self, cfg: ConfigModel):

def attach(self, devs: list[OASignal | None]) -> list[OASignal | None]:
# Deprecated function
return self._attach([d._cfg if d is not None else None for d in devs], False)
return self._attach([d._cfg if d is not None else None for d in devs])

def attach_array(self, devs: list[OASignal | None]) -> list[OASignal | None]:
# Deprecated function
return self._attach([d._cfg if d is not None else None for d in devs], True)
return self._attach([d._cfg if d is not None else None for d in devs])

def get_device(self, ref: str | BaseModel | None) -> DeviceAccess | None:
if ref is None:
Expand All @@ -93,17 +93,17 @@ def get_device(self, ref: str | BaseModel | None) -> DeviceAccess | None:
raise PyAMLException(f"Control system '{self.name()}' catalog cannot resolve key '{ref}'") from exc

if isinstance(ref, EpicsConfigR):
return self._attach([ref], ref.index is not None)[0]
return self._attach([ref])[0]

@gupichon gupichon Jun 5, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an error, but it's not from this PR. The attach method expects a DeviceAccess, not a config model. An issue should be opened about this.

@JeanLucPons JeanLucPons Jun 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

attach() method expect DeviceAccess but they are deprecated and will be removed.
_attach() internal method well take ConfigModel.

if isinstance(ref, EpicsConfigW):
return self._attach([ref], ref.index is not None)[0]
return self._attach([ref])[0]
if isinstance(ref, EpicsConfigRW):
return self._attach([ref], ref.index is not None)[0]
return self._attach([ref])[0]
if isinstance(ref, TangoConfigAtt):
return self._attach([ref], ref.index is not None)[0]
return self._attach([ref])[0]

raise PyAMLException(f"Control system '{self.name()}' cannot build a device from {type(ref).__name__}")

def _attach(self, configs: list[ControlSysConfig | None], is_array: bool) -> list[OASignal | None]:
def _attach(self, configs: list[ControlSysConfig | None]) -> list[OASignal | None]:
# Concatenate the prefix
newDevs = []
for sig_cfg in configs:
Expand Down Expand Up @@ -135,7 +135,7 @@ def _attach(self, configs: list[ControlSysConfig | None], is_array: bool) -> lis

if key not in self._devices:
n_conf = dict(sig_cfg) | config
nr = sig_cls(sig_cfg_cls(**n_conf), is_array)
nr = sig_cls(sig_cfg_cls(**n_conf))
nr.build()
self._devices[key] = nr

Expand Down
2 changes: 1 addition & 1 deletion pyaml_cs_oa/epics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def create_signal_rw(read_pv: str, write_pv: str, timeout: float) -> SignalR:
return ALL_RW[key]


def get_SP_RB(cfg: ControlSysConfig, is_array: bool) -> tuple[Setpoint | None, Readback | None]:
def get_SP_RB(cfg: ControlSysConfig) -> tuple[Setpoint | None, Readback | None]:
setpoint: Setpoint | None = None
readback: Readback | None = None

Expand Down
4 changes: 2 additions & 2 deletions pyaml_cs_oa/epicsR.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ class ConfigModel(EpicsConfigR): ...


class EpicsR(FloatSignalContainer):
def __init__(self, cfg: ConfigModel, is_array: bool = False):
super().__init__(cfg, is_array)
def __init__(self, cfg: ConfigModel):
super().__init__(cfg)

def get_cs(self) -> str:
return "epics"
4 changes: 2 additions & 2 deletions pyaml_cs_oa/epicsRW.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ class ConfigModel(EpicsConfigRW): ...


class EpicsRW(FloatSignalContainer):
def __init__(self, cfg: ConfigModel, is_array: bool = False):
super().__init__(cfg, is_array)
def __init__(self, cfg: ConfigModel):
super().__init__(cfg)

def get_cs(self) -> str:
return "epics"
4 changes: 2 additions & 2 deletions pyaml_cs_oa/epicsW.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ class ConfigModel(EpicsConfigW): ...


class EpicsW(FloatSignalContainer):
def __init__(self, cfg: ConfigModel, is_array: bool = False):
super().__init__(cfg, is_array)
def __init__(self, cfg: ConfigModel):
super().__init__(cfg)

def get_cs(self) -> str:
return "epics"
4 changes: 2 additions & 2 deletions pyaml_cs_oa/float_signal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ class FloatSignalContainer(OASignal):
Class that implements a PyAML Float/FloatArray Signal using ophyd_async Signals.
"""

def __init__(self, cfg: ControlSysConfig, is_array: bool):
super().__init__(cfg, is_array)
def __init__(self, cfg: ControlSysConfig):
super().__init__(cfg)

def _indexed_float(self, value) -> float:
if self._cfg.index is None:
Expand Down
6 changes: 2 additions & 4 deletions pyaml_cs_oa/signal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ class OASignal(DeviceAccess):
Class that implements a PyAML Signal using ophyd_async Signals.
"""

def __init__(self, cfg: ControlSysConfig, is_array: bool = False):
def __init__(self, cfg: ControlSysConfig):
self._cfg = cfg
# is_array is forced True whenever any index is specified.
self.is_array = is_array or cfg.index is not None

def build(self):
self._readable: bool = isinstance(self._cfg, (EpicsConfigR, TangoConfigAtt))
Expand All @@ -31,7 +29,7 @@ def build(self):
else:
raise ValueError(f"Unsupported cs_name: {cs_name}")

self.SP, self.RB = get_SP_RB(self._cfg, self.is_array)
self.SP, self.RB = get_SP_RB(self._cfg)

if self.SP:
self.SP.__peer__ = self
Expand Down
4 changes: 2 additions & 2 deletions pyaml_cs_oa/tango.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
)


def get_SP_RB(cfg: ControlSysConfig, is_array: bool) -> tuple[Setpoint | None, Readback | None]:
def get_SP_RB(cfg: ControlSysConfig) -> tuple[Setpoint | None, Readback | None]:
setpoint: Setpoint | None = None
readback: Readback | None = None

assert isinstance(cfg, TangoConfigAtt)

rw_sig = tango_signal_rw(
datatype=float if not is_array else Array1D[numpy.float64],
datatype=None,
read_trl=cfg.attribute,
write_trl=cfg.attribute,
timeout=cfg.timeout_ms,
Expand Down
4 changes: 2 additions & 2 deletions pyaml_cs_oa/tangoAtt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ class ConfigModel(TangoConfigAtt): ...


class TangoAtt(FloatSignalContainer):
def __init__(self, cfg: ConfigModel, is_array: bool = False):
super().__init__(cfg, is_array)
def __init__(self, cfg: ConfigModel):
super().__init__(cfg)

def get_cs(self) -> str:
return "tango"
2 changes: 1 addition & 1 deletion tests/test_bpm_orbit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class IndexedVectorSignal(FloatSignalContainer):
"""FloatSignalContainer fake resolving one indexed value from a shared vector."""

def __init__(self, config: IndexedVectorSignalConfig) -> None:
super().__init__(config, is_array=True)
super().__init__(config)
self._readable = True
self._writable = False
self.RB = _VectorReadSide(config.source)
Expand Down
14 changes: 4 additions & 10 deletions tests/test_factories.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def test_epics_read_only_factory_builds_readback(
spy = SignalFactorySpy("epics-r")
monkeypatch.setattr(epics, "epics_signal_r", spy)

setpoint, readback = epics.get_SP_RB(EpicsConfigR(read_pvname="PV:RB"), False)
setpoint, readback = epics.get_SP_RB(EpicsConfigR(read_pvname="PV:RB"))

assert setpoint is None
assert isinstance(readback, OAReadback)
Expand All @@ -45,7 +45,7 @@ def test_epics_write_only_factory_builds_setpoint(
spy = SignalFactorySpy("epics-w")
monkeypatch.setattr(epics, "epics_signal_w", spy)

setpoint, readback = epics.get_SP_RB(EpicsConfigW(write_pvname="PV:SP"), False)
setpoint, readback = epics.get_SP_RB(EpicsConfigW(write_pvname="PV:SP"))

assert isinstance(setpoint, OASetpoint)
assert readback is None
Expand All @@ -59,10 +59,7 @@ def test_epics_read_write_factory_reuses_single_rw_signal(
spy = SignalFactorySpy("epics-rw")
monkeypatch.setattr(epics, "epics_signal_rw", spy)

setpoint, readback = epics.get_SP_RB(
EpicsConfigRW(read_pvname="PV:RB", write_pvname="PV:SP"),
False,
)
setpoint, readback = epics.get_SP_RB(EpicsConfigRW(read_pvname="PV:RB", write_pvname="PV:SP"))

assert isinstance(setpoint, OASetpoint)
assert isinstance(readback, OAReadback)
Expand All @@ -77,10 +74,7 @@ def test_tango_read_write_factory_reuses_single_rw_signal(
spy = SignalFactorySpy("tango-rw")
monkeypatch.setattr(tango, "tango_signal_rw", spy)

setpoint, readback = tango.get_SP_RB(
TangoConfigAtt(attribute="sys/tg_test/1/value"),
False,
)
setpoint, readback = tango.get_SP_RB(TangoConfigAtt(attribute="sys/tg_test/1/value"))

assert isinstance(setpoint, OASetpoint)
assert isinstance(readback, OAReadback)
Expand Down
2 changes: 1 addition & 1 deletion tests/test_scalar_aggregator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class FakeScalarSignal(FloatSignalContainer):
"""FloatSignalContainer test double with fake SP/RB sides."""

def __init__(self, value: float, writable: bool = True) -> None:
super().__init__(EpicsConfigR(read_pvname="PV:RB"), is_array=False)
super().__init__(EpicsConfigR(read_pvname="PV:RB"))
self._writable = writable
self.SP = _FakeSide(value, signal_key=object())
self.RB = _FakeSide(value, signal_key=object())
Expand Down
8 changes: 3 additions & 5 deletions tests/test_signal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ def test_epics_signal_build_sets_peer_on_built_sides(
setpoint = BuiltSide()
readback = BuiltSide()

def fake_get_sp_rb(cfg, is_array):
def fake_get_sp_rb(cfg):
assert cfg.read_pvname == "PV:RB"
assert cfg.write_pvname == "PV:SP"
assert is_array is False
return setpoint, readback

monkeypatch.setattr("pyaml_cs_oa.epics.get_SP_RB", fake_get_sp_rb)
Expand All @@ -40,14 +39,13 @@ def fake_get_sp_rb(cfg, is_array):
def test_tango_signal_build_uses_tango_factory(monkeypatch: pytest.MonkeyPatch) -> None:
readback = BuiltSide()

def fake_get_sp_rb(cfg, is_array):
def fake_get_sp_rb(cfg):
assert cfg.attribute == "sys/tg_test/1/value"
assert is_array is True
return None, readback

monkeypatch.setattr("pyaml_cs_oa.tango.get_SP_RB", fake_get_sp_rb)

signal = TangoAtt(TangoAttConfig(attribute="sys/tg_test/1/value"), is_array=True)
signal = TangoAtt(TangoAttConfig(attribute="sys/tg_test/1/value"))
signal.build()

assert signal.SP is None
Expand Down
Loading