All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: John Snow <jsnow@redhat.com>,
	Markus Armbruster <armbru@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	Cleber Rosa <crosa@redhat.com>
Subject: [PATCH v3 12/47] qapi: enforce import order/styling with isort
Date: Thu, 24 Sep 2020 20:28:25 -0400	[thread overview]
Message-ID: <20200925002900.465855-13-jsnow@redhat.com> (raw)
In-Reply-To: <20200925002900.465855-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.

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.

Suggested-by: Cleber Rosa <crosa@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
 scripts/qapi/.isort.cfg    | 5 +++++
 scripts/qapi/commands.py   | 6 +-----
 scripts/qapi/doc.py        | 2 +-
 scripts/qapi/expr.py       | 4 ++--
 scripts/qapi/introspect.py | 3 +--
 scripts/qapi/main.py       | 1 -
 scripts/qapi/parser.py     | 2 +-
 scripts/qapi/schema.py     | 2 +-
 scripts/qapi/types.py      | 1 -
 9 files changed, 12 insertions(+), 14 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 0000000000..b0aeffec26
--- /dev/null
+++ b/scripts/qapi/.isort.cfg
@@ -0,0 +1,5 @@
+[settings]
+force_sort_within_sections=True
+force_grid_wrap=4
+multi_line_output=3
+include_trailing_comma=True
diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py
index e1df0e341f..64ed5278f9 100644
--- a/scripts/qapi/commands.py
+++ b/scripts/qapi/commands.py
@@ -13,11 +13,7 @@
 See the COPYING file in the top-level directory.
 """
 
-from .common import (
-    build_params,
-    c_name,
-    mcgen,
-)
+from .common import build_params, c_name, mcgen
 from .gen import QAPIGenCCode, QAPISchemaModularCVisitor, ifcontext
 
 
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
index b764a8ccc0..1acb773e0a 100644
--- a/scripts/qapi/doc.py
+++ b/scripts/qapi/doc.py
@@ -5,9 +5,9 @@
 """This script produces the documentation of a qapi schema in texinfo format"""
 
 import re
+
 from .gen import QAPIGenDoc, QAPISchemaVisitor
 
-
 _MSG = '''
 @deftypefn {type} {{}} {name}
 
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index 03b31ecfc1..3e952a1462 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -14,12 +14,12 @@
 # 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
 
-
 # Names must be letters, numbers, -, and _.  They must start with letter,
 # except for downstream extensions which must start with __RFQDN_.
 # Dots are only valid in the downstream extension prefix.
diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py
index b036fcf9ce..2850121cbd 100644
--- a/scripts/qapi/introspect.py
+++ b/scripts/qapi/introspect.py
@@ -17,8 +17,7 @@
     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/main.py b/scripts/qapi/main.py
index 3f8338ade8..b2f20581fd 100644
--- a/scripts/qapi/main.py
+++ b/scripts/qapi/main.py
@@ -20,7 +20,6 @@
 from .types import gen_types
 from .visit import gen_visit
 
-
 DEFAULT_OUTPUT_DIR = ''
 DEFAULT_PREFIX = ''
 
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 76d28c1ce9..fd89e2188b 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 a835ee6fde..093f7a38d8 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
diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py
index 53b47f9e58..cc6dad4c89 100644
--- a/scripts/qapi/types.py
+++ b/scripts/qapi/types.py
@@ -23,7 +23,6 @@
 from .gen import QAPISchemaModularCVisitor, ifcontext
 from .schema import QAPISchemaEnumMember, QAPISchemaObjectType
 
-
 # variants must be emitted before their container; track what has already
 # been output
 objects_seen = set()
-- 
2.26.2



  parent reply	other threads:[~2020-09-25  0:44 UTC|newest]

Thread overview: 75+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-25  0:28 [PATCH v3 00/47] qapi: static typing conversion, pt1 John Snow
2020-09-25  0:28 ` [PATCH v3 01/47] [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick (``) John Snow
2020-09-29  2:47   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 02/47] [DO-NOT-MERGE] docs: repair broken references John Snow
2020-09-29  2:48   ` Cleber Rosa
2020-09-29  3:14   ` Cleber Rosa
2020-09-29 15:30     ` John Snow
2020-09-29 18:16     ` John Snow
2020-09-25  0:28 ` [PATCH v3 03/47] [DO-NOT-MERGE] docs/sphinx: change default role to "any" John Snow
2020-09-29  3:30   ` Cleber Rosa
2020-09-29 15:33     ` John Snow
2020-09-29 18:20     ` John Snow
2020-09-25  0:28 ` [PATCH v3 04/47] qapi: modify docstrings to be sphinx-compatible John Snow
2020-09-29  3:39   ` Cleber Rosa
2020-09-29 15:37     ` John Snow
2020-09-25  0:28 ` [PATCH v3 05/47] qapi/doc.py: Change code templates from function to string John Snow
2020-09-25  8:59   ` Markus Armbruster
2020-09-25 14:23     ` John Snow
2020-09-29  3:51   ` Cleber Rosa
2020-09-29 18:25     ` John Snow
2020-09-25  0:28 ` [PATCH v3 06/47] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi John Snow
2020-09-29  4:00   ` Cleber Rosa
2020-09-29 18:30     ` John Snow
2020-09-25  0:28 ` [PATCH v3 07/47] qapi-gen: Separate arg-parsing from generation John Snow
2020-09-29  4:02   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 08/47] qapi: move generator entrypoint into module John Snow
2020-09-25  0:28 ` [PATCH v3 09/47] [DO-NOT-MERGE] docs: add scripts/qapi/main to python manual John Snow
2020-09-25  0:28 ` [PATCH v3 10/47] qapi: Prefer explicit relative imports John Snow
2020-09-25  0:28 ` [PATCH v3 11/47] qapi: Remove wildcard includes John Snow
2020-09-25  0:28 ` John Snow [this message]
2020-09-25  9:20   ` [PATCH v3 12/47] qapi: enforce import order/styling with isort Markus Armbruster
2020-09-25 15:26     ` John Snow
2020-09-28 12:13       ` Markus Armbruster
2020-09-28 14:34         ` John Snow
2020-09-29  4:13           ` Cleber Rosa
2020-09-29  4:15   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 13/47] qapi: delint using flake8 John Snow
2020-09-25  0:28 ` [PATCH v3 14/47] qapi: add pylintrc John Snow
2020-09-25  0:28 ` [PATCH v3 15/47] qapi/common.py: Remove python compatibility workaround John Snow
2020-09-25  0:28 ` [PATCH v3 16/47] qapi/common.py: Add indent manager John Snow
2020-09-25  0:28 ` [PATCH v3 17/47] qapi/common.py: delint with pylint John Snow
2020-09-25  0:28 ` [PATCH v3 18/47] qapi/common.py: Replace one-letter 'c' variable John Snow
2020-09-25  0:28 ` [PATCH v3 19/47] qapi/common.py: check with pylint John Snow
2020-09-25  0:28 ` [PATCH v3 20/47] qapi/common.py: add type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 21/47] qapi/common.py: Convert comments into docstrings, and elaborate John Snow
2020-09-25  0:28 ` [PATCH v3 22/47] qapi/common.py: move build_params into gen.py John Snow
2020-09-25  0:28 ` [PATCH v3 23/47] qapi: establish mypy type-checking baseline John Snow
2020-09-29  4:17   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 24/47] qapi/events.py: add type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 25/47] qapi/events.py: Move comments into docstrings John Snow
2020-09-25  0:28 ` [PATCH v3 26/47] qapi/commands.py: Don't re-bind to variable of different type John Snow
2020-09-25  0:28 ` [PATCH v3 27/47] qapi/commands.py: add type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 28/47] qapi/commands.py: enable checking with mypy John Snow
2020-09-25  0:28 ` [PATCH v3 29/47] qapi/source.py: add type hint annotations John Snow
2020-09-29  4:18   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 30/47] qapi/source.py: delint with pylint John Snow
2020-09-25  0:28 ` [PATCH v3 31/47] qapi/gen.py: Fix edge-case of _is_user_module John Snow
2020-09-29  4:22   ` Cleber Rosa
2020-09-25  0:28 ` [PATCH v3 32/47] qapi/gen.py: add type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 33/47] qapi/gen.py: Enable checking with mypy John Snow
2020-09-25  0:28 ` [PATCH v3 34/47] qapi/gen.py: Remove unused parameter John Snow
2020-09-25  0:28 ` [PATCH v3 35/47] qapi/gen.py: update write() to be more idiomatic John Snow
2020-09-25  0:28 ` [PATCH v3 36/47] qapi/gen.py: delint with pylint John Snow
2020-09-25  0:28 ` [PATCH v3 37/47] qapi/introspect.py: assert obj is a dict when features are given John Snow
2020-09-25  0:28 ` [PATCH v3 38/47] qapi/instrospect.py: add preliminary type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 39/47] qapi/introspect.py: add _gen_features helper John Snow
2020-09-25  0:28 ` [PATCH v3 40/47] qapi/introspect.py: Unify return type of _make_tree() John Snow
2020-09-25  0:28 ` [PATCH v3 41/47] qapi/introspect.py: replace 'extra' dict with 'comment' argument John Snow
2020-09-25  0:28 ` [PATCH v3 42/47] qapi/introspect.py: create a typed 'Node' data structure John Snow
2020-09-25  0:28 ` [PATCH v3 43/47] qapi/types.py: add type hint annotations John Snow
2020-09-25  0:28 ` [PATCH v3 44/47] qapi/types.py: remove one-letter variables John Snow
2020-09-25  0:28 ` [PATCH v3 45/47] qapi/visit.py: assert tag_member contains a QAPISchemaEnumType John Snow
2020-09-25  0:28 ` [PATCH v3 46/47] qapi/visit.py: remove unused parameters from gen_visit_object John Snow
2020-09-25  0:29 ` [PATCH v3 47/47] qapi/visit.py: add type hint annotations John Snow
2020-09-28 15:17 ` [PATCH v3 00/47] qapi: static typing conversion, pt1 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=20200925002900.465855-13-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.