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 04/34] qapi: move generator entrypoint into package
Date: Sat, 10 Oct 2020 11:54:34 +0200 [thread overview]
Message-ID: <20201010095504.796182-5-armbru@redhat.com> (raw)
In-Reply-To: <20201010095504.796182-1-armbru@redhat.com>
From: John Snow <jsnow@redhat.com>
As part of delinting and adding type hints to the QAPI generator, it's
helpful for the entrypoint to be part of the package, only leaving a
very tiny entrypoint shim outside of the package.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Tested-by: Cleber Rosa <crosa@redhat.com>
Message-Id: <20201009161558.107041-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[invalid_char() renamed to invalid_prefix_char()]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi-gen.py | 94 +++----------------------------------------
scripts/qapi/main.py | 95 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 101 insertions(+), 88 deletions(-)
create mode 100644 scripts/qapi/main.py
diff --git a/scripts/qapi-gen.py b/scripts/qapi-gen.py
index cf942d9ce3..f3518d29a5 100644
--- a/scripts/qapi-gen.py
+++ b/scripts/qapi-gen.py
@@ -4,98 +4,16 @@
# See the COPYING file in the top-level directory.
"""
-QAPI Generator
+QAPI code generation execution shim.
-This is the main entry point for generating C code from the QAPI schema.
+This standalone script exists primarily to facilitate the running of the QAPI
+code generator without needing to install the python module to the current
+execution environment.
"""
-import argparse
-import re
import sys
-from typing import Optional
-
-from qapi.commands import gen_commands
-from qapi.error import QAPIError
-from qapi.events import gen_events
-from qapi.introspect import gen_introspect
-from qapi.schema import QAPISchema
-from qapi.types import gen_types
-from qapi.visit import gen_visit
-
-
-def invalid_prefix_char(prefix: str) -> Optional[str]:
- match = re.match(r'([A-Za-z_.-][A-Za-z0-9_.-]*)?', prefix)
- if match.end() != len(prefix):
- return prefix[match.end()]
- return None
-
-
-def generate(schema_file: str,
- output_dir: str,
- prefix: str,
- unmask: bool = False,
- builtins: bool = False) -> None:
- """
- Generate C code for the given schema into the target directory.
-
- :param schema_file: The primary QAPI schema file.
- :param output_dir: The output directory to store generated code.
- :param prefix: Optional C-code prefix for symbol names.
- :param unmask: Expose non-ABI names through introspection?
- :param builtins: Generate code for built-in types?
-
- :raise QAPIError: On failures.
- """
- assert invalid_prefix_char(prefix) is None
-
- schema = QAPISchema(schema_file)
- gen_types(schema, output_dir, prefix, builtins)
- gen_visit(schema, output_dir, prefix, builtins)
- gen_commands(schema, output_dir, prefix)
- gen_events(schema, output_dir, prefix)
- gen_introspect(schema, output_dir, prefix, unmask)
-
-
-def main() -> int:
- """
- gapi-gen executable entry point.
- Expects arguments via sys.argv, see --help for details.
-
- :return: int, 0 on success, 1 on failure.
- """
- parser = argparse.ArgumentParser(
- description='Generate code from a QAPI schema')
- parser.add_argument('-b', '--builtins', action='store_true',
- help="generate code for built-in types")
- parser.add_argument('-o', '--output-dir', action='store',
- default='',
- help="write output to directory OUTPUT_DIR")
- parser.add_argument('-p', '--prefix', action='store',
- default='',
- help="prefix for symbols")
- parser.add_argument('-u', '--unmask-non-abi-names', action='store_true',
- dest='unmask',
- help="expose non-ABI names in introspection")
- parser.add_argument('schema', action='store')
- args = parser.parse_args()
-
- funny_char = invalid_prefix_char(args.prefix)
- if funny_char:
- msg = f"funny character '{funny_char}' in argument of --prefix"
- print(f"{sys.argv[0]}: {msg}", file=sys.stderr)
- return 1
-
- try:
- generate(args.schema,
- output_dir=args.output_dir,
- prefix=args.prefix,
- unmask=args.unmask,
- builtins=args.builtins)
- except QAPIError as err:
- print(f"{sys.argv[0]}: {str(err)}", file=sys.stderr)
- return 1
- return 0
+from qapi import main
if __name__ == '__main__':
- sys.exit(main())
+ sys.exit(main.main())
diff --git a/scripts/qapi/main.py b/scripts/qapi/main.py
new file mode 100644
index 0000000000..92a2a31ca1
--- /dev/null
+++ b/scripts/qapi/main.py
@@ -0,0 +1,95 @@
+# This work is licensed under the terms of the GNU GPL, version 2 or later.
+# See the COPYING file in the top-level directory.
+
+"""
+QAPI Generator
+
+This is the main entry point for generating C code from the QAPI schema.
+"""
+
+import argparse
+import re
+import sys
+from typing import Optional
+
+from qapi.commands import gen_commands
+from qapi.error import QAPIError
+from qapi.events import gen_events
+from qapi.introspect import gen_introspect
+from qapi.schema import QAPISchema
+from qapi.types import gen_types
+from qapi.visit import gen_visit
+
+
+def invalid_prefix_char(prefix: str) -> Optional[str]:
+ match = re.match(r'([A-Za-z_.-][A-Za-z0-9_.-]*)?', prefix)
+ if match.end() != len(prefix):
+ return prefix[match.end()]
+ return None
+
+
+def generate(schema_file: str,
+ output_dir: str,
+ prefix: str,
+ unmask: bool = False,
+ builtins: bool = False) -> None:
+ """
+ Generate C code for the given schema into the target directory.
+
+ :param schema_file: The primary QAPI schema file.
+ :param output_dir: The output directory to store generated code.
+ :param prefix: Optional C-code prefix for symbol names.
+ :param unmask: Expose non-ABI names through introspection?
+ :param builtins: Generate code for built-in types?
+
+ :raise QAPIError: On failures.
+ """
+ assert invalid_prefix_char(prefix) is None
+
+ schema = QAPISchema(schema_file)
+ gen_types(schema, output_dir, prefix, builtins)
+ gen_visit(schema, output_dir, prefix, builtins)
+ gen_commands(schema, output_dir, prefix)
+ gen_events(schema, output_dir, prefix)
+ gen_introspect(schema, output_dir, prefix, unmask)
+
+
+def main() -> int:
+ """
+ gapi-gen executable entry point.
+ Expects arguments via sys.argv, see --help for details.
+
+ :return: int, 0 on success, 1 on failure.
+ """
+ parser = argparse.ArgumentParser(
+ description='Generate code from a QAPI schema')
+ parser.add_argument('-b', '--builtins', action='store_true',
+ help="generate code for built-in types")
+ parser.add_argument('-o', '--output-dir', action='store',
+ default='',
+ help="write output to directory OUTPUT_DIR")
+ parser.add_argument('-p', '--prefix', action='store',
+ default='',
+ help="prefix for symbols")
+ parser.add_argument('-u', '--unmask-non-abi-names', action='store_true',
+ dest='unmask',
+ help="expose non-ABI names in introspection")
+ parser.add_argument('schema', action='store')
+ args = parser.parse_args()
+
+ funny_char = invalid_prefix_char(args.prefix)
+ if funny_char:
+ msg = f"funny character '{funny_char}' in argument of --prefix"
+ print(f"{sys.argv[0]}: {msg}", file=sys.stderr)
+ return 1
+
+ try:
+ generate(args.schema,
+ output_dir=args.output_dir,
+ prefix=args.prefix,
+ unmask=args.unmask,
+ builtins=args.builtins)
+ except QAPIError as err:
+ print(f"{sys.argv[0]}: {str(err)}", file=sys.stderr)
+ return 1
+ return 0
--
2.26.2
next prev parent reply other threads:[~2020-10-10 9:59 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 ` Markus Armbruster [this message]
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 ` [PULL 12/34] qapi/common.py: delint with pylint Markus Armbruster
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-5-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).