Files
pytorch/tools/test/linter_test_case.py
Tom Ritchford d90f9e9a34 [inductor] Fix issue with set_linter, improve linter framework (#144620)
### `set_linter` only

* Fix gnarly [bug](dbed747aae/tools/test/set_linter_testdata/python_code.py.txt.python (L42)) which would have garbled Python files involving sets contained in sets.
* Better handling of new Python3.12 token types

### Both linters.

* Recover from and report on unparseable Python files
* Remove `ParseError.check()` (it made it harder to read the code)
* FileLinter is now generic on `PythonFile`

### Notes

As I started working on new docstring features, I found a nasty bug and an edge case bug in set linter, and realized both the linters crash when there is a badly-formed Python file in the repo.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/144620
Approved by: https://github.com/amjames, https://github.com/jansel
2025-03-13 09:49:40 +00:00

57 lines
2.1 KiB
Python

# mypy: ignore-errors
import io
import json
import os
from pathlib import Path
from unittest import mock, TestCase
class LinterTestCase(TestCase):
LinterClass = None
rewrite_expected = "REWRITE_EXPECTED" in os.environ
def assertExpected(self, path: Path, actual: str, suffix: str) -> None:
expected_file = Path(f"{path}.{suffix}")
if not self.rewrite_expected and expected_file.exists():
self.assertEqual(expected_file.read_text(), actual)
else:
expected_file.write_text(actual)
def replace(self, s: str):
linter = self.LinterClass("dummy")
pf = self.LinterClass.make_file(contents=s)
replacement, _results = linter._replace(pf)
return replacement
@mock.patch("sys.stdout", new_callable=io.StringIO)
def lint_test(self, path, args, mock_stdout):
return self._lint_test(path, args, mock_stdout)[:2]
@mock.patch("sys.stdout", new_callable=io.StringIO)
def lint_fix_test(self, path, args, mock_stdout):
rep, results, linter = self._lint_test(path, args, mock_stdout)
r = results[-1]
path = linter.paths[0]
self.assertEqual(r.original, path.read_text())
self.assertEqual(rep, r.replacement)
self.assertExpected(path, r.replacement, "python")
return r
def _lint_test(self, path, args, mock_stdout):
with self.subTest("from-command-line"):
linter = self.LinterClass([str(path), *args])
linter.lint_all()
self.assertExpected(path, mock_stdout.getvalue(), "lintrunner")
replacement, results = "(no replacement)", "(no results)"
with self.subTest("from-lintrunner"):
linter = self.LinterClass(["--lintrunner", str(path), *args])
pf = self.LinterClass.make_file(path)
replacement, results = linter._replace(pf)
actual = [json.loads(d) for d in linter._display(pf, results)]
actual = json.dumps(actual, indent=2, sort_keys=True) + "\n"
self.assertExpected(path, actual, "json")
return replacement, results, linter