PyOpenocdClient 0.1.1__tar.gz → 0.1.2__tar.gz

{pyopenocdclient-0.1.1/src/PyOpenocdClient.egg-info → pyopenocdclient-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOpenocdClient
-Version: 0.1.1
+Version: 0.1.2
 Summary: Library for controlling OpenOCD from Python programs
 Author-email: Jan Matyas <info@janmatyas.net>
 Project-URL: Homepage, https://github.com/HonzaMat/PyOpenocdClient

{pyopenocdclient-0.1.1 → pyopenocdclient-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "PyOpenocdClient"
-version = "0.1.1"
+version = "0.1.2"
 authors = [
   { name="Jan Matyas", email="info@janmatyas.net" },
 ]

{pyopenocdclient-0.1.1 → pyopenocdclient-0.1.2/src/PyOpenocdClient.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOpenocdClient
-Version: 0.1.1
+Version: 0.1.2
 Summary: Library for controlling OpenOCD from Python programs
 Author-email: Jan Matyas <info@janmatyas.net>
 Project-URL: Homepage, https://github.com/HonzaMat/PyOpenocdClient

{pyopenocdclient-0.1.1 → pyopenocdclient-0.1.2}/src/py_openocd_client/baseclient.py

@@ -94,10 +94,35 @@ class _PyOpenocdBaseClient:
             raise ValueError("Timeout must be greater than zero")
         self._default_recv_timeout = timeout
 
-    def _check_no_premature_recvd_bytes(self) -> None:
+    def _check_connection_before_command(self) -> None:
         assert self._socket is not None
         rd, _, _ = select.select([self._socket], [], [], 0)  # Don't block, just poll
-        if len(rd) > 0:
+
+        if len(rd) == 0:
+            # The socket is not ready for recv() now, which is the expected state.
+            # Success.
+            return
+
+        # The socket is ready for recv(). This is unexpected at this point
+        # and always means an error. Try receive from the socket to find out
+        # what happened:
+        try:
+            recvd_data = self._socket.recv(128)
+        except OSError as e:
+            # This is unlikely to happen: It would mean that the socket is ready
+            # for recv() but then recv() failed.
+            raise OcdConnectionError(
+                "Connection to OpenOCD broken for an unknown reason"
+            ) from e
+
+        if len(recvd_data) == 0:
+            # Empty received data means that the connection got closed by OpenOCD
+            # in the meanwhile.
+            raise OcdConnectionError("Connection closed by OpenOCD")
+        else:
+            # It looks like OpenOCD sent us some extra, unsolicited bytes (without us
+            # sending any command to OpenOCD). This is a violation of the communication
+            # protocol.
             raise OcdConnectionError(
                 "Received unexpected bytes from OpenOCD before "
                 "the command was even sent."
@@ -107,12 +132,27 @@ class _PyOpenocdBaseClient:
         assert self.is_connected()
         assert self._socket is not None
 
-        # Safety:
-        self._check_no_premature_recvd_bytes()
+        # Perform basic connection check before sending a command.
+        # Note that this is merely a safety/correctness check which itself
+        # does not guarantee that the subsequent send() and recv() calls
+        # will succeed.
+        self._check_connection_before_command()
 
         data = raw_cmd.encode(self.CHARSET) + self.COMMAND_DELIMITER
-        self._socket.settimeout(self.SEND_TIMEOUT)
-        self._socket.send(data)
+
+        try:
+            self._socket.settimeout(self.SEND_TIMEOUT)
+        except OSError as e:
+            raise OcdConnectionError(
+                "Could not send a command to OpenOCD, failed to set socket timeout"
+            ) from e
+
+        try:
+            self._socket.send(data)
+        except OSError as e:
+            raise OcdConnectionError(
+                "Could not send a command to OpenOCD, socket error occurred"
+            ) from e
 
     def _do_recv_response(self, raw_cmd: str, timeout: Optional[float] = None) -> str:
         assert self.is_connected()
@@ -123,7 +163,13 @@ class _PyOpenocdBaseClient:
             timeout if timeout is not None else self._default_recv_timeout
         )
 
-        self._socket.settimeout(self.RECV_POLL_TIMEOUT)
+        try:
+            self._socket.settimeout(self.RECV_POLL_TIMEOUT)
+        except OSError as e:
+            raise OcdConnectionError(
+                "Could not receive a response from OpenOCD, "
+                "failed to set socket timeout"
+            ) from e
 
         time_start = time.time()
         while time.time() < (time_start + effective_timeout):
@@ -131,6 +177,10 @@ class _PyOpenocdBaseClient:
                 d = self._socket.recv(self.RECV_BLOCK_SIZE)
             except socket.timeout:
                 continue
+            except OSError as e:
+                raise OcdConnectionError(
+                    "Could not receive a response from OpenOCD, socket error occurred"
+                ) from e
 
             if d == b"":
                 raise OcdConnectionError("Connection closed by OpenOCD")

{pyopenocdclient-0.1.1 → pyopenocdclient-0.1.2}/src/py_openocd_client/client.py

@@ -211,25 +211,34 @@ class PyOpenocdClient:
             raw_cmd = cmd
 
         raw_cmd = "set CMD_RETCODE [ catch { " + raw_cmd + " } CMD_OUTPUT ] ; "
-        raw_cmd += 'return "$CMD_RETCODE $CMD_OUTPUT" ; '
+
+        # Older OpenOCD versions - prior to 93f16eed4(*) - incorrectly trimmed trailing
+        # whitespace from the string passed to the return command. Work around this bug
+        # by wrapping the string by non-whitespace characters.
+        # (*): https://review.openocd.org/c/openocd/+/9084
+        raw_cmd += 'return "<$CMD_RETCODE,$CMD_OUTPUT>" ; '
 
         raw_result = self.raw_cmd(raw_cmd, timeout=timeout)
 
-        # Verify the raw output from OpenOCD the has the expected format. It can be:
-        #
-        # - Command return code (positive or negative decimal number) and that's it.
-        #
-        # - Or, command return code (positive or negative decimal number) followed by
-        #   a space character and optionally followed by the command's textual output.
-        if re.match(r"^-?\d+($| )", raw_result) is None:
+        def is_expected_raw_result(s: str) -> bool:
+            return (
+                s.startswith("<")
+                and s.endswith(">")
+                and re.match(r"^<-?\d+,", s) is not None
+            )
+
+        if not is_expected_raw_result(raw_result):
             msg = (
                 "Received unexpected response from OpenOCD. "
                 "It looks like OpenOCD misbehaves. "
             )
             raise OcdInvalidResponseError(msg, raw_cmd, raw_result)
 
-        raw_result_parts = raw_result.split(" ", maxsplit=1)
-        assert len(raw_result_parts) in [1, 2]
+        # Remove leading "<" and trailing ">"
+        raw_result = raw_result[1:-1]
+        raw_result_parts = raw_result.split(",", maxsplit=1)
+        assert len(raw_result_parts) == 2
+
         retcode = int(raw_result_parts[0], 10)
         out = raw_result_parts[1] if len(raw_result_parts) == 2 else ""