[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers.
From: |
John Snow |
Subject: |
[PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers. |
Date: |
Tue, 16 Jul 2024 22:13:03 -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 | 61 +++++++++++++++++++++++++++++++++++++++++++
scripts/qapi/Makefile | 5 ++++
2 files changed, 66 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..732716f2444
--- /dev/null
+++ b/scripts/qapi-lint.sh
@@ -0,0 +1,61 @@
+#!/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
+
+ popd
+fi
+
+if [[ -f ../docs/sphinx/qapidoc.py ]]; then
+ pushd ../docs/sphinx
+
+ echo "pylint --rc-file ../../scripts/qapi/pylintrc qapidoc.py"
+ PYTHONPATH=../scripts/ pylint \
+ --rc-file ../../scripts/qapi/pylintrc \
+ qapidoc.py
+ echo "flake8 qapidoc.py --max-line-length=80"
+ flake8 qapidoc.py --max-line-length=80
+ echo "isort qapidoc.py"
+ isort qapidoc.py
+ echo "black --line-length 80 --check qapidoc.py"
+ black --line-length 80 --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.45.0
- [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives, John Snow, 2024/07/16
- [PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers.,
John Snow <=
- [PATCH v2 3/9] docs/qapidoc: create qmp-example directive, John Snow, 2024/07/16
- [PATCH v2 4/9] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks, John Snow, 2024/07/16
- [PATCH v2 2/9] docs/qapidoc: factor out do_parse(), John Snow, 2024/07/16
- [PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive, John Snow, 2024/07/16
- [PATCH v2 6/9] qapi: convert "Example" sections without titles, John Snow, 2024/07/16
- [PATCH v2 7/9] qapi: convert "Example" sections with titles, John Snow, 2024/07/16
- [PATCH v2 8/9] qapi: convert "Example" sections with longer prose, John Snow, 2024/07/16