pytorch/torch/fx
Sam Estep e3900d2ba5 Add lint for unqualified noqa (#56272)
Summary:
As this diff shows, currently there are a couple hundred instances of raw `noqa` in the codebase, which just ignore all errors on a given line. That isn't great, so this PR changes all existing instances of that antipattern to qualify the `noqa` with respect to a specific error code, and adds a lint to prevent more of this from happening in the future.

Interestingly, some of the examples the `noqa` lint catches are genuine attempts to qualify the `noqa` with a specific error code, such as these two:
```
test/jit/test_misc.py:27:            print(f"{hello + ' ' + test}, I'm a {test}") # noqa E999
test/jit/test_misc.py:28:            print(f"format blank") # noqa F541
```
However, those are still wrong because they are [missing a colon](https://flake8.pycqa.org/en/3.9.1/user/violations.html#in-line-ignoring-errors), which actually causes the error code to be completely ignored:

- If you change them to anything else, the warnings will still be suppressed.
- If you add the necessary colons then it is revealed that `E261` was also being suppressed, unintentionally:
  ```
  test/jit/test_misc.py:27:57: E261 at least two spaces before inline comment
  test/jit/test_misc.py:28:35: E261 at least two spaces before inline comment
  ```

I did try using [flake8-noqa](https://pypi.org/project/flake8-noqa/) instead of a custom `git grep` lint, but it didn't seem to work. This PR is definitely missing some of the functionality that flake8-noqa is supposed to provide, though, so if someone can figure out how to use it, we should do that instead.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/56272

Test Plan:
CI should pass on the tip of this PR, and we know that the lint works because the following CI run (before this PR was finished) failed:

- https://github.com/pytorch/pytorch/runs/2365189927

Reviewed By: janeyx99

Differential Revision: D27830127

Pulled By: samestep

fbshipit-source-id: d6dcf4f945ebd18cd76c46a07f3b408296864fcb
2021-04-19 13:16:18 -07:00
..
experimental [FX] Put tensor metadata into a NamedTuple in ShapeProp (#55930) 2021-04-13 22:21:50 -07:00
passes [FX] Make shape_prop handle targets with aggregate outputs (#56221) 2021-04-16 18:58:25 -07:00
__init__.py Enforce PEP263 for PyTorch python codebase (#55346) 2021-04-06 18:31:38 -07:00
__init__.pyi
graph.py Add lint for unqualified noqa (#56272) 2021-04-19 13:16:18 -07:00
graph_module.py Enforce PEP263 for PyTorch python codebase (#55346) 2021-04-06 18:31:38 -07:00
immutable_collections.py
interpreter.py
node.py [FX] Add a metadata dict to Node and switch shapeprop to use that (#54926) 2021-03-31 14:36:54 -07:00
operator_schemas.py
OVERVIEW.md Disallow non-breaking spaces (#55465) 2021-04-08 15:44:44 -07:00
proxy.py Fix ScriptMethod dispatch on __torch_function__ (#56103) 2021-04-15 08:46:43 -07:00
subgraph_rewriter.py Improve placeholder matching in subgraph rewriter (#54958) 2021-03-30 11:40:33 -07:00
symbolic_trace.py Add lint for unqualified noqa (#56272) 2021-04-19 13:16:18 -07:00