Recognize notifications without payload

Author: H0bo

CHANGELOG.md

@@ -1,5 +1,8 @@
 # pygdbmi release history
 
+## 0.10.0.3
+* Fixed a bug where notifications without a payload were not recognized as such
+
 ## 0.10.0.2
 * Strings containing escapes are now unescaped, both for messages in error records, which were previously mangled (#57), and textual records, which were previously left escaped (#58)
 * Dropped support for Python 3.6 and added explicit support for Python 3.9 and 3.10.

pygdbmi/gdbmiparser.py

@@ -149,14 +149,14 @@ def assert_match(actual_char_or_str, expected_char_or_str):
 # In addition to a number of out-of-band notifications,
 # the response to a gdb/mi command includes one of the following result indications:
 # done, running, connected, error, exit
-_GDB_MI_RESULT_RE = re.compile(r"^(\d*)\^(\S+?)(,(.*))?$")
+_GDB_MI_RESULT_RE = re.compile(r"^(\d*)\^(\S+?)(,.*)?$")
 
 # https://sourceware.org/gdb/onlinedocs/gdb/GDB_002fMI-Async-Records.html#GDB_002fMI-Async-Records
 # Async records are used to notify the gdb/mi client of additional
 # changes that have occurred. Those changes can either be a consequence
 # of gdb/mi commands (e.g., a breakpoint modified) or a result of target activity
 # (e.g., target stopped).
-_GDB_MI_NOTIFY_RE = re.compile(r"^(\d*)[*=](\S+?),(.*)$")
+_GDB_MI_NOTIFY_RE = re.compile(r"^(\d*)[*=](\S+?)(,.*)*$")
 
 # https://sourceware.org/gdb/onlinedocs/gdb/GDB_002fMI-Stream-Records.html#GDB_002fMI-Stream-Records
 # "~" string-output
@@ -193,23 +193,29 @@ def assert_match(actual_char_or_str, expected_char_or_str):
 
 def _get_notify_msg_and_payload(result, stream: StringStream):
     """Get notify message and payload dict"""
-    token = stream.advance_past_chars(["=", "*"])
-    token = int(token) if token != "" else None
-    logger.debug("%s", fmt_green("parsing message"))
-    message = stream.advance_past_chars([","])
+    match = _GDB_MI_NOTIFY_RE.match(result)
+    assert match is not None
+    groups = match.groups()
+    token = int(groups[0]) if groups[0] != "" else None
+    message = groups[1]
 
     logger.debug("parsed message")
     logger.debug("%s", fmt_green(message))
 
-    payload = _parse_dict(stream)
+    if groups[2] is None:
+        payload = None
+    else:
+        stream.advance_past_chars([","])
+        payload = _parse_dict(stream)
+
     return token, message.strip(), payload
 
 
 def _get_result_msg_and_payload(result, stream: StringStream):
     """Get result message and payload dict"""
-
     match = _GDB_MI_RESULT_RE.match(result)
-    groups = match.groups() if match else [""]
+    assert match is not None
+    groups = match.groups()
     token = int(groups[0]) if groups[0] != "" else None
     message = groups[1]
 

tests/test_pygdbmi.py

@@ -194,6 +194,27 @@ def test_parser(self):
             },
         )
 
+        # Test async records status changes
+        assert_match(
+            parse_response('*running,thread-id="all"'),
+            {
+                "type": "notify",
+                "payload": {"thread-id": "all"},
+                "message": "running",
+                "token": None,
+            },
+        )
+
+        assert_match(
+            parse_response("*stopped"),
+            {
+                "type": "notify",
+                "payload": None,
+                "message": "stopped",
+                "token": None,
+            },
+        )
+
     def _get_c_program(self, makefile_target_name, binary_name):
         """build c program and return path to binary"""
         find_executable(MAKE_CMD)