From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org, Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: Re: [PATCH v5 27/36] qapi/gen.py: add type hint annotations
Date: Wed, 07 Oct 2020 14:21:03 +0200 [thread overview]
Message-ID: <875z7mcjm8.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: <20201005195158.2348217-28-jsnow@redhat.com> (John Snow's message of "Mon, 5 Oct 2020 15:51:49 -0400")
John Snow <jsnow@redhat.com> writes:
> Annotations do not change runtime behavior.
> This commit *only* adds annotations.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
> Reviewed-by: Cleber Rosa <crosa@redhat.com>
> ---
> scripts/qapi/gen.py | 104 ++++++++++++++++++++++++--------------------
> 1 file changed, 57 insertions(+), 47 deletions(-)
>
> diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py
> index 1bad37fc06b..d0391cd8718 100644
> --- a/scripts/qapi/gen.py
> +++ b/scripts/qapi/gen.py
> @@ -17,7 +17,13 @@
> import errno
> import os
> import re
> -from typing import Optional
> +from typing import (
> + Dict,
> + Iterator,
> + List,
> + Optional,
> + Tuple,
> +)
>
> from .common import (
> c_fname,
> @@ -29,31 +35,31 @@
> mcgen,
> )
> from .schema import QAPISchemaObjectType, QAPISchemaVisitor
> +from .source import QAPISourceInfo
>
>
> class QAPIGen:
> -
> - def __init__(self, fname):
> + def __init__(self, fname: Optional[str]):
I'd expect fname: str. Can you point me to the spot that passes None?
> self.fname = fname
> self._preamble = ''
> self._body = ''
>
> - def preamble_add(self, text):
> + def preamble_add(self, text: str) -> None:
> self._preamble += text
>
> - def add(self, text):
> + def add(self, text: str) -> None:
> self._body += text
>
> - def get_content(self):
> + def get_content(self) -> str:
> return self._top() + self._preamble + self._body + self._bottom()
>
> - def _top(self):
> + def _top(self) -> str:
> return ''
>
> - def _bottom(self):
> + def _bottom(self) -> str:
> return ''
>
> - def write(self, output_dir):
> + def write(self, output_dir: str) -> None:
> # Include paths starting with ../ are used to reuse modules of the main
> # schema in specialised schemas. Don't overwrite the files that are
> # already generated for the main schema.
> @@ -78,7 +84,7 @@ def write(self, output_dir):
> f.close()
>
>
> -def _wrap_ifcond(ifcond, before, after):
> +def _wrap_ifcond(ifcond: List[str], before: str, after: str) -> str:
> if before == after:
> return after # suppress empty #if ... #endif
>
> @@ -118,40 +124,38 @@ def build_params(arg_type: Optional[QAPISchemaObjectType],
>
>
> class QAPIGenCCode(QAPIGen):
> -
> - def __init__(self, fname):
> + def __init__(self, fname: Optional[str]):
Likewise.
> super().__init__(fname)
> - self._start_if = None
> + self._start_if: Optional[Tuple[List[str], str, str]] = None
>
> - def start_if(self, ifcond):
> + def start_if(self, ifcond: List[str]) -> None:
> assert self._start_if is None
> self._start_if = (ifcond, self._body, self._preamble)
>
> - def end_if(self):
> + def end_if(self) -> None:
> assert self._start_if
> self._wrap_ifcond()
> self._start_if = None
>
> - def _wrap_ifcond(self):
> + def _wrap_ifcond(self) -> None:
> self._body = _wrap_ifcond(self._start_if[0],
> self._start_if[1], self._body)
> self._preamble = _wrap_ifcond(self._start_if[0],
> self._start_if[2], self._preamble)
>
> - def get_content(self):
> + def get_content(self) -> str:
> assert self._start_if is None
> return super().get_content()
>
>
> class QAPIGenC(QAPIGenCCode):
> -
> - def __init__(self, fname, blurb, pydoc):
> + def __init__(self, fname: str, blurb: str, pydoc: str):
Here it's just str.
> super().__init__(fname)
> self._blurb = blurb
> self._copyright = '\n * '.join(re.findall(r'^Copyright .*', pydoc,
> re.MULTILINE))
>
> - def _top(self):
> + def _top(self) -> str:
> return mcgen('''
> /* AUTOMATICALLY GENERATED, DO NOT MODIFY */
>
> @@ -167,7 +171,7 @@ def _top(self):
> ''',
> blurb=self._blurb, copyright=self._copyright)
>
> - def _bottom(self):
> + def _bottom(self) -> str:
> return mcgen('''
>
> /* Dummy declaration to prevent empty .o file */
> @@ -177,16 +181,15 @@ def _bottom(self):
>
>
> class QAPIGenH(QAPIGenC):
> -
> - def _top(self):
> + def _top(self) -> str:
> return super()._top() + guardstart(self.fname)
>
> - def _bottom(self):
> + def _bottom(self) -> str:
> return guardend(self.fname)
>
>
> @contextmanager
> -def ifcontext(ifcond, *args):
> +def ifcontext(ifcond: List[str], *args: QAPIGenCCode) -> Iterator[None]:
Oh, the type hint for a *args is QAPIGenCCode, even though args is a
tuple of excess positional arguments (which are all QAPIGenCCode).
> """
> A with-statement context manager that wraps with `start_if()` / `end_if()`.
>
> @@ -214,8 +217,11 @@ def ifcontext(ifcond, *args):
>
>
> class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor):
> -
> - def __init__(self, prefix, what, blurb, pydoc):
> + def __init__(self,
> + prefix: str,
> + what: str,
> + blurb: str,
> + pydoc: str):
> self._prefix = prefix
> self._what = what
> self._genc = QAPIGenC(self._prefix + self._what + '.c',
> @@ -223,38 +229,42 @@ def __init__(self, prefix, what, blurb, pydoc):
> self._genh = QAPIGenH(self._prefix + self._what + '.h',
> blurb, pydoc)
>
> - def write(self, output_dir):
> + def write(self, output_dir: str) -> None:
> self._genc.write(output_dir)
> self._genh.write(output_dir)
>
>
> class QAPISchemaModularCVisitor(QAPISchemaVisitor):
> -
> - def __init__(self, prefix, what, user_blurb, builtin_blurb, pydoc):
> + def __init__(self,
> + prefix: str,
> + what: str,
> + user_blurb: str,
> + builtin_blurb: Optional[str],
> + pydoc: str):
> self._prefix = prefix
> self._what = what
> self._user_blurb = user_blurb
> self._builtin_blurb = builtin_blurb
> self._pydoc = pydoc
> - self._genc = None
> - self._genh = None
> - self._module = {}
> - self._main_module = None
> + self._genc: Optional[QAPIGenC] = None
> + self._genh: Optional[QAPIGenH] = None
> + self._module: Dict[Optional[str], Tuple[QAPIGenC, QAPIGenH]] = {}
> + self._main_module: Optional[str] = None
>
> @staticmethod
> - def _is_user_module(name):
> + def _is_user_module(name: Optional[str]) -> bool:
> return bool(name and not name.startswith('./'))
>
> @staticmethod
> - def _is_builtin_module(name):
> + def _is_builtin_module(name: Optional[str]) -> bool:
> return not name
>
> - def _module_dirname(self, what, name):
> + def _module_dirname(self, what: str, name: Optional[str]) -> str:
> if self._is_user_module(name):
> return os.path.dirname(name)
> return ''
>
> - def _module_basename(self, what, name):
> + def _module_basename(self, what: str, name: Optional[str]) -> str:
> ret = '' if self._is_builtin_module(name) else self._prefix
> if self._is_user_module(name):
> basename = os.path.basename(name)
> @@ -266,27 +276,27 @@ def _module_basename(self, what, name):
> ret += re.sub(r'-', '-' + name + '-', what)
> return ret
>
> - def _module_filename(self, what, name):
> + def _module_filename(self, what: str, name: Optional[str]) -> str:
> return os.path.join(self._module_dirname(what, name),
> self._module_basename(what, name))
>
> - def _add_module(self, name, blurb):
> + def _add_module(self, name: Optional[str], blurb: str) -> None:
> basename = self._module_filename(self._what, name)
> genc = QAPIGenC(basename + '.c', blurb, self._pydoc)
> genh = QAPIGenH(basename + '.h', blurb, self._pydoc)
> self._module[name] = (genc, genh)
> self._genc, self._genh = self._module[name]
>
> - def _add_user_module(self, name, blurb):
> + def _add_user_module(self, name: str, blurb: str) -> None:
> assert self._is_user_module(name)
> if self._main_module is None:
> self._main_module = name
> self._add_module(name, blurb)
>
> - def _add_system_module(self, name, blurb):
> + def _add_system_module(self, name: Optional[str], blurb: str) -> None:
> self._add_module(name and './' + name, blurb)
>
> - def write(self, output_dir, opt_builtins=False):
> + def write(self, output_dir: str, opt_builtins: bool = False) -> None:
> for name in self._module:
> if self._is_builtin_module(name) and not opt_builtins:
> continue
> @@ -294,13 +304,13 @@ def write(self, output_dir, opt_builtins=False):
> genc.write(output_dir)
> genh.write(output_dir)
>
> - def _begin_system_module(self, name):
> + def _begin_system_module(self, name: None) -> None:
I figure the type hint None signals a simplifcation opportunity. No
need to worry about it now.
> pass
>
> - def _begin_user_module(self, name):
> + def _begin_user_module(self, name: str) -> None:
> pass
>
> - def visit_module(self, name):
> + def visit_module(self, name: Optional[str]) -> None:
> if name is None:
> if self._builtin_blurb:
> self._add_system_module(None, self._builtin_blurb)
> @@ -314,7 +324,7 @@ def visit_module(self, name):
> self._add_user_module(name, self._user_blurb)
> self._begin_user_module(name)
>
> - def visit_include(self, name, info):
> + def visit_include(self, name: str, info: QAPISourceInfo) -> None:
> relname = os.path.relpath(self._module_filename(self._what, name),
> os.path.dirname(self._genh.fname))
> self._genh.preamble_add(mcgen('''
next prev parent reply other threads:[~2020-10-07 12:24 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 19:51 [PATCH v5 00/36] qapi: static typing conversion, pt1 John Snow
2020-10-05 19:51 ` [PATCH v5 01/36] docs: repair broken references John Snow
2020-10-05 19:51 ` [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible John Snow
2020-10-06 11:21 ` Markus Armbruster
2020-10-06 15:23 ` John Snow
2020-10-07 7:24 ` Markus Armbruster
2020-10-07 17:00 ` John Snow
2020-10-05 19:51 ` [PATCH v5 03/36] qapi-gen: Separate arg-parsing from generation John Snow
2020-10-06 11:51 ` Markus Armbruster
2020-10-06 15:59 ` John Snow
2020-10-07 7:54 ` Markus Armbruster
2020-10-07 14:52 ` John Snow
2020-10-08 5:56 ` Markus Armbruster
2020-10-08 17:33 ` John Snow
2020-10-06 16:46 ` John Snow
2020-10-07 8:07 ` Markus Armbruster
2020-10-07 14:36 ` John Snow
2020-10-08 6:51 ` Markus Armbruster
2020-10-08 16:37 ` John Snow
2020-10-08 16:50 ` John Snow
2020-10-09 7:12 ` Markus Armbruster
2020-10-07 8:12 ` Markus Armbruster
2020-10-07 14:41 ` John Snow
2020-10-08 7:15 ` Markus Armbruster
2020-10-08 17:14 ` John Snow
2020-10-09 7:19 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 04/36] qapi: move generator entrypoint into module John Snow
2020-10-05 19:51 ` [PATCH v5 05/36] qapi: Prefer explicit relative imports John Snow
2020-10-06 11:33 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 06/36] qapi: Remove wildcard includes John Snow
2020-10-06 11:34 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 07/36] qapi: enforce import order/styling with isort John Snow
2020-10-07 8:15 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 08/36] qapi: delint using flake8 John Snow
2020-10-07 8:19 ` Markus Armbruster
2020-10-07 14:54 ` John Snow
2020-10-05 19:51 ` [PATCH v5 09/36] qapi: add pylintrc John Snow
2020-10-05 19:51 ` [PATCH v5 10/36] qapi/common.py: Remove python compatibility workaround John Snow
2020-10-05 19:51 ` [PATCH v5 11/36] qapi/common.py: Add indent manager John Snow
2020-10-07 8:50 ` Markus Armbruster
2020-10-07 18:08 ` John Snow
2020-10-07 18:18 ` Eduardo Habkost
2020-10-08 7:23 ` Markus Armbruster
2020-10-08 17:45 ` John Snow
2020-10-05 19:51 ` [PATCH v5 12/36] qapi/common.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 13/36] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-10-06 11:35 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 14/36] qapi/common.py: check with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 15/36] qapi/common.py: add type hint annotations John Snow
2020-10-07 9:03 ` Markus Armbruster
2020-10-07 15:01 ` John Snow
2020-10-05 19:51 ` [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-10-07 9:14 ` Markus Armbruster
2020-10-07 15:23 ` John Snow
2020-10-08 7:20 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 17/36] qapi/common.py: move build_params into gen.py John Snow
2020-10-07 9:21 ` Markus Armbruster
2020-10-07 15:26 ` John Snow
2020-10-07 18:10 ` Eduardo Habkost
2020-10-05 19:51 ` [PATCH v5 18/36] qapi: establish mypy type-checking baseline John Snow
2020-10-07 9:25 ` Markus Armbruster
2020-10-07 15:33 ` John Snow
2020-10-08 7:29 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 19/36] qapi/events.py: add type hint annotations John Snow
2020-10-07 11:32 ` Markus Armbruster
2020-10-07 11:49 ` Markus Armbruster
2020-10-07 15:46 ` John Snow
2020-10-08 9:16 ` Markus Armbruster
2020-10-08 16:19 ` John Snow
2020-10-09 7:21 ` Markus Armbruster
2020-10-07 15:39 ` John Snow
2020-10-08 7:41 ` Markus Armbruster
2020-10-08 15:35 ` John Snow
2020-10-05 19:51 ` [PATCH v5 20/36] qapi/events.py: Move comments into docstrings John Snow
2020-10-05 19:51 ` [PATCH v5 21/36] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-10-07 11:34 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 22/36] qapi/commands.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 23/36] qapi/commands.py: enable checking with mypy John Snow
2020-10-07 11:37 ` Markus Armbruster
2020-10-07 15:49 ` John Snow
2020-10-08 7:52 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 24/36] qapi/source.py: add type hint annotations John Snow
2020-10-07 11:55 ` Markus Armbruster
2020-10-07 16:04 ` John Snow
2020-10-08 8:42 ` Markus Armbruster
2020-10-09 14:30 ` John Snow
2020-10-09 14:37 ` John Snow
2020-10-05 19:51 ` [PATCH v5 25/36] qapi/source.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 26/36] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-10-06 11:44 ` Philippe Mathieu-Daudé
2020-10-07 12:02 ` Markus Armbruster
2020-10-07 16:09 ` John Snow
2020-10-05 19:51 ` [PATCH v5 27/36] qapi/gen.py: add type hint annotations John Snow
2020-10-07 12:21 ` Markus Armbruster [this message]
2020-10-07 16:21 ` John Snow
2020-10-07 13:20 ` Markus Armbruster
2020-10-07 16:50 ` John Snow
2020-10-08 8:44 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 28/36] qapi/gen.py: Enable checking with mypy John Snow
2020-10-05 19:51 ` [PATCH v5 29/36] qapi/gen.py: Remove unused parameter John Snow
2020-10-07 12:22 ` Markus Armbruster
2020-10-07 16:23 ` John Snow
2020-10-05 19:51 ` [PATCH v5 30/36] qapi/gen.py: update write() to be more idiomatic John Snow
2020-10-07 12:32 ` Markus Armbruster
2020-10-07 16:25 ` John Snow
2020-10-05 19:51 ` [PATCH v5 31/36] qapi/gen.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 32/36] qapi/types.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 33/36] qapi/types.py: remove one-letter variables John Snow
2020-10-07 12:42 ` Markus Armbruster
2020-10-07 16:31 ` John Snow
2020-10-05 19:51 ` [PATCH v5 34/36] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-10-07 12:43 ` Markus Armbruster
2020-10-07 16:40 ` John Snow
2020-10-08 9:06 ` Markus Armbruster
2020-10-08 15:49 ` John Snow
2020-10-09 7:24 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 35/36] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-10-06 11:43 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 36/36] qapi/visit.py: add type hint annotations John Snow
2020-10-07 13:00 ` Markus Armbruster
2020-10-07 16:43 ` John Snow
2020-10-05 23:05 ` [PATCH v5 00/36] qapi: static typing conversion, pt1 Cleber Rosa
2020-10-05 23:57 ` John Snow
2020-10-06 17:51 ` Cleber Rosa
2020-10-07 13:05 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=875z7mcjm8.fsf@dusky.pond.sub.org \
--to=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=jsnow@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).