mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
e5179e960e
Summary:
This is a second attempt at https://github.com/pytorch/pytorch/issues/51214. It should achieve the same goals with (as far as I can tell) no disadvantages, but the advantages are a bit less pronounced than in the more dictatorial approach that https://github.com/pytorch/pytorch/issues/51214 took:
- Unfortunately, I was unable to figure out how to include [the `mypy` configuration given in the docstring of `tools.mypy_wrapper.main`](7115a4b870/tools/mypy_wrapper.py (L81-L89)), because as walterddr pointed out, `"${env:HOME}/miniconda3/envs/pytorch/bin/python"` is not guaranteed to be correct on everyone's machine:
```json
{
"python.linting.enabled": true,
"python.linting.mypyEnabled": true,
"python.linting.mypyPath": "${env:HOME}/miniconda3/envs/pytorch/bin/python",
"python.linting.mypyArgs": [
"${workspaceFolder}/tools/mypy_wrapper.py"
]
}
```
Importantly, this does not work:
```json
"python.linting.mypyPath": "${workspaceFolder}/tools/mypy_wrapper.py"
```
This is because VS Code does not run the given `mypy` command inside of the user's specified virtual environment, so for instance, on my system, setting the `mypy` command to directly call `tools/mypy_wrapper.py` results in using `mypy 0.782` instead of the correct `mypy 0.812`.
Sadly, [this](https://code.visualstudio.com/docs/editor/variables-reference#_configuration-variables) does not work either, although I'm not sure why:
```json
{
"python.linting.mypyPath": "${config:python.pythonPath}",
"python.linting.mypyArgs": [
"${workspaceFolder}/tools/mypy_wrapper.py"
]
}
```
- As a result, `git clean -fdx; tools/vscode_settings.py` still results in some loss of useful configuration.
One other thing to note: as `.vscode/settings_recommended.json` shows, there are some configuration sections that only take effect within the context of a `"[language]"`, so currently, if a dev already has one of those settings, it would be entirely overwritten by `tools/vscode_settings.py` rather than a graceful merge. This could probably be fixed by using a deep merge instead of the current shallow merge strategy.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/57671
Test Plan:
If you want, you can typecheck the small script added by this PR (no output is expected):
```sh
tools/mypy_wrapper.py $PWD/tools/vscode_settings.py
```
You can also try running it to update your own VS Code workspace settings:
```sh
tools/vscode_settings.py
```
This should have minimal impact on your existing `tools/settings.json` file other than enabling the few explicitly recommended settings (e.g. it should not reorder or remove any of your existing settings).
Reviewed By: malfet
Differential Revision: D28230390
Pulled By: samestep
fbshipit-source-id: 53a7907229e5807c77531cae4f9ab9d469fd7684
85 lines
2.5 KiB
INI
85 lines
2.5 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_error_codes = 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,
|
|
tools/actions_local_runner.py,
|
|
tools/autograd/*.py,
|
|
tools/clang_tidy.py,
|
|
tools/codegen,
|
|
tools/extract_scripts.py,
|
|
tools/mypy_wrapper.py,
|
|
tools/print_test_stats.py,
|
|
tools/pyi,
|
|
tools/stats_utils,
|
|
tools/test_history.py,
|
|
tools/test/test_actions_local_runner.py,
|
|
tools/test/test_extract_scripts.py,
|
|
tools/test/test_mypy_wrapper.py,
|
|
tools/test/test_test_history.py,
|
|
tools/test/test_trailing_newlines.py,
|
|
tools/test/test_translate_annotations.py,
|
|
tools/trailing_newlines.py,
|
|
tools/translate_annotations.py,
|
|
tools/vscode_settings.py,
|
|
torch/testing/_internal/framework_utils.py,
|
|
torch/utils/_pytree.py,
|
|
torch/utils/benchmark/utils/common.py,
|
|
torch/utils/benchmark/utils/timer.py,
|
|
torch/utils/benchmark/utils/valgrind_wrapper
|
|
|
|
# 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
|