From 3c77412d335bc50edaf575a797e8c43a22fb5996 Mon Sep 17 00:00:00 2001
From: Alexandre Flament <alex@al-f.net>
Date: Fri, 24 Dec 2021 09:49:45 +0100
Subject: [mod] replace pycodestyle by black

"make test.black" checks for the code style
"make format.python" format the python code
---
 manage | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

(limited to 'manage')

diff --git a/manage b/manage
index 8eb347f4f..58c82fec8 100755
--- a/manage
+++ b/manage
@@ -24,6 +24,8 @@ PY_SETUP_EXTRAS='[test]'
 GECKODRIVER_VERSION="v0.30.0"
 export NODE_MINIMUM_VERSION="16.13.0"
 # SPHINXOPTS=
+BLACK_OPTIONS=("--target-version" "py37" "--line-length" "120" "--skip-string-normalization")
+BLACK_TARGETS=("--exclude" "searx/static,searx/languages.py" "searx" "searxng_extra" "tests")
 
 pylint.FILES() {
 
@@ -31,8 +33,7 @@ pylint.FILES() {
     #
     #   # lint: pylint
     #
-    # These py files are linted by test.pylint(), all other files are linted by
-    # test.pep8()
+    # These py files are linted by test.pylint()
 
     grep -l -r --include \*.py '^#[[:blank:]]*lint:[[:blank:]]*pylint' searx searxng_extra tests
 }
@@ -89,10 +90,12 @@ pyenv.:
   OK        : test if virtualenv is OK
 pypi.upload:
   Upload python packages to PyPi (to test use pypi.upload.test)
+format.:
+  python    : format Python code source using black
 test.:
   yamllint  : lint YAML files (YAMLLINT_FILES)
   pylint    : lint PYLINT_FILES, searx/engines, searx & tests
-  pep8      : pycodestyle (pep8) for all files except PYLINT_FILES
+  black     : check black code format
   unit      : run unit tests
   coverage  : run unit tests with coverage
   robot     : run robot test
@@ -617,6 +620,12 @@ pypi.upload.test() {
     pyenv.cmd twine upload -r testpypi "${PYDIST}"/*
 }
 
+format.python() {
+    build_msg TEST "[format.python] black \$BLACK_TARGETS"
+    pyenv.cmd black "${BLACK_OPTIONS[@]}" "${BLACK_TARGETS[@]}"
+    dump_return $?
+}
+
 test.yamllint() {
     build_msg TEST "[yamllint] \$YAMLLINT_FILES"
     pyenv.cmd yamllint --format parsable "${YAMLLINT_FILES[@]}"
@@ -646,15 +655,9 @@ test.pylint() {
     dump_return $?
 }
 
-test.pep8() {
-    build_msg TEST 'pycodestyle (formerly pep8)'
-    local _exclude=""
-    printf -v _exclude '%s, ' "${PYLINT_FILES[@]}"
-    pyenv.cmd pycodestyle \
-              --exclude="searx/static, searx/languages.py, $_exclude " \
-              --max-line-length=120 \
-              --ignore "E117,E252,E402,E722,E741,W503,W504,W605" \
-              searx tests
+test.black() {
+    build_msg TEST "[black] \$BLACK_TARGETS"
+    pyenv.cmd black --check "${BLACK_OPTIONS[@]}" "${BLACK_TARGETS[@]}"
     dump_return $?
 }
 
-- 
cgit v1.2.3


From c849731eb1df23b8509a947fcc2807adb34dc730 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Fri, 24 Dec 2021 13:19:14 +0100
Subject: [mod] test.black: show issues (diff) reported by python-black

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 manage | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'manage')

diff --git a/manage b/manage
index 58c82fec8..bf202cb67 100755
--- a/manage
+++ b/manage
@@ -657,7 +657,7 @@ test.pylint() {
 
 test.black() {
     build_msg TEST "[black] \$BLACK_TARGETS"
-    pyenv.cmd black --check "${BLACK_OPTIONS[@]}" "${BLACK_TARGETS[@]}"
+    pyenv.cmd black --check --diff "${BLACK_OPTIONS[@]}" "${BLACK_TARGETS[@]}"
     dump_return $?
 }
 
-- 
cgit v1.2.3