mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 00:20:18 +01:00
5bcbbf5373
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
76 lines
2.2 KiB
INI
76 lines
2.2 KiB
INI
# This is the PyTorch mypy-strict.ini file (note: don't change this line! -
|
|
# test_run_mypy in test/test_type_hints.py uses this string)
|
|
|
|
# Unlike mypy.ini, it enforces very strict typing rules. The intention is for
|
|
# this config file to be used to ENFORCE that people are using mypy on codegen
|
|
# files.
|
|
|
|
# For now, only code_template.py and benchmark utils Timer are covered this way
|
|
|
|
[mypy]
|
|
python_version = 3.6
|
|
plugins = mypy_plugins/check_mypy_version.py
|
|
|
|
cache_dir = .mypy_cache/strict
|
|
strict_optional = True
|
|
show_column_numbers = True
|
|
warn_no_return = True
|
|
disallow_any_unimported = True
|
|
|
|
# Across versions of mypy, the flags toggled by --strict vary. To ensure
|
|
# we have reproducible type check, we instead manually specify the flags
|
|
warn_unused_configs = True
|
|
disallow_any_generics = True
|
|
disallow_subclassing_any = True
|
|
disallow_untyped_calls = True
|
|
disallow_untyped_defs = True
|
|
disallow_incomplete_defs = True
|
|
check_untyped_defs = True
|
|
disallow_untyped_decorators = True
|
|
no_implicit_optional = True
|
|
warn_redundant_casts = True
|
|
warn_unused_ignores = True
|
|
warn_return_any = True
|
|
implicit_reexport = False
|
|
strict_equality = True
|
|
|
|
files =
|
|
.github/scripts/generate_binary_build_matrix.py,
|
|
benchmarks/instruction_counts/*.py,
|
|
benchmarks/instruction_counts/*/*.py,
|
|
tools/autograd/*.py,
|
|
tools/codegen/gen.py,
|
|
tools/mypy_wrapper.py,
|
|
tools/print_test_stats.py,
|
|
tools/pyi/*.py,
|
|
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,
|
|
torch/utils/benchmark/utils/valgrind_wrapper/*.py,
|
|
torch/utils/_pytree.py
|
|
|
|
# Specifically enable imports of benchmark utils. As more of `torch` becomes
|
|
# strict compliant, those modules can be enabled as well.
|
|
[mypy-torch.utils.benchmark.utils.*]
|
|
follow_imports = normal
|
|
|
|
# Don't follow imports as much of `torch` is not strict compliant.
|
|
[mypy-torch]
|
|
follow_imports = skip
|
|
|
|
[mypy-torch.*]
|
|
follow_imports = skip
|
|
|
|
# Missing stubs.
|
|
|
|
[mypy-numpy]
|
|
ignore_missing_imports = True
|
|
|
|
[mypy-mypy.*]
|
|
ignore_missing_imports = True
|