[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/34] qapi/common.py: Add indent manager
From: |
Markus Armbruster |
Subject: |
[PULL 11/34] qapi/common.py: Add indent manager |
Date: |
Sat, 10 Oct 2020 11:54:41 +0200 |
From: John Snow <jsnow@redhat.com>
Code style tools really dislike the use of global keywords, because it
generally involves re-binding the name at runtime which can have strange
effects depending on when and how that global name is referenced in
other modules.
Make a little indent level manager instead.
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-12-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/common.py | 57 +++++++++++++++++++++++++++---------------
scripts/qapi/visit.py | 7 +++---
2 files changed, 40 insertions(+), 24 deletions(-)
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index cee63eb95c..b35318b72c 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -93,33 +93,50 @@ eatspace = '\033EATSPACE.'
pointer_suffix = ' *' + eatspace
-def genindent(count):
- ret = ''
- for _ in range(count):
- ret += ' '
- return ret
+class Indentation:
+ """
+ Indentation level management.
+
+ :param initial: Initial number of spaces, default 0.
+ """
+ def __init__(self, initial: int = 0) -> None:
+ self._level = initial
+
+ def __int__(self) -> int:
+ return self._level
+
+ def __repr__(self) -> str:
+ return "{}({:d})".format(type(self).__name__, self._level)
+
+ def __str__(self) -> str:
+ """Return the current indentation as a string of spaces."""
+ return ' ' * self._level
+
+ def __bool__(self) -> bool:
+ """True when there is a non-zero indentation."""
+ return bool(self._level)
+
+ def increase(self, amount: int = 4) -> None:
+ """Increase the indentation level by ``amount``, default 4."""
+ self._level += amount
+
+ def decrease(self, amount: int = 4) -> None:
+ """Decrease the indentation level by ``amount``, default 4."""
+ if self._level < amount:
+ raise ArithmeticError(
+ f"Can't remove {amount:d} spaces from {self!r}")
+ self._level -= amount
-indent_level = 0
-
-
-def push_indent(indent_amount=4):
- global indent_level
- indent_level += indent_amount
-
-
-def pop_indent(indent_amount=4):
- global indent_level
- indent_level -= indent_amount
+indent = Indentation()
# Generate @code with @kwds interpolated.
-# Obey indent_level, and strip eatspace.
+# Obey indent, and strip eatspace.
def cgen(code, **kwds):
raw = code % kwds
- if indent_level:
- indent = genindent(indent_level)
- raw = re.sub(r'^(?!(#|$))', indent, raw, flags=re.MULTILINE)
+ if indent:
+ raw = re.sub(r'^(?!(#|$))', str(indent), raw, flags=re.MULTILINE)
return re.sub(re.escape(eatspace) + r' *', '', raw)
diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py
index 9fdbe5b9ef..708f72c4a1 100644
--- a/scripts/qapi/visit.py
+++ b/scripts/qapi/visit.py
@@ -18,9 +18,8 @@ from .common import (
c_name,
gen_endif,
gen_if,
+ indent,
mcgen,
- pop_indent,
- push_indent,
)
from .gen import QAPISchemaModularCVisitor, ifcontext
from .schema import QAPISchemaObjectType
@@ -69,7 +68,7 @@ bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s
*obj, Error **errp)
if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
''',
name=memb.name, c_name=c_name(memb.name))
- push_indent()
+ indent.increase()
ret += mcgen('''
if (!visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, errp)) {
return false;
@@ -78,7 +77,7 @@ bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s
*obj, Error **errp)
c_type=memb.type.c_name(), name=memb.name,
c_name=c_name(memb.name))
if memb.optional:
- pop_indent()
+ indent.decrease()
ret += mcgen('''
}
''')
--
2.26.2
- [PULL 00/34] QAPI patches patches for 2020-10-10, Markus Armbruster, 2020/10/10
- [PULL 13/34] qapi/common.py: Replace one-letter 'c' variable, Markus Armbruster, 2020/10/10
- [PULL 03/34] qapi-gen: Separate arg-parsing from generation, Markus Armbruster, 2020/10/10
- [PULL 01/34] docs: repair broken references, Markus Armbruster, 2020/10/10
- [PULL 07/34] qapi: enforce import order/styling with isort, Markus Armbruster, 2020/10/10
- [PULL 08/34] qapi: delint using flake8, Markus Armbruster, 2020/10/10
- [PULL 11/34] qapi/common.py: Add indent manager,
Markus Armbruster <=
- [PULL 12/34] qapi/common.py: delint with pylint, Markus Armbruster, 2020/10/10
- [PULL 02/34] qapi: modify docstrings to be sphinx-compatible, Markus Armbruster, 2020/10/10
- [PULL 15/34] qapi/common.py: add type hint annotations, Markus Armbruster, 2020/10/10
- [PULL 05/34] qapi: Prefer explicit relative imports, Markus Armbruster, 2020/10/10
- [PULL 14/34] qapi/common.py: check with pylint, Markus Armbruster, 2020/10/10
- [PULL 10/34] qapi/common.py: Remove python compatibility workaround, Markus Armbruster, 2020/10/10
- [PULL 04/34] qapi: move generator entrypoint into package, Markus Armbruster, 2020/10/10
- [PULL 06/34] qapi: Remove wildcard includes, Markus Armbruster, 2020/10/10
- [PULL 27/34] qapi/gen.py: Remove unused parameter, Markus Armbruster, 2020/10/10
- [PULL 18/34] qapi: establish mypy type-checking baseline, Markus Armbruster, 2020/10/10