From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: John Snow <jsnow@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v3 17/47] qapi/common.py: delint with pylint
Date: Thu, 24 Sep 2020 20:28:30 -0400 [thread overview]
Message-ID: <20200925002900.465855-18-jsnow@redhat.com> (raw)
In-Reply-To: <20200925002900.465855-1-jsnow@redhat.com>
At this point, that just means using a consistent strategy for constant names.
constants get UPPER_CASE and names not used externally get a leading underscore.
As a preference, while renaming constants to be UPPERCASE, move them to
the head of the file. Generally, it's nice to be able to audit the code
that runs on import in one central place.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
---
scripts/qapi/common.py | 17 +++++++----------
scripts/qapi/schema.py | 14 +++++++-------
2 files changed, 14 insertions(+), 17 deletions(-)
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index b35318b72c..c096df0d2d 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -13,6 +13,10 @@
import re
+EATSPACE = '\033EATSPACE.'
+POINTER_SUFFIX = ' *' + EATSPACE
+_C_NAME_TRANS = str.maketrans('.-', '__')
+
# ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1
# ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2
@@ -42,9 +46,6 @@ def c_enum_const(type_name, const_name, prefix=None):
return camel_to_upper(type_name) + '_' + c_name(const_name, False).upper()
-c_name_trans = str.maketrans('.-', '__')
-
-
# Map @name to a valid C identifier.
# If @protect, avoid returning certain ticklish identifiers (like
# C keywords) by prepending 'q_'.
@@ -82,17 +83,13 @@ def c_name(name, protect=True):
'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
# namespace pollution:
polluted_words = set(['unix', 'errno', 'mips', 'sparc', 'i386'])
- name = name.translate(c_name_trans)
+ name = name.translate(_C_NAME_TRANS)
if protect and (name in c89_words | c99_words | c11_words | gcc_words
| cpp_words | polluted_words):
return 'q_' + name
return name
-eatspace = '\033EATSPACE.'
-pointer_suffix = ' *' + eatspace
-
-
class Indentation:
"""
Indentation level management.
@@ -132,12 +129,12 @@ def decrease(self, amount: int = 4) -> None:
# Generate @code with @kwds interpolated.
-# Obey indent, and strip eatspace.
+# Obey indent, and strip EATSPACE.
def cgen(code, **kwds):
raw = code % kwds
if indent:
raw = re.sub(r'^(?!(#|$))', str(indent), raw, flags=re.MULTILINE)
- return re.sub(re.escape(eatspace) + r' *', '', raw)
+ return re.sub(re.escape(EATSPACE) + r' *', '', raw)
def mcgen(code, **kwds):
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index cfc52e1ae4..74c6b96d39 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -18,7 +18,7 @@
import os
import re
-from .common import c_name, pointer_suffix
+from .common import POINTER_SUFFIX, c_name
from .error import QAPIError, QAPISemError
from .expr import check_exprs
from .parser import QAPISchemaParser
@@ -309,7 +309,7 @@ def is_implicit(self):
return True
def c_type(self):
- return c_name(self.name) + pointer_suffix
+ return c_name(self.name) + POINTER_SUFFIX
def json_type(self):
return 'array'
@@ -430,7 +430,7 @@ def c_name(self):
def c_type(self):
assert not self.is_implicit()
- return c_name(self.name) + pointer_suffix
+ return c_name(self.name) + POINTER_SUFFIX
def c_unboxed_type(self):
return c_name(self.name)
@@ -504,7 +504,7 @@ def connect_doc(self, doc=None):
v.connect_doc(doc)
def c_type(self):
- return c_name(self.name) + pointer_suffix
+ return c_name(self.name) + POINTER_SUFFIX
def json_type(self):
return 'value'
@@ -896,7 +896,7 @@ def _def_builtin_type(self, name, json_type, c_type):
self._make_array_type(name, None)
def _def_predefineds(self):
- for t in [('str', 'string', 'char' + pointer_suffix),
+ for t in [('str', 'string', 'char' + POINTER_SUFFIX),
('number', 'number', 'double'),
('int', 'int', 'int64_t'),
('int8', 'int', 'int8_t'),
@@ -909,8 +909,8 @@ def _def_predefineds(self):
('uint64', 'int', 'uint64_t'),
('size', 'int', 'uint64_t'),
('bool', 'boolean', 'bool'),
- ('any', 'value', 'QObject' + pointer_suffix),
- ('null', 'null', 'QNull' + pointer_suffix)]:
+ ('any', 'value', 'QObject' + POINTER_SUFFIX),
+ ('null', 'null', 'QNull' + POINTER_SUFFIX)]:
self._def_builtin_type(*t)
self.the_empty_object_type = QAPISchemaObjectType(
'q_empty', None, None, None, None, None, [], None)
--
2.26.2
next prev parent reply other threads:[~2020-09-25 0:48 UTC|newest]
Thread overview: 75+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 0:28 [PATCH v3 00/47] qapi: static typing conversion, pt1 John Snow
2020-09-25 0:28 ` [PATCH v3 01/47] [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick (``) John Snow
2020-09-29 2:47 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 02/47] [DO-NOT-MERGE] docs: repair broken references John Snow
2020-09-29 2:48 ` Cleber Rosa
2020-09-29 3:14 ` Cleber Rosa
2020-09-29 15:30 ` John Snow
2020-09-29 18:16 ` John Snow
2020-09-25 0:28 ` [PATCH v3 03/47] [DO-NOT-MERGE] docs/sphinx: change default role to "any" John Snow
2020-09-29 3:30 ` Cleber Rosa
2020-09-29 15:33 ` John Snow
2020-09-29 18:20 ` John Snow
2020-09-25 0:28 ` [PATCH v3 04/47] qapi: modify docstrings to be sphinx-compatible John Snow
2020-09-29 3:39 ` Cleber Rosa
2020-09-29 15:37 ` John Snow
2020-09-25 0:28 ` [PATCH v3 05/47] qapi/doc.py: Change code templates from function to string John Snow
2020-09-25 8:59 ` Markus Armbruster
2020-09-25 14:23 ` John Snow
2020-09-29 3:51 ` Cleber Rosa
2020-09-29 18:25 ` John Snow
2020-09-25 0:28 ` [PATCH v3 06/47] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi John Snow
2020-09-29 4:00 ` Cleber Rosa
2020-09-29 18:30 ` John Snow
2020-09-25 0:28 ` [PATCH v3 07/47] qapi-gen: Separate arg-parsing from generation John Snow
2020-09-29 4:02 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 08/47] qapi: move generator entrypoint into module John Snow
2020-09-25 0:28 ` [PATCH v3 09/47] [DO-NOT-MERGE] docs: add scripts/qapi/main to python manual John Snow
2020-09-25 0:28 ` [PATCH v3 10/47] qapi: Prefer explicit relative imports John Snow
2020-09-25 0:28 ` [PATCH v3 11/47] qapi: Remove wildcard includes John Snow
2020-09-25 0:28 ` [PATCH v3 12/47] qapi: enforce import order/styling with isort John Snow
2020-09-25 9:20 ` Markus Armbruster
2020-09-25 15:26 ` John Snow
2020-09-28 12:13 ` Markus Armbruster
2020-09-28 14:34 ` John Snow
2020-09-29 4:13 ` Cleber Rosa
2020-09-29 4:15 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 13/47] qapi: delint using flake8 John Snow
2020-09-25 0:28 ` [PATCH v3 14/47] qapi: add pylintrc John Snow
2020-09-25 0:28 ` [PATCH v3 15/47] qapi/common.py: Remove python compatibility workaround John Snow
2020-09-25 0:28 ` [PATCH v3 16/47] qapi/common.py: Add indent manager John Snow
2020-09-25 0:28 ` John Snow [this message]
2020-09-25 0:28 ` [PATCH v3 18/47] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-09-25 0:28 ` [PATCH v3 19/47] qapi/common.py: check with pylint John Snow
2020-09-25 0:28 ` [PATCH v3 20/47] qapi/common.py: add type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 21/47] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-09-25 0:28 ` [PATCH v3 22/47] qapi/common.py: move build_params into gen.py John Snow
2020-09-25 0:28 ` [PATCH v3 23/47] qapi: establish mypy type-checking baseline John Snow
2020-09-29 4:17 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 24/47] qapi/events.py: add type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 25/47] qapi/events.py: Move comments into docstrings John Snow
2020-09-25 0:28 ` [PATCH v3 26/47] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-09-25 0:28 ` [PATCH v3 27/47] qapi/commands.py: add type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 28/47] qapi/commands.py: enable checking with mypy John Snow
2020-09-25 0:28 ` [PATCH v3 29/47] qapi/source.py: add type hint annotations John Snow
2020-09-29 4:18 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 30/47] qapi/source.py: delint with pylint John Snow
2020-09-25 0:28 ` [PATCH v3 31/47] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-09-29 4:22 ` Cleber Rosa
2020-09-25 0:28 ` [PATCH v3 32/47] qapi/gen.py: add type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 33/47] qapi/gen.py: Enable checking with mypy John Snow
2020-09-25 0:28 ` [PATCH v3 34/47] qapi/gen.py: Remove unused parameter John Snow
2020-09-25 0:28 ` [PATCH v3 35/47] qapi/gen.py: update write() to be more idiomatic John Snow
2020-09-25 0:28 ` [PATCH v3 36/47] qapi/gen.py: delint with pylint John Snow
2020-09-25 0:28 ` [PATCH v3 37/47] qapi/introspect.py: assert obj is a dict when features are given John Snow
2020-09-25 0:28 ` [PATCH v3 38/47] qapi/instrospect.py: add preliminary type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 39/47] qapi/introspect.py: add _gen_features helper John Snow
2020-09-25 0:28 ` [PATCH v3 40/47] qapi/introspect.py: Unify return type of _make_tree() John Snow
2020-09-25 0:28 ` [PATCH v3 41/47] qapi/introspect.py: replace 'extra' dict with 'comment' argument John Snow
2020-09-25 0:28 ` [PATCH v3 42/47] qapi/introspect.py: create a typed 'Node' data structure John Snow
2020-09-25 0:28 ` [PATCH v3 43/47] qapi/types.py: add type hint annotations John Snow
2020-09-25 0:28 ` [PATCH v3 44/47] qapi/types.py: remove one-letter variables John Snow
2020-09-25 0:28 ` [PATCH v3 45/47] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-09-25 0:28 ` [PATCH v3 46/47] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-09-25 0:29 ` [PATCH v3 47/47] qapi/visit.py: add type hint annotations John Snow
2020-09-28 15:17 ` [PATCH v3 00/47] qapi: static typing conversion, pt1 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=20200925002900.465855-18-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@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).