From 38af4a06ef7c59949edc3cfdee4df62d51e6d45f Mon Sep 17 00:00:00 2001 From: Alexander Reynolds Date: Thu, 25 Sep 2025 14:23:09 -0400 Subject: [PATCH] fix: dataram -> datagram typo --- py_lab_hal/cominterface/cominterface.py | 25 ++++++++++++++----- .../remote_power_switch/digipdu_zdhx.py | 2 +- .../remote_power_switch/web_power_switch.py | 2 +- py_lab_hal/instrument/scope/tektronix_mso.py | 2 +- .../spectro_radio_meter/jadak_pr670.py | 2 +- 5 files changed, 23 insertions(+), 10 deletions(-) diff --git a/py_lab_hal/cominterface/cominterface.py b/py_lab_hal/cominterface/cominterface.py index d3218a8..5c2a586 100644 --- a/py_lab_hal/cominterface/cominterface.py +++ b/py_lab_hal/cominterface/cominterface.py @@ -564,9 +564,9 @@ def send_raw(self, data: bytes, timeout: int = -1) -> None: data (bytes): The raw data to send. timeout (int, optional): Timeout in seconds. Defaults to -1. """ - self.send_dataram(self._build_bytes_datagram(data), timeout=timeout) + self.send_datagram(self._build_bytes_datagram(data), timeout=timeout) - def send_dataram(self, dg: datagram.Datagram, timeout: int = -1): + def send_datagram(self, dg: datagram.Datagram, timeout: int = -1): """Send datagram to the interface. Args: @@ -576,6 +576,13 @@ def send_dataram(self, dg: datagram.Datagram, timeout: int = -1): self.interface.set_timeout(timeout) dg.send(self.interface) + def send_dataram(self, dg: datagram.Datagram, timeout: int = -1): + import warnings + + warnings.warn("send_dataram is deprecated, use send_datagram instead", DeprecationWarning) + return self.send_datagram(dg, timeout=timeout) + + def recv(self, timeout: int = -1, size: int = -1) -> str: """Receive data from the interface. @@ -598,11 +605,11 @@ def recv_raw(self, timeout: int = -1, size: int = -1) -> bytes: Returns: bytes: The raw data from the interface. """ - return self.recv_dataram( + return self.recv_datagram( self._build_bytes_datagram(size=size), timeout=timeout ).data - def recv_dataram(self, dg: T, timeout: int = -1) -> T: + def recv_datagram(self, dg: T, timeout: int = -1) -> T: """Receive datagram from the interface. Args: @@ -616,6 +623,12 @@ def recv_dataram(self, dg: T, timeout: int = -1) -> T: dg.recv(self.interface) return dg + def recv_dataram(self, dg: T, timeout: int = -1) -> T: + import warnings + + warnings.warn("recv_dataram is deprecated, use recv_datagram instead", DeprecationWarning) + return self.recv_datagram(dg, timeout=timeout) + def query(self, command: str, timeout: int = -1, size: int = -1) -> str: recv = self.query_raw(command.encode(), timeout=timeout, size=size) return recv.strip( @@ -633,8 +646,8 @@ def query_datagram( self, send_dg: datagram.Datagram, recv_dg: T, timeout: int = -1 ) -> T: self.interface.set_timeout(timeout) - self.send_dataram(send_dg) - return self.recv_dataram(recv_dg) + self.send_datagram(send_dg) + return self.recv_datagram(recv_dg) class ComInterfaceClass(ComInterfaceClassBase): diff --git a/py_lab_hal/instrument/remote_power_switch/digipdu_zdhx.py b/py_lab_hal/instrument/remote_power_switch/digipdu_zdhx.py index c2828ea..bcbd3c4 100644 --- a/py_lab_hal/instrument/remote_power_switch/digipdu_zdhx.py +++ b/py_lab_hal/instrument/remote_power_switch/digipdu_zdhx.py @@ -95,7 +95,7 @@ def enable(self, channel, enable): url = self.data_handler.interface.connect_config.http_config.url msg = f'http://{url}/out_ctrl.csp?port={channel}&ctrl_kind={state}' dg = datagram.HttpDatagram(url=msg, method='get') - self.data_handler.send_dataram(dg) + self.data_handler.send_datagram(dg) else: raise RuntimeError( 'The selected interface:' diff --git a/py_lab_hal/instrument/remote_power_switch/web_power_switch.py b/py_lab_hal/instrument/remote_power_switch/web_power_switch.py index 9b22574..1cd6662 100644 --- a/py_lab_hal/instrument/remote_power_switch/web_power_switch.py +++ b/py_lab_hal/instrument/remote_power_switch/web_power_switch.py @@ -46,6 +46,6 @@ def enable(self, channel, enable): method='put', data={'value': state}, ) - self.data_handler.send_dataram(dg) + self.data_handler.send_datagram(dg) time.sleep(0.2) diff --git a/py_lab_hal/instrument/scope/tektronix_mso.py b/py_lab_hal/instrument/scope/tektronix_mso.py index bc8dfdf..77a8689 100644 --- a/py_lab_hal/instrument/scope/tektronix_mso.py +++ b/py_lab_hal/instrument/scope/tektronix_mso.py @@ -879,7 +879,7 @@ def save_file(self, file_name: str, path: str, file_type: str = ''): f.write(self.data_handler.recv_raw()) def _save_png_file(self, path: str): - png_dg = self.data_handler.recv_dataram(datagram.PngDatagram()) + png_dg = self.data_handler.recv_datagram(datagram.PngDatagram()) with open(path, 'wb+') as f: f.write(png_dg.data) self.data_handler.recv() diff --git a/py_lab_hal/instrument/spectro_radio_meter/jadak_pr670.py b/py_lab_hal/instrument/spectro_radio_meter/jadak_pr670.py index 0f6e903..25f5def 100644 --- a/py_lab_hal/instrument/spectro_radio_meter/jadak_pr670.py +++ b/py_lab_hal/instrument/spectro_radio_meter/jadak_pr670.py @@ -32,7 +32,7 @@ def _build_bytes_datagram( ) def _send_command(self, command: bytes): - self.data_handler.send_dataram(self._build_bytes_datagram(command)) + self.data_handler.send_datagram(self._build_bytes_datagram(command)) def open_interface(self): super().open_interface()