Skip to content

CI: Stop the build if there are Python syntax errors or undefined names

Christian Clauss requested to merge cclauss/vtk:cclauss-master-patch-82290 into master

https://flake8.pycqa.org/en/latest/user/error-codes.html

On the flake8 test selection, this PR focuses on runtime safety and program correctness. This PR does not focus on "style violations" (the majority of flake8 error codes that psf/black can autocorrect).

  • E9 tests are about Python syntax errors usually raised because flake8 can not build an Abstract Syntax Tree (AST). Often these issues are a sign of unused code or code that has not been ported to Python 3. These would be compile-time errors in a compiled language but in a dynamic language like Python they result in the script halting/crashing on the user.
  • F63 tests are usually about the confusion between identity and equality in Python. Use ==/!= to compare str, bytes, and int literals is the classic case. These are areas where a == b is True but a is b is False (or vice versa). Python >= 3.8 will raise SyntaxWarnings on these instances.
  • F7 tests logic errors and syntax errors in type hints
  • F82 tests are almost always undefined names which are usually a sign of a typo, missing imports, or code that has not been ported to Python 3. These also would be compile-time errors in a compiled language but in Python a NameError is raised which has the potential to halt/crash the script on the user.

Merge request reports