Skip to content

Commit

Permalink
refactor: Update all error messages for VISA devices to always includ…
Browse files Browse the repository at this point in the history
…e the failed command unless explicitly called with the method's `verbose` parameter set to False
  • Loading branch information
nfelt14 committed Feb 19, 2025
1 parent 9e13b48 commit cb6ef96
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions src/tm_devices/driver_mixins/device_control/pi_control.py
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ def query( # pylint: disable=arguments-differ
if remove_quotes:
response = response.replace('"', "")
except (visa.VisaIOError, socket.error) as error:
pi_cmd_repr = f" for {query!r} " if self._verbose and verbose else " "
pi_cmd_repr = f" for {query!r} " if verbose else " "
msg = (
f"The query of {self._name_and_alias}{pi_cmd_repr}"
f"failed with the following message: {error!r}"
Expand All @@ -365,9 +365,7 @@ def query( # pylint: disable=arguments-differ
)

if not allow_empty and not response:
pi_cmd_repr = (
f" for the following query: {query!r}" if self._verbose and verbose else ""
)
pi_cmd_repr = f" for the following query: {query!r}" if verbose else ""
msg = f"An empty string was returned from {self._name_and_alias}{pi_cmd_repr}"
_logger.error(msg)
raise SystemError(msg)
Expand Down Expand Up @@ -398,7 +396,7 @@ def query_binary(self, query: str, verbose: bool = True) -> Sequence[float]:
try:
response = self._visa_resource.query_binary_values(query) # pyright: ignore[reportUnknownMemberType]
except (visa.VisaIOError, socket.error) as error:
pi_cmd_repr = f" for {query!r} " if self._verbose and verbose else " "
pi_cmd_repr = f" for {query!r} " if verbose else " "
msg = (
f"The binary query of {self._name_and_alias}{pi_cmd_repr}"
f"failed with the following message: {error!r}"
Expand All @@ -414,9 +412,7 @@ def query_binary(self, query: str, verbose: bool = True) -> Sequence[float]:
)

if not response:
pi_cmd_repr = (
f" for the following binary query: {query!r}" if self._verbose and verbose else ""
)
pi_cmd_repr = f" for the following binary query: {query!r}" if verbose else ""
msg = f"An empty string was returned from {self._name_and_alias}{pi_cmd_repr}"
_logger.error(msg)
raise SystemError(msg)
Expand Down Expand Up @@ -533,7 +529,7 @@ def query_raw_binary(self, query: str, verbose: bool = True) -> bytes:
self._visa_resource.write(query)
response = self.read_raw()
except (visa.VisaIOError, socket.error) as error:
pi_cmd_repr = f" for {query!r} " if self._verbose and verbose else " "
pi_cmd_repr = f" for {query!r} " if verbose else " "
msg = (
f"The raw binary query of {self._name_and_alias}{pi_cmd_repr}"
f"failed with the following message: {error!r}"
Expand All @@ -549,11 +545,7 @@ def query_raw_binary(self, query: str, verbose: bool = True) -> bytes:
)

if not response.strip():
pi_cmd_repr = (
f" for the following raw binary query: {query!r}"
if self._verbose and verbose
else ""
)
pi_cmd_repr = f" for the following raw binary query: {query!r}" if verbose else ""
msg = f"An empty string was returned from {self._name_and_alias}{pi_cmd_repr}"
_logger.error(msg)
raise SystemError(msg)
Expand Down Expand Up @@ -871,7 +863,7 @@ def write(self, command: str, opc: bool = False, verbose: bool = True) -> None:
try:
self._visa_resource.write(command)
except (visa.VisaIOError, socket.error) as error:
pi_cmd_repr = f" for {command!r} " if self._verbose and verbose else " "
pi_cmd_repr = f" for {command!r} " if verbose else " "
msg = (
f"The write to {self._name_and_alias}{pi_cmd_repr}"
f"failed with the following message: {error!r}"
Expand All @@ -880,7 +872,7 @@ def write(self, command: str, opc: bool = False, verbose: bool = True) -> None:
raise visa.Error(msg) from error

if opc and (result := self.ieee_cmds.opc()) != "1":
pi_cmd_repr = f" {command!r}" if self._verbose and verbose else " the command"
pi_cmd_repr = f" {command!r}" if verbose else " the command"
msg = (
f"After issuing{pi_cmd_repr} to {self._name_and_alias}, "
f"OPC returned incorrect data: {result!r}"
Expand Down Expand Up @@ -908,7 +900,7 @@ def write_raw(self, command: bytes, verbose: bool = True) -> None:
try:
self._visa_resource.write_raw(command)
except (visa.VisaIOError, socket.error) as error:
pi_cmd_repr = f" for {command!r} " if self._verbose and verbose else " "
pi_cmd_repr = f" for {command!r} " if verbose else " "
msg = (
f"The raw write to {self._name_and_alias}"
f"{pi_cmd_repr}failed with the following message: {error!r}"
Expand Down

0 comments on commit cb6ef96

Please sign in to comment.