From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, John Snow <jsnow@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [PULL 19/34] qapi/events.py: add type hint annotations
Date: Sat, 10 Oct 2020 11:54:49 +0200 [thread overview]
Message-ID: <20201010095504.796182-20-armbru@redhat.com> (raw)
In-Reply-To: <20201010095504.796182-1-armbru@redhat.com>
From: John Snow <jsnow@redhat.com>
Annotations do not change runtime behavior.
This commit *only* adds annotations.
Note: __init__ does not need its return type annotated, as it is special.
https://mypy.readthedocs.io/en/stable/class_basics.html#annotating-init-methods
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Message-Id: <20201009161558.107041-20-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/events.py | 46 ++++++++++++++++++++++++++++++++----------
scripts/qapi/mypy.ini | 5 -----
2 files changed, 35 insertions(+), 16 deletions(-)
diff --git a/scripts/qapi/events.py b/scripts/qapi/events.py
index f840a62ed9..57e0939e96 100644
--- a/scripts/qapi/events.py
+++ b/scripts/qapi/events.py
@@ -12,19 +12,31 @@ This work is licensed under the terms of the GNU GPL, version 2.
See the COPYING file in the top-level directory.
"""
+from typing import List
+
from .common import c_enum_const, c_name, mcgen
from .gen import QAPISchemaModularCVisitor, build_params, ifcontext
-from .schema import QAPISchemaEnumMember
+from .schema import (
+ QAPISchema,
+ QAPISchemaEnumMember,
+ QAPISchemaFeature,
+ QAPISchemaObjectType,
+)
+from .source import QAPISourceInfo
from .types import gen_enum, gen_enum_lookup
-def build_event_send_proto(name, arg_type, boxed):
+def build_event_send_proto(name: str,
+ arg_type: QAPISchemaObjectType,
+ boxed: bool) -> str:
return 'void qapi_event_send_%(c_name)s(%(param)s)' % {
'c_name': c_name(name.lower()),
'param': build_params(arg_type, boxed)}
-def gen_event_send_decl(name, arg_type, boxed):
+def gen_event_send_decl(name: str,
+ arg_type: QAPISchemaObjectType,
+ boxed: bool) -> str:
return mcgen('''
%(proto)s;
@@ -33,7 +45,7 @@ def gen_event_send_decl(name, arg_type, boxed):
# Declare and initialize an object 'qapi' using parameters from build_params()
-def gen_param_var(typ):
+def gen_param_var(typ: QAPISchemaObjectType) -> str:
assert not typ.variants
ret = mcgen('''
%(c_name)s param = {
@@ -61,7 +73,11 @@ def gen_param_var(typ):
return ret
-def gen_event_send(name, arg_type, boxed, event_enum_name, event_emit):
+def gen_event_send(name: str,
+ arg_type: QAPISchemaObjectType,
+ boxed: bool,
+ event_enum_name: str,
+ event_emit: str) -> str:
# FIXME: Our declaration of local variables (and of 'errp' in the
# parameter list) can collide with exploded members of the event's
# data type passed in as parameters. If this collision ever hits in
@@ -137,15 +153,15 @@ def gen_event_send(name, arg_type, boxed, event_enum_name, event_emit):
class QAPISchemaGenEventVisitor(QAPISchemaModularCVisitor):
- def __init__(self, prefix):
+ def __init__(self, prefix: str):
super().__init__(
prefix, 'qapi-events',
' * Schema-defined QAPI/QMP events', None, __doc__)
self._event_enum_name = c_name(prefix + 'QAPIEvent', protect=False)
- self._event_enum_members = []
+ self._event_enum_members: List[QAPISchemaEnumMember] = []
self._event_emit_name = c_name(prefix + 'qapi_event_emit')
- def _begin_user_module(self, name):
+ def _begin_user_module(self, name: str) -> None:
events = self._module_basename('qapi-events', name)
types = self._module_basename('qapi-types', name)
visit = self._module_basename('qapi-visit', name)
@@ -168,7 +184,7 @@ class QAPISchemaGenEventVisitor(QAPISchemaModularCVisitor):
''',
types=types))
- def visit_end(self):
+ def visit_end(self) -> None:
self._add_system_module('emit', ' * QAPI Events emission')
self._genc.preamble_add(mcgen('''
#include "qemu/osdep.h"
@@ -189,7 +205,13 @@ void %(event_emit)s(%(event_enum)s event, QDict *qdict);
event_emit=self._event_emit_name,
event_enum=self._event_enum_name))
- def visit_event(self, name, info, ifcond, features, arg_type, boxed):
+ def visit_event(self,
+ name: str,
+ info: QAPISourceInfo,
+ ifcond: List[str],
+ features: List[QAPISchemaFeature],
+ arg_type: QAPISchemaObjectType,
+ boxed: bool) -> None:
with ifcontext(ifcond, self._genh, self._genc):
self._genh.add(gen_event_send_decl(name, arg_type, boxed))
self._genc.add(gen_event_send(name, arg_type, boxed,
@@ -200,7 +222,9 @@ void %(event_emit)s(%(event_enum)s event, QDict *qdict);
self._event_enum_members.append(QAPISchemaEnumMember(name, None))
-def gen_events(schema, output_dir, prefix):
+def gen_events(schema: QAPISchema,
+ output_dir: str,
+ prefix: str) -> None:
vis = QAPISchemaGenEventVisitor(prefix)
schema.visit(vis)
vis.write(output_dir)
diff --git a/scripts/qapi/mypy.ini b/scripts/qapi/mypy.ini
index 00fac15dc6..5df11e53fd 100644
--- a/scripts/qapi/mypy.ini
+++ b/scripts/qapi/mypy.ini
@@ -14,11 +14,6 @@ disallow_untyped_defs = False
disallow_incomplete_defs = False
check_untyped_defs = False
-[mypy-qapi.events]
-disallow_untyped_defs = False
-disallow_incomplete_defs = False
-check_untyped_defs = False
-
[mypy-qapi.expr]
disallow_untyped_defs = False
disallow_incomplete_defs = False
--
2.26.2
next prev parent reply other threads:[~2020-10-10 10:18 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-10 9:54 [PULL 00/34] QAPI patches patches for 2020-10-10 Markus Armbruster
2020-10-10 9:54 ` [PULL 01/34] docs: repair broken references Markus Armbruster
2020-10-10 9:54 ` [PULL 02/34] qapi: modify docstrings to be sphinx-compatible Markus Armbruster
2020-10-10 9:54 ` [PULL 03/34] qapi-gen: Separate arg-parsing from generation Markus Armbruster
2020-10-10 9:54 ` [PULL 04/34] qapi: move generator entrypoint into package Markus Armbruster
2020-10-10 9:54 ` [PULL 05/34] qapi: Prefer explicit relative imports Markus Armbruster
2020-10-10 9:54 ` [PULL 06/34] qapi: Remove wildcard includes Markus Armbruster
2020-10-10 9:54 ` [PULL 07/34] qapi: enforce import order/styling with isort Markus Armbruster
2020-10-10 9:54 ` [PULL 08/34] qapi: delint using flake8 Markus Armbruster
2020-10-10 9:54 ` [PULL 09/34] qapi: add pylintrc Markus Armbruster
2020-10-10 9:54 ` [PULL 10/34] qapi/common.py: Remove python compatibility workaround Markus Armbruster
2020-10-10 9:54 ` [PULL 11/34] qapi/common.py: Add indent manager Markus Armbruster
2020-10-10 9:54 ` [PULL 12/34] qapi/common.py: delint with pylint Markus Armbruster
2020-10-10 9:54 ` [PULL 13/34] qapi/common.py: Replace one-letter 'c' variable Markus Armbruster
2020-10-10 9:54 ` [PULL 14/34] qapi/common.py: check with pylint Markus Armbruster
2020-10-10 9:54 ` [PULL 15/34] qapi/common.py: add type hint annotations Markus Armbruster
2020-10-10 9:54 ` [PULL 16/34] qapi/common.py: Convert comments into docstrings, and elaborate Markus Armbruster
2020-10-10 9:54 ` [PULL 17/34] qapi/common.py: move build_params into gen.py Markus Armbruster
2020-10-10 9:54 ` [PULL 18/34] qapi: establish mypy type-checking baseline Markus Armbruster
2020-10-10 9:54 ` Markus Armbruster [this message]
2020-10-10 9:54 ` [PULL 20/34] qapi/events.py: Move comments into docstrings Markus Armbruster
2020-10-10 9:54 ` [PULL 21/34] qapi/commands.py: Don't re-bind to variable of different type Markus Armbruster
2020-10-10 9:54 ` [PULL 22/34] qapi/commands.py: add type hint annotations Markus Armbruster
2020-10-10 9:54 ` [PULL 23/34] qapi/source.py: " Markus Armbruster
2020-10-10 9:54 ` [PULL 24/34] qapi/source.py: delint with pylint Markus Armbruster
2020-10-10 9:54 ` [PULL 25/34] qapi/gen: Make _is_user_module() return bool Markus Armbruster
2020-10-10 9:54 ` [PULL 26/34] qapi/gen.py: add type hint annotations Markus Armbruster
2020-10-10 9:54 ` [PULL 27/34] qapi/gen.py: Remove unused parameter Markus Armbruster
2020-10-10 9:54 ` [PULL 28/34] qapi/gen.py: update write() to be more idiomatic Markus Armbruster
2020-10-10 9:54 ` [PULL 29/34] qapi/gen.py: delint with pylint Markus Armbruster
2020-10-10 9:55 ` [PULL 30/34] qapi/types.py: add type hint annotations Markus Armbruster
2020-10-10 9:55 ` [PULL 31/34] qapi/types.py: remove one-letter variables Markus Armbruster
2020-10-10 9:55 ` [PULL 32/34] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType Markus Armbruster
2020-10-10 9:55 ` [PULL 33/34] qapi/visit.py: remove unused parameters from gen_visit_object Markus Armbruster
2020-10-10 9:55 ` [PULL 34/34] qapi/visit.py: add type hint annotations Markus Armbruster
2020-10-12 11:31 ` [PULL 00/34] QAPI patches patches for 2020-10-10 Peter Maydell
2020-10-18 7:29 ` Philippe Mathieu-Daudé
2020-10-19 8:09 ` Markus Armbruster
2020-10-19 14:34 ` John Snow
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=20201010095504.796182-20-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=jsnow@redhat.com \
--cc=peter.maydell@linaro.org \
--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).