All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	Markus Armbruster <armbru@redhat.com>
Subject: [PATCH v5 07/36] qapi: enforce import order/styling with isort
Date: Mon,  5 Oct 2020 15:51:29 -0400	[thread overview]
Message-ID: <20201005195158.2348217-8-jsnow@redhat.com> (raw)
In-Reply-To: <20201005195158.2348217-1-jsnow@redhat.com>

While we're mucking around with imports, we might as well formalize the
style we use. Let's use isort to do it for us.

lines_after_imports=2: Use two lines after imports, to match PEP8's
desire to have "two lines before and after" class definitions, which are
likely to start immediately after imports.

force_sort_within_sections: Intermingles "from x" and "import x" style
statements, such that sorting is always performed strictly on the module
name itself.

force_grid_wrap=4: Four or more imports from a single module will force
the one-per-line style that's more git-friendly. This will generally
happen for 'typing' imports.

multi_line_output=3: Uses the one-per-line indented style for long
imports.

include_trailing_comma: Adds a comma to the last import in a group,
which makes git conflicts nicer to deal with, generally.

line_length: 72 is chosen to match PEP8's "docstrings and comments" line
length limit. If you have a single line import that exceeds 72
characters, your names are too long!

Suggested-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Tested-by: Cleber Rosa <crosa@redhat.com>
---
 scripts/qapi/.isort.cfg    | 7 +++++++
 scripts/qapi/expr.py       | 3 ++-
 scripts/qapi/introspect.py | 7 +++++--
 scripts/qapi/parser.py     | 2 +-
 scripts/qapi/schema.py     | 2 +-
 5 files changed, 16 insertions(+), 5 deletions(-)
 create mode 100644 scripts/qapi/.isort.cfg

diff --git a/scripts/qapi/.isort.cfg b/scripts/qapi/.isort.cfg
new file mode 100644
index 00000000000..6d0fd6cc0d3
--- /dev/null
+++ b/scripts/qapi/.isort.cfg
@@ -0,0 +1,7 @@
+[settings]
+force_grid_wrap=4
+force_sort_within_sections=True
+include_trailing_comma=True
+line_length=72
+lines_after_imports=2
+multi_line_output=3
\ No newline at end of file
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index 03b31ecfc19..e73b65b6a7e 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -14,8 +14,9 @@
 # This work is licensed under the terms of the GNU GPL, version 2.
 # See the COPYING file in the top-level directory.
 
-import re
 from collections import OrderedDict
+import re
+
 from .common import c_name
 from .error import QAPISemError
 
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index b036fcf9ce7..31acd2f230a 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -17,8 +17,11 @@
     mcgen,
 )
 from .gen import QAPISchemaMonolithicCVisitor
-from .schema import (QAPISchemaArrayType, QAPISchemaBuiltinType,
-                     QAPISchemaType)
+from .schema import (
+    QAPISchemaArrayType,
+    QAPISchemaBuiltinType,
+    QAPISchemaType,
+)
 
 
 def _make_tree(obj, ifcond, features, extra=None):
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 68d8a1ce1cf..477ef25ccdf 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -14,9 +14,9 @@
 # This work is licensed under the terms of the GNU GPL, version 2.
 # See the COPYING file in the top-level directory.
 
+from collections import OrderedDict
 import os
 import re
-from collections import OrderedDict
 
 from .error import QAPIParseError, QAPISemError
 from .source import QAPISourceInfo
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index a835ee6fde3..093f7a38d88 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -14,9 +14,9 @@
 
 # TODO catching name collisions in generated code would be nice
 
+from collections import OrderedDict
 import os
 import re
-from collections import OrderedDict
 
 from .common import c_name, pointer_suffix
 from .error import QAPIError, QAPISemError
-- 
2.26.2



  parent reply	other threads:[~2020-10-05 19:53 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é
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 ` John Snow [this message]
2020-10-07  8:15   ` [PATCH v5 07/36] qapi: enforce import order/styling with isort 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=20201005195158.2348217-8-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.