[v3,34/63] qapi/schema: add __repr__ to QAPIDoc.Section

Commit Message

John Snow March 11, 2025, 3:42 a.m. UTC

Makes debugging far more pleasant when you can just print(section) and
get something reasonable to display.

Signed-off-by: John Snow <[e-mail]>
---
 scripts/qapi/parser.py | 3 +++
 1 file changed, 3 insertions(+)

Comments

Markus Armbruster March 11, 2025, 7:03 a.m. UTC | #1

John Snow <[e-mail]> writes:

> Makes debugging far more pleasant when you can just print(section) and
> get something reasonable to display.
>
> Signed-off-by: John Snow <[e-mail]>
> ---
>  scripts/qapi/parser.py | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
> index 94d5322f8af..11c11bb09e5 100644
> --- a/scripts/qapi/parser.py
> +++ b/scripts/qapi/parser.py
> @@ -668,6 +668,9 @@ def __init__(
>              # section text without tag
>              self.text = ''
>  
> +        def __repr__(self) -> str:
> +            return f"<QAPIDoc.Section kind={self.kind!r} text={self.text!r}>"
> +
>          def append_line(self, line: str) -> None:
>              self.text += line + '\n'

Reviewed-by: Markus Armbruster <[e-mail]>

Patch

diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 94d5322f8af..11c11bb09e5 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -668,6 +668,9 @@  def __init__(
             # section text without tag
             self.text = ''
 
+        def __repr__(self) -> str:
+            return f"<QAPIDoc.Section kind={self.kind!r} text={self.text!r}>"
+
         def append_line(self, line: str) -> None:
             self.text += line + '\n'