From: "Philippe Mathieu-Daudé" <philmd@redhat.com>
To: John Snow <jsnow@redhat.com>, qemu-devel@nongnu.org
Cc: Markus Armbruster <armbru@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>,
Cleber Rosa <crosa@redhat.com>
Subject: Re: [PATCH v5 05/36] qapi: Prefer explicit relative imports
Date: Tue, 6 Oct 2020 13:33:35 +0200 [thread overview]
Message-ID: <fed558a5-8529-7b3b-5790-79b368e4d897@redhat.com> (raw)
In-Reply-To: <20201005195158.2348217-6-jsnow@redhat.com>
On 10/5/20 9:51 PM, John Snow wrote:
> All of the QAPI include statements are changed to be package-aware, as
> explicit relative imports.
>
> A quirk of Python packages is that the name of the package exists only
> *outside* of the package. This means that to a module inside of the qapi
> folder, there is inherently no such thing as the "qapi" package. The
> reason these imports work is because the "qapi" package exists in the
> context of the caller -- the execution shim, where sys.path includes a
> directory that has a 'qapi' folder in it.
>
> When we write "from qapi import sibling", we are NOT referencing the folder
> 'qapi', but rather "any package named qapi in sys.path". If you should
> so happen to have a 'qapi' package in your path, it will use *that*
> package.
>
> When we write "from .sibling import foo", we always reference explicitly
> our sibling module; guaranteeing consistency in *where* we are importing
> these modules from.
>
> This can be useful when working with virtual environments and packages
> in development mode. In development mode, a package is installed as a
> series of symlinks that forwards to your same source files. The problem
> arises because code quality checkers will follow "import qapi.x" to the
> "installed" version instead of the sibling file and -- even though they
> are the same file -- they have different module paths, and this causes
> cyclic import problems, false positive type mismatch errors, and more.
>
> It can also be useful when dealing with hierarchical packages, e.g. if
> we allow qemu.core.qmp, qemu.qapi.parser, etc.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
> Reviewed-by: Cleber Rosa <crosa@redhat.com>
> ---
> scripts/qapi/commands.py | 4 ++--
> scripts/qapi/events.py | 8 ++++----
> scripts/qapi/expr.py | 4 ++--
> scripts/qapi/gen.py | 4 ++--
> scripts/qapi/introspect.py | 8 ++++----
> scripts/qapi/main.py | 14 +++++++-------
> scripts/qapi/parser.py | 4 ++--
> scripts/qapi/schema.py | 8 ++++----
> scripts/qapi/types.py | 6 +++---
> scripts/qapi/visit.py | 6 +++---
> 10 files changed, 33 insertions(+), 33 deletions(-)
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
next prev parent reply other threads:[~2020-10-06 11:37 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-05 19:51 [PATCH v5 00/36] qapi: static typing conversion, pt1 John Snow
2020-10-05 19:51 ` [PATCH v5 01/36] docs: repair broken references John Snow
2020-10-05 19:51 ` [PATCH v5 02/36] qapi: modify docstrings to be sphinx-compatible John Snow
2020-10-06 11:21 ` Markus Armbruster
2020-10-06 15:23 ` John Snow
2020-10-07 7:24 ` Markus Armbruster
2020-10-07 17:00 ` John Snow
2020-10-05 19:51 ` [PATCH v5 03/36] qapi-gen: Separate arg-parsing from generation John Snow
2020-10-06 11:51 ` Markus Armbruster
2020-10-06 15:59 ` John Snow
2020-10-07 7:54 ` Markus Armbruster
2020-10-07 14:52 ` John Snow
2020-10-08 5:56 ` Markus Armbruster
2020-10-08 17:33 ` John Snow
2020-10-06 16:46 ` John Snow
2020-10-07 8:07 ` Markus Armbruster
2020-10-07 14:36 ` John Snow
2020-10-08 6:51 ` Markus Armbruster
2020-10-08 16:37 ` John Snow
2020-10-08 16:50 ` John Snow
2020-10-09 7:12 ` Markus Armbruster
2020-10-07 8:12 ` Markus Armbruster
2020-10-07 14:41 ` John Snow
2020-10-08 7:15 ` Markus Armbruster
2020-10-08 17:14 ` John Snow
2020-10-09 7:19 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 04/36] qapi: move generator entrypoint into module John Snow
2020-10-05 19:51 ` [PATCH v5 05/36] qapi: Prefer explicit relative imports John Snow
2020-10-06 11:33 ` Philippe Mathieu-Daudé [this message]
2020-10-05 19:51 ` [PATCH v5 06/36] qapi: Remove wildcard includes John Snow
2020-10-06 11:34 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 07/36] qapi: enforce import order/styling with isort John Snow
2020-10-07 8:15 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 08/36] qapi: delint using flake8 John Snow
2020-10-07 8:19 ` Markus Armbruster
2020-10-07 14:54 ` John Snow
2020-10-05 19:51 ` [PATCH v5 09/36] qapi: add pylintrc John Snow
2020-10-05 19:51 ` [PATCH v5 10/36] qapi/common.py: Remove python compatibility workaround John Snow
2020-10-05 19:51 ` [PATCH v5 11/36] qapi/common.py: Add indent manager John Snow
2020-10-07 8:50 ` Markus Armbruster
2020-10-07 18:08 ` John Snow
2020-10-07 18:18 ` Eduardo Habkost
2020-10-08 7:23 ` Markus Armbruster
2020-10-08 17:45 ` John Snow
2020-10-05 19:51 ` [PATCH v5 12/36] qapi/common.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 13/36] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-10-06 11:35 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 14/36] qapi/common.py: check with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 15/36] qapi/common.py: add type hint annotations John Snow
2020-10-07 9:03 ` Markus Armbruster
2020-10-07 15:01 ` John Snow
2020-10-05 19:51 ` [PATCH v5 16/36] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-10-07 9:14 ` Markus Armbruster
2020-10-07 15:23 ` John Snow
2020-10-08 7:20 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 17/36] qapi/common.py: move build_params into gen.py John Snow
2020-10-07 9:21 ` Markus Armbruster
2020-10-07 15:26 ` John Snow
2020-10-07 18:10 ` Eduardo Habkost
2020-10-05 19:51 ` [PATCH v5 18/36] qapi: establish mypy type-checking baseline John Snow
2020-10-07 9:25 ` Markus Armbruster
2020-10-07 15:33 ` John Snow
2020-10-08 7:29 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 19/36] qapi/events.py: add type hint annotations John Snow
2020-10-07 11:32 ` Markus Armbruster
2020-10-07 11:49 ` Markus Armbruster
2020-10-07 15:46 ` John Snow
2020-10-08 9:16 ` Markus Armbruster
2020-10-08 16:19 ` John Snow
2020-10-09 7:21 ` Markus Armbruster
2020-10-07 15:39 ` John Snow
2020-10-08 7:41 ` Markus Armbruster
2020-10-08 15:35 ` John Snow
2020-10-05 19:51 ` [PATCH v5 20/36] qapi/events.py: Move comments into docstrings John Snow
2020-10-05 19:51 ` [PATCH v5 21/36] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-10-07 11:34 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 22/36] qapi/commands.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 23/36] qapi/commands.py: enable checking with mypy John Snow
2020-10-07 11:37 ` Markus Armbruster
2020-10-07 15:49 ` John Snow
2020-10-08 7:52 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 24/36] qapi/source.py: add type hint annotations John Snow
2020-10-07 11:55 ` Markus Armbruster
2020-10-07 16:04 ` John Snow
2020-10-08 8:42 ` Markus Armbruster
2020-10-09 14:30 ` John Snow
2020-10-09 14:37 ` John Snow
2020-10-05 19:51 ` [PATCH v5 25/36] qapi/source.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 26/36] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-10-06 11:44 ` Philippe Mathieu-Daudé
2020-10-07 12:02 ` Markus Armbruster
2020-10-07 16:09 ` John Snow
2020-10-05 19:51 ` [PATCH v5 27/36] qapi/gen.py: add type hint annotations John Snow
2020-10-07 12:21 ` Markus Armbruster
2020-10-07 16:21 ` John Snow
2020-10-07 13:20 ` Markus Armbruster
2020-10-07 16:50 ` John Snow
2020-10-08 8:44 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 28/36] qapi/gen.py: Enable checking with mypy John Snow
2020-10-05 19:51 ` [PATCH v5 29/36] qapi/gen.py: Remove unused parameter John Snow
2020-10-07 12:22 ` Markus Armbruster
2020-10-07 16:23 ` John Snow
2020-10-05 19:51 ` [PATCH v5 30/36] qapi/gen.py: update write() to be more idiomatic John Snow
2020-10-07 12:32 ` Markus Armbruster
2020-10-07 16:25 ` John Snow
2020-10-05 19:51 ` [PATCH v5 31/36] qapi/gen.py: delint with pylint John Snow
2020-10-05 19:51 ` [PATCH v5 32/36] qapi/types.py: add type hint annotations John Snow
2020-10-05 19:51 ` [PATCH v5 33/36] qapi/types.py: remove one-letter variables John Snow
2020-10-07 12:42 ` Markus Armbruster
2020-10-07 16:31 ` John Snow
2020-10-05 19:51 ` [PATCH v5 34/36] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-10-07 12:43 ` Markus Armbruster
2020-10-07 16:40 ` John Snow
2020-10-08 9:06 ` Markus Armbruster
2020-10-08 15:49 ` John Snow
2020-10-09 7:24 ` Markus Armbruster
2020-10-05 19:51 ` [PATCH v5 35/36] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-10-06 11:43 ` Philippe Mathieu-Daudé
2020-10-05 19:51 ` [PATCH v5 36/36] qapi/visit.py: add type hint annotations John Snow
2020-10-07 13:00 ` Markus Armbruster
2020-10-07 16:43 ` John Snow
2020-10-05 23:05 ` [PATCH v5 00/36] qapi: static typing conversion, pt1 Cleber Rosa
2020-10-05 23:57 ` John Snow
2020-10-06 17:51 ` Cleber Rosa
2020-10-07 13:05 ` Markus Armbruster
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=fed558a5-8529-7b3b-5790-79b368e4d897@redhat.com \
--to=philmd@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=jsnow@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).