diff options
| author | Sam Estep <sestep@fb.com> | 2021-03-30 13:05:16 -0700 |
|---|---|---|
| committer | Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com> | 2021-03-30 13:09:52 -0700 |
| commit | 5bcbbf537327f6e8328289c25a3a453a2444d984 (patch) | |
| tree | fc9471f8b859d6813fff81b1da298a079b5759b8 /mypy-strict.ini | |
| parent | eafa2355828724dc1e955a351542bcaddfb16ac8 (diff) | |
| download | pytorch-5bcbbf537327f6e8328289c25a3a453a2444d984.tar.gz pytorch-5bcbbf537327f6e8328289c25a3a453a2444d984.tar.bz2 pytorch-5bcbbf537327f6e8328289c25a3a453a2444d984.zip | |
Lint trailing newlines (#54737)
Summary:
*Context:* https://github.com/pytorch/pytorch/issues/53406 added a lint for trailing whitespace at the ends of lines. However, in order to pass FB-internal lints, that PR also had to normalize the trailing newlines in four of the files it touched. This PR adds an OSS lint to normalize trailing newlines.
The changes to the following files (made in 54847d0adb9be71be4979cead3d9d4c02160e4cd) are the only manually-written parts of this PR:
- `.github/workflows/lint.yml`
- `mypy-strict.ini`
- `tools/README.md`
- `tools/test/test_trailing_newlines.py`
- `tools/trailing_newlines.py`
I would have liked to make this just a shell one-liner like the other three similar lints, but nothing I could find quite fit the bill. Specifically, all the answers I tried from the following Stack Overflow questions were far too slow (at least a minute and a half to run on this entire repository):
- [How to detect file ends in newline?](https://stackoverflow.com/q/38746)
- [How do I find files that do not end with a newline/linefeed?](https://stackoverflow.com/q/4631068)
- [How to list all files in the Git index without newline at end of file](https://stackoverflow.com/q/27624800)
- [Linux - check if there is an empty line at the end of a file [duplicate]](https://stackoverflow.com/q/34943632)
- [git ensure newline at end of each file](https://stackoverflow.com/q/57770972)
To avoid giving false positives during the few days after this PR is merged, we should probably only merge it after https://github.com/pytorch/pytorch/issues/54967.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/54737
Test Plan:
Running the shell script from the "Ensure correct trailing newlines" step in the `quick-checks` job of `.github/workflows/lint.yml` should print no output and exit in a fraction of a second with a status of 0. That was not the case prior to this PR, as shown by this failing GHA workflow run on an earlier draft of this PR:
- https://github.com/pytorch/pytorch/runs/2197446987?check_suite_focus=true
In contrast, this run (after correcting the trailing newlines in this PR) succeeded:
- https://github.com/pytorch/pytorch/pull/54737/checks?check_run_id=2197553241
To unit-test `tools/trailing_newlines.py` itself (this is run as part of our "Test tools" GitHub Actions workflow):
```
python tools/test/test_trailing_newlines.py
```
Reviewed By: malfet
Differential Revision: D27409736
Pulled By: samestep
fbshipit-source-id: 46f565227046b39f68349bbd5633105b2d2e9b19
Diffstat (limited to 'mypy-strict.ini')
| -rw-r--r-- | mypy-strict.ini | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/mypy-strict.ini b/mypy-strict.ini index 4608f7cf70..5a466e66c4 100644 --- a/mypy-strict.ini +++ b/mypy-strict.ini @@ -46,6 +46,8 @@ files = tools/stats_utils/*.py, tools/test_history.py, tools/test/test_test_history.py, + tools/test/test_trailing_newlines.py, + tools/trailing_newlines.py, torch/testing/_internal/framework_utils.py, torch/utils/benchmark/utils/common.py, torch/utils/benchmark/utils/timer.py, |