OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

qapi/expr.py: add type hint annotations 

Annotations do not change runtime behavior.
This commit *only* adds annotations.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210421182032.3521476-11-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2021-04-21 14:20:25 -04:00 committed by Markus Armbruster
parent 538cd41065
commit b9ad358aa0
2 changed files with 43 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
scripts/qapi/expr.py
View File

@ -15,7 +15,15 @@
# See the COPYING file in the top-level directory.
import re
from typing import Dict, Optional, cast
from typing import (
Collection,
Dict,
Iterable,
List,
Optional,
Union,
cast,
)
from .common import c_name
from .error import QAPISemError
@ -39,12 +47,14 @@ valid_name = re.compile(r'(__[a-z0-9.-]+_)?'
r'([a-z][a-z0-9_-]*)$', re.IGNORECASE)
def check_name_is_str(name, info, source):
def check_name_is_str(name: object,
info: QAPISourceInfo,
source: str) -> None:
if not isinstance(name, str):
raise QAPISemError(info, "%s requires a string name" % source)
def check_name_str(name, info, source):
def check_name_str(name: str, info: QAPISourceInfo, source: str) -> str:
# Reserve the entire 'q_' namespace for c_name(), and for 'q_empty'
# and 'q_obj_*' implicit type names.
match = valid_name.match(name)
@ -53,16 +63,16 @@ def check_name_str(name, info, source):
return match.group(3)
def check_name_upper(name, info, source):
def check_name_upper(name: str, info: QAPISourceInfo, source: str) -> None:
stem = check_name_str(name, info, source)
if re.search(r'[a-z-]', stem):
raise QAPISemError(
info, "name of %s must not use lowercase or '-'" % source)
def check_name_lower(name, info, source,
permit_upper=False,
permit_underscore=False):
def check_name_lower(name: str, info: QAPISourceInfo, source: str,
permit_upper: bool = False,
permit_underscore: bool = False) -> None:
stem = check_name_str(name, info, source)
if ((not permit_upper and re.search(r'[A-Z]', stem))
or (not permit_underscore and '_' in stem)):
@ -70,13 +80,13 @@ def check_name_lower(name, info, source,
info, "name of %s must not use uppercase or '_'" % source)
def check_name_camel(name, info, source):
def check_name_camel(name: str, info: QAPISourceInfo, source: str) -> None:
stem = check_name_str(name, info, source)
if not re.match(r'[A-Z][A-Za-z0-9]*[a-z][A-Za-z0-9]*$', stem):
raise QAPISemError(info, "name of %s must use CamelCase" % source)
def check_defn_name_str(name, info, meta):
def check_defn_name_str(name: str, info: QAPISourceInfo, meta: str) -> None:
if meta == 'event':
check_name_upper(name, info, meta)
elif meta == 'command':
@ -90,9 +100,13 @@ def check_defn_name_str(name, info, meta):
info, "%s name should not end in '%s'" % (meta, name[-4:]))
def check_keys(value, info, source, required, optional):
def check_keys(value: _JSONObject,
info: QAPISourceInfo,
source: str,
required: Collection[str],
optional: Collection[str]) -> None:
def pprint(elems):
def pprint(elems: Iterable[str]) -> str:
return ', '.join("'" + e + "'" for e in sorted(elems))
missing = set(required) - set(value)
@ -112,7 +126,7 @@ def check_keys(value, info, source, required, optional):
pprint(unknown), pprint(allowed)))
def check_flags(expr, info):
def check_flags(expr: _JSONObject, info: QAPISourceInfo) -> None:
for key in ['gen', 'success-response']:
if key in expr and expr[key] is not False:
raise QAPISemError(
@ -130,9 +144,9 @@ def check_flags(expr, info):
"are incompatible")
def check_if(expr, info, source):
def check_if(expr: _JSONObject, info: QAPISourceInfo, source: str) -> None:
def check_if_str(ifcond):
def check_if_str(ifcond: object) -> None:
if not isinstance(ifcond, str):
raise QAPISemError(
info,
@ -158,7 +172,7 @@ def check_if(expr, info, source):
expr['if'] = [ifcond]
def normalize_members(members):
def normalize_members(members: object) -> None:
if isinstance(members, dict):
for key, arg in members.items():
if isinstance(arg, dict):
@ -166,8 +180,11 @@ def normalize_members(members):
members[key] = {'type': arg}
def check_type(value, info, source,
allow_array=False, allow_dict=False):
def check_type(value: Optional[object],
info: QAPISourceInfo,
source: str,
allow_array: bool = False,
allow_dict: Union[bool, str] = False) -> None:
if value is None:
return
@ -214,7 +231,8 @@ def check_type(value, info, source,
check_type(arg['type'], info, key_source, allow_array=True)
def check_features(features, info):
def check_features(features: Optional[object],
info: QAPISourceInfo) -> None:
if features is None:
return
if not isinstance(features, list):
@ -231,7 +249,7 @@ def check_features(features, info):
check_if(f, info, source)
def check_enum(expr, info):
def check_enum(expr: _JSONObject, info: QAPISourceInfo) -> None:
name = expr['enum']
members = expr['data']
prefix = expr.get('prefix')
@ -260,7 +278,7 @@ def check_enum(expr, info):
check_if(member, info, source)
def check_struct(expr, info):
def check_struct(expr: _JSONObject, info: QAPISourceInfo) -> None:
name = cast(str, expr['struct']) # Checked in check_exprs
members = expr['data']
@ -268,7 +286,7 @@ def check_struct(expr, info):
check_type(expr.get('base'), info, "'base'")
def check_union(expr, info):
def check_union(expr: _JSONObject, info: QAPISourceInfo) -> None:
name = cast(str, expr['union']) # Checked in check_exprs
base = expr.get('base')
discriminator = expr.get('discriminator')
@ -296,7 +314,7 @@ def check_union(expr, info):
check_type(value['type'], info, source, allow_array=not base)
def check_alternate(expr, info):
def check_alternate(expr: _JSONObject, info: QAPISourceInfo) -> None:
members = expr['data']
if not members:
@ -313,7 +331,7 @@ def check_alternate(expr, info):
check_type(value['type'], info, source)
def check_command(expr, info):
def check_command(expr: _JSONObject, info: QAPISourceInfo) -> None:
args = expr.get('data')
rets = expr.get('returns')
boxed = expr.get('boxed', False)
@ -324,7 +342,7 @@ def check_command(expr, info):
check_type(rets, info, "'returns'", allow_array=True)
def check_event(expr, info):
def check_event(expr: _JSONObject, info: QAPISourceInfo) -> None:
args = expr.get('data')
boxed = expr.get('boxed', False)
@ -333,7 +351,7 @@ def check_event(expr, info):
check_type(args, info, "'data'", allow_dict=not boxed)
def check_exprs(exprs):
def check_exprs(exprs: List[_JSONObject]) -> List[_JSONObject]:
for expr_elem in exprs:
# Expression
assert isinstance(expr_elem['expr'], dict)

5
scripts/qapi/mypy.ini
View File

@ -8,11 +8,6 @@ disallow_untyped_defs = False
disallow_incomplete_defs = False
check_untyped_defs = False
[mypy-qapi.expr]
disallow_untyped_defs = False
disallow_incomplete_defs = False
check_untyped_defs = False
[mypy-qapi.parser]
disallow_untyped_defs = False
disallow_incomplete_defs = False