Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix undefined names #8425

Merged
merged 4 commits into from Aug 18, 2021
Merged

Fix undefined names #8425

merged 4 commits into from Aug 18, 2021

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Aug 18, 2021

Fixes: 72e2ae5

flake8 detected undefined names in Python code.

The readthedocs/search/tests/test_views.py test is marked xfail which is why we have not seen this issue.

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

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

  • 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 will halt/crash the script on the user.

tox.ini Outdated Show resolved Hide resolved
@cclauss cclauss changed the title Add flake8 undefined name testing to tox Fix undefined names Aug 18, 2021
@stsewd stsewd merged commit 67484c7 into readthedocs:master Aug 18, 2021
@cclauss cclauss deleted the Add-flake8-to-tox branch August 18, 2021 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants