aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz>2024-08-27 13:27:59 +0200
committerMarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz>2024-08-29 07:03:42 +0200
commitfafdb7df34507eee735893aa871da6ae529e6372 (patch)
tree950d37198b2416c208cedaa1bfefbc0308de42da
parentfaf17df7fb88590d936d10c471a9ea6a2ce4454d (diff)
lint: Speed up flake8 checks
Previously they may have taken more than 10 seconds. Now they should finish in less than one second. This also allows to drop one dependency to be installed.
-rwxr-xr-xci/lint/04_install.sh1
-rw-r--r--test/lint/README.md1
-rwxr-xr-xtest/lint/lint-python.py59
-rw-r--r--test/lint/test_runner/src/main.rs48
4 files changed, 45 insertions, 64 deletions
diff --git a/ci/lint/04_install.sh b/ci/lint/04_install.sh
index acec2f32e9..cfdb4ea936 100755
--- a/ci/lint/04_install.sh
+++ b/ci/lint/04_install.sh
@@ -49,7 +49,6 @@ fi
${CI_RETRY_EXE} pip3 install \
codespell==2.2.6 \
- flake8==6.1.0 \
lief==0.13.2 \
mypy==1.4.1 \
pyzmq==25.1.0 \
diff --git a/test/lint/README.md b/test/lint/README.md
index 48344288ec..8c1f0fedf0 100644
--- a/test/lint/README.md
+++ b/test/lint/README.md
@@ -45,7 +45,6 @@ or `--help`:
| Lint test | Dependency |
|-----------|:----------:|
-| [`lint-python.py`](/test/lint/lint-python.py) | [flake8](https://github.com/PyCQA/flake8)
| [`lint-python.py`](/test/lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
| [`lint-python.py`](/test/lint/lint-python.py) | [mypy](https://github.com/python/mypy)
| [`lint-python.py`](/test/lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
diff --git a/test/lint/lint-python.py b/test/lint/lint-python.py
index 439d1f1a09..e2dbe25b88 100755
--- a/test/lint/lint-python.py
+++ b/test/lint/lint-python.py
@@ -5,13 +5,12 @@
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""
-Check for specified flake8 and mypy warnings in python files.
+Check for specified mypy warnings in python files.
"""
import os
from pathlib import Path
import subprocess
-import sys
from importlib.metadata import metadata, PackageNotFoundError
@@ -19,52 +18,12 @@ from importlib.metadata import metadata, PackageNotFoundError
cache_dir = Path(__file__).parent.parent / ".mypy_cache"
os.environ["MYPY_CACHE_DIR"] = str(cache_dir)
-DEPS = ['flake8', 'lief', 'mypy', 'pyzmq']
-
-# All .py files, except those in src/ (to exclude subtrees there)
-FLAKE_FILES_ARGS = ['git', 'ls-files', '*.py', ':!:src/*.py']
+DEPS = ['lief', 'mypy', 'pyzmq']
# Only .py files in test/functional and contrib/devtools have type annotations
# enforced.
MYPY_FILES_ARGS = ['git', 'ls-files', 'test/functional/*.py', 'contrib/devtools/*.py']
-ENABLED = (
- 'E101,' # indentation contains mixed spaces and tabs
- 'E401,' # multiple imports on one line
- 'E402,' # module level import not at top of file
- 'E701,' # multiple statements on one line (colon)
- 'E702,' # multiple statements on one line (semicolon)
- 'E703,' # statement ends with a semicolon
- 'E711,' # comparison to None should be 'if cond is None:'
- 'E714,' # test for object identity should be "is not"
- 'E721,' # do not compare types, use "isinstance()"
- 'E722,' # do not use bare 'except'
- 'E742,' # do not define classes named "l", "O", or "I"
- 'E743,' # do not define functions named "l", "O", or "I"
- 'F401,' # module imported but unused
- 'F402,' # import module from line N shadowed by loop variable
- 'F403,' # 'from foo_module import *' used; unable to detect undefined names
- 'F404,' # future import(s) name after other statements
- 'F405,' # foo_function may be undefined, or defined from star imports: bar_module
- 'F406,' # "from module import *" only allowed at module level
- 'F407,' # an undefined __future__ feature name was imported
- 'F601,' # dictionary key name repeated with different values
- 'F602,' # dictionary key variable name repeated with different values
- 'F621,' # too many expressions in an assignment with star-unpacking
- 'F631,' # assertion test is a tuple, which are always True
- 'F632,' # use ==/!= to compare str, bytes, and int literals
- 'F811,' # redefinition of unused name from line N
- 'F821,' # undefined name 'Foo'
- 'F822,' # undefined name name in __all__
- 'F823,' # local variable name … referenced before assignment
- 'F841,' # local variable 'foo' is assigned to but never used
- 'W191,' # indentation contains tabs
- 'W291,' # trailing whitespace
- 'W292,' # no newline at end of file
- 'W293,' # blank line contains whitespace
- 'W605,' # invalid escape sequence "x"
-)
-
def check_dependencies():
for dep in DEPS:
@@ -78,20 +37,6 @@ def check_dependencies():
def main():
check_dependencies()
- if len(sys.argv) > 1:
- flake8_files = sys.argv[1:]
- else:
- flake8_files = subprocess.check_output(FLAKE_FILES_ARGS).decode("utf-8").splitlines()
-
- flake8_args = ['flake8', '--ignore=B,C,E,F,I,N,W', f'--select={ENABLED}'] + flake8_files
- flake8_env = os.environ.copy()
- flake8_env["PYTHONWARNINGS"] = "ignore"
-
- try:
- subprocess.check_call(flake8_args, env=flake8_env)
- except subprocess.CalledProcessError:
- exit(1)
-
mypy_files = subprocess.check_output(MYPY_FILES_ARGS).decode("utf-8").splitlines()
mypy_args = ['mypy', '--show-error-codes'] + mypy_files
diff --git a/test/lint/test_runner/src/main.rs b/test/lint/test_runner/src/main.rs
index 8a1d329185..1cd3d9287b 100644
--- a/test/lint/test_runner/src/main.rs
+++ b/test/lint/test_runner/src/main.rs
@@ -187,10 +187,48 @@ fn lint_subtree() -> LintResult {
fn lint_py_lint() -> LintResult {
let bin_name = "ruff";
- let checks = ["B006", "B008"]
- .iter()
- .map(|c| format!("--select={}", c))
- .collect::<Vec<_>>();
+ let checks = format!(
+ "--select={}",
+ [
+ "B006", // mutable-argument-default
+ "B008", // function-call-in-default-argument
+ "E101", // indentation contains mixed spaces and tabs
+ "E401", // multiple imports on one line
+ "E402", // module level import not at top of file
+ "E701", // multiple statements on one line (colon)
+ "E702", // multiple statements on one line (semicolon)
+ "E703", // statement ends with a semicolon
+ "E711", // comparison to None should be 'if cond is None:'
+ "E714", // test for object identity should be "is not"
+ "E721", // do not compare types, use "isinstance()"
+ "E722", // do not use bare 'except'
+ "E742", // do not define classes named "l", "O", or "I"
+ "E743", // do not define functions named "l", "O", or "I"
+ "F401", // module imported but unused
+ "F402", // import module from line N shadowed by loop variable
+ "F403", // 'from foo_module import *' used; unable to detect undefined names
+ "F404", // future import(s) name after other statements
+ "F405", // foo_function may be undefined, or defined from star imports: bar_module
+ "F406", // "from module import *" only allowed at module level
+ "F407", // an undefined __future__ feature name was imported
+ "F601", // dictionary key name repeated with different values
+ "F602", // dictionary key variable name repeated with different values
+ "F621", // too many expressions in an assignment with star-unpacking
+ "F631", // assertion test is a tuple, which are always True
+ "F632", // use ==/!= to compare str, bytes, and int literals
+ "F811", // redefinition of unused name from line N
+ "F821", // undefined name 'Foo'
+ "F822", // undefined name name in __all__
+ "F823", // local variable name … referenced before assignment
+ "F841", // local variable 'foo' is assigned to but never used
+ "W191", // indentation contains tabs
+ "W291", // trailing whitespace
+ "W292", // no newline at end of file
+ "W293", // blank line contains whitespace
+ "W605", // invalid escape sequence "x"
+ ]
+ .join(",")
+ );
let files = check_output(
git()
.args(["ls-files", "--", "*.py"])
@@ -198,7 +236,7 @@ fn lint_py_lint() -> LintResult {
)?;
let mut cmd = Command::new(bin_name);
- cmd.arg("check").args(checks).args(files.lines());
+ cmd.args(["check", &checks]).args(files.lines());
match cmd.status() {
Ok(status) if status.success() => Ok(()),