[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 01/20] [DO-NOT-MERGE]: Add some ad-hoc linting helpers.
From: |
John Snow |
Subject: |
[PATCH 01/20] [DO-NOT-MERGE]: Add some ad-hoc linting helpers. |
Date: |
Tue, 14 May 2024 17:57:20 -0400 |
These aren't ready for upstream inclusion, because they do not properly
manage version dependencies, execution environment and so on. These are
just the tools I use in my Own Special Environment :tm: for testing and
debugging.
They've been tested only on Fedora 38 for right now, which means:
Python 3.11.4-1.fc38
pylint 2.17.4-2.fc38
mypy 1.4.0-1.fc38
isort 5.12.0-1.fc38
flake8 5.0.3-2.fc38
"Soon" :tm: I'll move the qapi generator code under the python/
directory to take advantage of the more robust linting infrastructure
there, but that's going to happen after this series. Sorry about that!
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi-lint.sh | 51 +++++++++++++++++++++++++++++++++++++++++++
scripts/qapi/Makefile | 5 +++++
2 files changed, 56 insertions(+)
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
diff --git a/scripts/qapi-lint.sh b/scripts/qapi-lint.sh
new file mode 100755
index 00000000000..528b31627eb
--- /dev/null
+++ b/scripts/qapi-lint.sh
@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ -f qapi/.flake8 ]]; then
+ echo "flake8 --config=qapi/.flake8 qapi/"
+ flake8 --config=qapi/.flake8 qapi/
+fi
+if [[ -f qapi/pylintrc ]]; then
+ echo "pylint --rcfile=qapi/pylintrc qapi/"
+ pylint --rcfile=qapi/pylintrc qapi/
+fi
+if [[ -f qapi/mypy.ini ]]; then
+ echo "mypy --config-file=qapi/mypy.ini qapi/"
+ mypy --config-file=qapi/mypy.ini qapi/
+fi
+
+if [[ -f qapi/.isort.cfg ]]; then
+ pushd qapi
+ echo "isort -c ."
+ isort -c .
+ popd
+fi
+
+if [[ -f ../docs/sphinx/qapi-domain.py ]]; then
+ pushd ../docs/sphinx
+
+ echo "mypy --strict qapi-domain.py"
+ mypy --strict qapi-domain.py
+ echo "flake8 qapi-domain.py --max-line-length=99"
+ flake8 qapi-domain.py --max-line-length=99
+ echo "isort qapi-domain.py"
+ isort qapi-domain.py
+ echo "black --check qapi-domain.py"
+ black --check qapi-domain.py
+
+ echo "flake8 qapidoc.py --max-line-length=99"
+ flake8 qapidoc.py --max-line-length=99
+ echo "isort qapidoc.py"
+ isort qapidoc.py
+ echo "black --check qapidoc.py"
+ black --check qapidoc.py
+
+ popd
+fi
+
+pushd ../build
+make -j13
+make check-qapi-schema
+make docs
+make sphinxdocs
+popd
diff --git a/scripts/qapi/Makefile b/scripts/qapi/Makefile
new file mode 100644
index 00000000000..314e8a5505e
--- /dev/null
+++ b/scripts/qapi/Makefile
@@ -0,0 +1,5 @@
+check:
+ isort -c .
+ flake8 .
+ cd .. && pylint --rcfile=qapi/pylintrc qapi
+ cd .. && mypy -p qapi --config-file=qapi/mypy.ini
--
2.44.0
- Re: [PATCH 03/20] docs/qapidoc: delint a tiny portion of the module, (continued)
[PATCH 04/20] qapi/parser: preserve indentation in QAPIDoc sections, John Snow, 2024/05/14
[PATCH 01/20] [DO-NOT-MERGE]: Add some ad-hoc linting helpers.,
John Snow <=
[PATCH 06/20] qapi/parser: fix comment parsing immediately following a doc block, John Snow, 2024/05/14
[PATCH 07/20] qapi/parser: add semantic 'kind' parameter to QAPIDoc.Section, John Snow, 2024/05/14
[PATCH 10/20] qapi/schema: add __iter__ method to QAPISchemaVariants, John Snow, 2024/05/14
[PATCH 08/20] qapi/parser: differentiate intro and outro paragraphs, John Snow, 2024/05/14