[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 07/36] qapi: enforce import order/styling with isort
From: |
John Snow |
Subject: |
[PATCH v6 07/36] qapi: enforce import order/styling with isort |
Date: |
Fri, 9 Oct 2020 12:15:29 -0400 |
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>
Reviewed-by: Markus Armbruster <armbru@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..643caa1fbd6
--- /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
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index bb4dc55f56f..2fcaaa2497a 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 42016a7e668..fafec94e022 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 7298f5dbd14..e7b9d670ad6 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 676185d1a71..71ebb1e396d 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
- [PATCH v6 01/36] docs: repair broken references, (continued)
- [PATCH v6 04/36] qapi: move generator entrypoint into package, John Snow, 2020/10/09
- [PATCH v6 08/36] qapi: delint using flake8, John Snow, 2020/10/09
- [PATCH v6 06/36] qapi: Remove wildcard includes, John Snow, 2020/10/09
- [PATCH v6 05/36] qapi: Prefer explicit relative imports, John Snow, 2020/10/09
- [PATCH v6 07/36] qapi: enforce import order/styling with isort,
John Snow <=
- [PATCH v6 09/36] qapi: add pylintrc, John Snow, 2020/10/09
- [PATCH v6 10/36] qapi/common.py: Remove python compatibility workaround, John Snow, 2020/10/09
- [PATCH v6 11/36] qapi/common.py: Add indent manager, John Snow, 2020/10/09
- [PATCH v6 12/36] qapi/common.py: delint with pylint, John Snow, 2020/10/09
- [PATCH v6 13/36] qapi/common.py: Replace one-letter 'c' variable, John Snow, 2020/10/09
- [PATCH v6 15/36] qapi/common.py: add type hint annotations, John Snow, 2020/10/09
- [PATCH v6 20/36] qapi/events.py: Move comments into docstrings, John Snow, 2020/10/09
- [PATCH v6 16/36] qapi/common.py: Convert comments into docstrings, and elaborate, John Snow, 2020/10/09
- [PATCH v6 14/36] qapi/common.py: check with pylint, John Snow, 2020/10/09
- [PATCH v6 17/36] qapi/common.py: move build_params into gen.py, John Snow, 2020/10/09