[v2] docs: add basic sphinx-domain rST generator to qapidoc

[PATCH v2 05/23] qapi/schema: add __repr__ to QAPIDoc.Section

Posted by John Snow 2 months, 3 weeks ago

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

Signed-off-by: John Snow <jsnow@redhat.com>
---
 scripts/qapi/parser.py | 3 +++
 1 file changed, 3 insertions(+)

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

Re: [PATCH v2 05/23] qapi/schema: add __repr__ to QAPIDoc.Section

Posted by Markus Armbruster 2 months, 2 weeks ago

John Snow <jsnow@redhat.com> writes:

> Makes debugging far more pleasant when you can just print(section) and
> get something reasonable to display.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  scripts/qapi/parser.py | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
> index c3004aa70c6..cb259c42a6d 100644
> --- a/scripts/qapi/parser.py
> +++ b/scripts/qapi/parser.py
> @@ -673,6 +673,9 @@ def __init__(
>              # section text without tag
>              self.text = ''
>  
> +        def __repr__(self) -> str:
> +            return f"<QAPIDoc.Section tag={self.tag!r} text={self.text!r}>"

pylint points out

    scripts/qapi/parser.py:677:43: E1101: Instance of 'Section' has no 'tag' member (no-member)

Previous patch renamed it to @kind.

> +
>          def append_line(self, line: str) -> None:
>              self.text += line + '\n'

Re: [PATCH v2 05/23] qapi/schema: add __repr__ to QAPIDoc.Section

Posted by John Snow 2 months, 2 weeks ago

On Thu, Jan 16, 2025 at 6:51 AM Markus Armbruster <armbru@redhat.com> wrote:

> John Snow <jsnow@redhat.com> writes:
>
> > Makes debugging far more pleasant when you can just print(section) and
> > get something reasonable to display.
> >
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
> >  scripts/qapi/parser.py | 3 +++
> >  1 file changed, 3 insertions(+)
> >
> > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
> > index c3004aa70c6..cb259c42a6d 100644
> > --- a/scripts/qapi/parser.py
> > +++ b/scripts/qapi/parser.py
> > @@ -673,6 +673,9 @@ def __init__(
> >              # section text without tag
> >              self.text = ''
> >
> > +        def __repr__(self) -> str:
> > +            return f"<QAPIDoc.Section tag={self.tag!r}
> text={self.text!r}>"
>
> pylint points out
>
>     scripts/qapi/parser.py:677:43: E1101: Instance of 'Section' has no
> 'tag' member (no-member)
>
> Previous patch renamed it to @kind.
>
> > +
> >          def append_line(self, line: str) -> None:
> >              self.text += line + '\n'
>
>
Oops. Was only linting qapidoc.py and not the parser.py stuff. Will fix for
v3.