pytorch/tools/vscode_settings.py
Xuehai Pan 0314c4c101 [BE][Easy] use pathlib.Path instead of dirname / ".." / pardir (#129374)
Changes by apply order:

1. Replace all `".."` and `os.pardir` usage with `os.path.dirname(...)`.
2. Replace nested `os.path.dirname(os.path.dirname(...))` call with `str(Path(...).parent.parent)`.
3. Reorder `.absolute()` ~/ `.resolve()`~ and `.parent`: always resolve the path first.

    `.parent{...}.absolute()` -> `.absolute().parent{...}`

4. Replace chained `.parent x N` with `.parents[${N - 1}]`: the code is easier to read (see 5.)

    `.parent.parent.parent.parent` -> `.parents[3]`

5. ~Replace `.parents[${N - 1}]` with `.parents[${N} - 1]`: the code is easier to read and does not introduce any runtime overhead.~

    ~`.parents[3]` -> `.parents[4 - 1]`~

6. ~Replace `.parents[2 - 1]` with `.parent.parent`: because the code is shorter and easier to read.~

Pull Request resolved: https://github.com/pytorch/pytorch/pull/129374
Approved by: https://github.com/justinchuby, https://github.com/malfet
2024-06-25 08:28:38 +00:00

67 lines
1.8 KiB
Python
Executable File

#!/usr/bin/env python3
from pathlib import Path
try:
# VS Code settings allow comments and trailing commas, which are not valid JSON.
import json5 as json # type: ignore[import]
HAS_JSON5 = True
except ImportError:
import json # type: ignore[no-redef]
HAS_JSON5 = False
ROOT_FOLDER = Path(__file__).absolute().parent.parent
VSCODE_FOLDER = ROOT_FOLDER / ".vscode"
RECOMMENDED_SETTINGS = VSCODE_FOLDER / "settings_recommended.json"
SETTINGS = VSCODE_FOLDER / "settings.json"
# settings can be nested, so we need to recursively update the settings.
def deep_update(d: dict, u: dict) -> dict: # type: ignore[type-arg]
for k, v in u.items():
if isinstance(v, dict):
d[k] = deep_update(d.get(k, {}), v)
elif isinstance(v, list):
d[k] = d.get(k, []) + v
else:
d[k] = v
return d
def main() -> None:
recommended_settings = json.loads(RECOMMENDED_SETTINGS.read_text())
try:
current_settings_text = SETTINGS.read_text()
except FileNotFoundError:
current_settings_text = "{}"
try:
current_settings = json.loads(current_settings_text)
except ValueError as ex: # json.JSONDecodeError is a subclass of ValueError
if HAS_JSON5:
raise SystemExit("Failed to parse .vscode/settings.json.") from ex
raise SystemExit(
"Failed to parse .vscode/settings.json. "
"Maybe it contains comments or trailing commas. "
"Try `pip install json5` to install an extended JSON parser."
) from ex
settings = deep_update(current_settings, recommended_settings)
SETTINGS.write_text(
json.dumps(
settings,
indent=4,
)
+ "\n", # add a trailing newline
encoding="utf-8",
)
if __name__ == "__main__":
main()