[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 17/37] qapi/events.py: add notational type hints
From: |
John Snow |
Subject: |
[PATCH 17/37] qapi/events.py: add notational type hints |
Date: |
Tue, 15 Sep 2020 18:40:07 -0400 |
This is enough to enable type-checking on events.py, so enable that in
this patch, too.
Signed-off-by: John Snow <jsnow@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 75eda72534..449a700ffe 100644
--- a/scripts/qapi/events.py
+++ b/scripts/qapi/events.py
@@ -12,6 +12,8 @@
See the COPYING file in the top-level directory.
"""
+from typing import List
+
from .common import (
c_enum_const,
c_name,
@@ -19,17 +21,27 @@
)
from .params import build_params
from .gen import QAPISchemaModularCVisitor, 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;
@@ -38,7 +50,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 = {
@@ -66,7 +78,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
@@ -142,15 +158,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)
@@ -173,7 +189,7 @@ def _begin_user_module(self, name):
''',
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"
@@ -194,7 +210,13 @@ def visit_end(self):
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,
@@ -205,7 +227,9 @@ def visit_event(self, name, info, ifcond, features,
arg_type, boxed):
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 a0f2365a53..b668776d94 100644
--- a/scripts/qapi/mypy.ini
+++ b/scripts/qapi/mypy.ini
@@ -19,11 +19,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
- [PATCH 11/37] qapi/common.py: Replace one-letter 'c' variable, (continued)
- [PATCH 11/37] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/09/15
- [PATCH 14/37] qapi/common.py: Move comments into docstrings, John Snow, 2020/09/15
- [PATCH 13/37] qapi/common.py: add notational type hints, John Snow, 2020/09/15
- [PATCH 15/37] qapi/common.py: split build_params into new file, John Snow, 2020/09/15
- [PATCH 24/37] qapi/gen.py: Fix edge-case of _is_user_module, John Snow, 2020/09/15
- [PATCH 21/37] qapi/commands.py: enable checking with mypy, John Snow, 2020/09/15
- [PATCH 16/37] qapi: establish mypy type-checking baseline, John Snow, 2020/09/15
- [PATCH 18/37] qapi/events.py: Move comments into docstrings, John Snow, 2020/09/15
- [PATCH 22/37] qapi/source.py: add notational type hints, John Snow, 2020/09/15
- [PATCH 19/37] qapi/commands.py: Don't re-bind to variable of different type, John Snow, 2020/09/15
- [PATCH 17/37] qapi/events.py: add notational type hints,
John Snow <=
- [PATCH 20/37] qapi/commands.py: add notational type hints, John Snow, 2020/09/15
- [PATCH 23/37] qapi/source.py: delint with pylint, John Snow, 2020/09/15
- [PATCH 28/37] qapi/gen.py: update write() to be more idiomatic, John Snow, 2020/09/15
- [PATCH 29/37] qapi/gen.py: delint with pylint, John Snow, 2020/09/15
- [PATCH 27/37] qapi/gen.py: Remove unused parameter, John Snow, 2020/09/15
- [PATCH 26/37] qapi/gen.py: Enable checking with mypy, John Snow, 2020/09/15
- [PATCH 30/37] qapi/introspect.py: Add a typed 'extra' structure, John Snow, 2020/09/15
- [PATCH 25/37] qapi/gen.py: add notational type hints, John Snow, 2020/09/15
- [PATCH 34/37] qapi/types.py: add notational type hints, John Snow, 2020/09/15
- [PATCH 36/37] qapi/visit.py: remove unused parameters from gen_visit_object, John Snow, 2020/09/15