pytorch/torch/csrc/jit
Sam Estep 5bcbbf5373 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
2021-03-30 13:09:52 -07:00
..
api Remove notion of "level" from Module::dump_to_str. (#52539) 2021-03-09 05:45:57 -08:00
backends Adds a bool is_available() method to the backend contract (#53068) 2021-03-10 00:24:16 -08:00
codegen [fuser] Support bfloat16 (#54571) 2021-03-25 15:59:15 -07:00
cuda Merge CUDA Streams and Events (#53902) 2021-03-26 14:19:39 -07:00
docs Fix errata (#49903) 2020-12-28 20:40:41 -08:00
frontend Merge CUDA Streams and Events (#53902) 2021-03-26 14:19:39 -07:00
ir Teach Python TS frontend to parse complex literals (#52881) 2021-03-24 08:12:17 -07:00
mobile [PyTorch][JIT] Less shared_ptr use in dictConstruct (#54110) 2021-03-22 18:31:27 -07:00
passes [special] Alias for special.expm1 and special.exp2 (#54670) 2021-03-30 10:03:13 -07:00
python Allow creating SugaredValue for a complex valued IValue and deserialization logic for "infj" and "nanj" global constants (#54328) 2021-03-29 14:46:29 -07:00
runtime [pyper] out variant of sigrid_transforms_torch_bind + ListUnpack (#54761) 2021-03-30 10:54:44 -07:00
serialization Lint trailing newlines (#54737) 2021-03-30 13:09:52 -07:00
tensorexpr [nnc] Add a default constructor for Placeholder 2021-03-29 15:11:21 -07:00
testing [codemod][fbcode/caffe2] Apply clang-format update fixes 2021-01-09 14:37:36 -08:00
jit_log.cpp [jit] Speed up saving in case of many classes (#44589) 2020-09-15 15:10:45 -07:00
jit_log.h added macros in jit logging to check whether loggings are enabled; replaced similar checks in LLVM codegen with such macros (#49121) 2020-12-21 13:01:22 -08:00
jit_opt_limit.cpp Implement optimization bisect (#49031) 2021-01-11 12:25:28 -08:00
jit_opt_limit.h Update JIT_OPT macro for easier use (#50602) 2021-01-20 11:15:20 -08:00
OVERVIEW.md Update JIT_OPT macro for easier use (#50602) 2021-01-20 11:15:20 -08:00
README.md [jit] add top-level readme to csrc/jit (#33916) 2020-02-27 19:21:05 -08:00
resource_guard.h

PyTorch JIT

This folder contains (most of) the C++ code for the PyTorch JIT, a language and compiler stack for executing PyTorch models portably and efficiently. To learn more about the JIT from a user perspective, please consult our reference documentation and tutorials.

A brief summary of the source tree:

  • OVERVIEW.md: High-level technical overview of the JIT.
  • frontend/: Taking PyTorch modules in Python and translating them into the JIT IR.
  • ir/: Core IR abstractions.
  • runtime/: Interpreter, graph execution, and JIT operators.
  • codegen/: Generating efficient, hardware-specific code for JIT subgraphs.
  • serialization/: Saving and loading modules.
  • api/: Any user-facing C++ or Python interfaces.
  • python/: Binding stuff into Python or accessing information from the Python environment.
  • testing/: Utilities and helpers for testing.
  • mobile/: Mobile-specific implementations of runtime components.
  • passes/: IR-to-IR passes, generally for optimization and lowering.
  • generated/: This folder is generated by the PyTorch build, and contains bindings for native PyTorch operators into the JIT.

Refer to each folder for more in-depth documentation.

Other relevant parts of the codebase not contained here:

  • aten/src/ATen/core: contains JIT code re-used by other elements of the runtime system (eager, mobile, etc.)