qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
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 12/34] qapi/common.py: delint with pylint
Date: Sat, 10 Oct 2020 11:54:42 +0200	[thread overview]
Message-ID: <20201010095504.796182-13-armbru@redhat.com> (raw)
In-Reply-To: <20201010095504.796182-1-armbru@redhat.com>

From: John Snow <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>
Message-Id: <20201009161558.107041-13-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 scripts/qapi/common.py | 18 ++++++++----------
 scripts/qapi/schema.py | 14 +++++++-------
 2 files changed, 15 insertions(+), 17 deletions(-)

diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index b35318b72c..a417b6029c 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -14,6 +14,11 @@
 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
 # ENUM24_Name -> ENUM24_NAME
@@ -42,9 +47,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 +84,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 +130,12 @@ indent = Indentation()
 
 
 # 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 afd750989e..7c01592956 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -18,7 +18,7 @@ from collections import OrderedDict
 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 @@ class QAPISchemaArrayType(QAPISchemaType):
         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 @@ class QAPISchemaObjectType(QAPISchemaType):
 
     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 @@ class QAPISchemaAlternateType(QAPISchemaType):
             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'
@@ -899,7 +899,7 @@ class QAPISchema:
         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'),
@@ -912,8 +912,8 @@ class QAPISchema:
                   ('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



  parent reply	other threads:[~2020-10-10 10:03 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 ` Markus Armbruster [this message]
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 ` [PULL 19/34] qapi/events.py: add type hint annotations Markus Armbruster
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-13-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).