frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 12:54:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Update FileCheck doc (#135199)

Browse Source 
Pull Request resolved: https://github.com/pytorch/pytorch/pull/135199
Approved by: https://github.com/soulitzer
This commit is contained in:
penguin-wwy
2024-09-06 08:18:35 +00:00
committed by PyTorch MergeBot
parent 758d515d98
commit 217ba7b2ab
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
test/HowToWriteTestsUsingFileCheck.md
View File

@ -93,7 +93,7 @@ annotations from the example above one would write:
* `CHECK-COUNT-EXACTLY-<num>: <pattern>` * `CHECK-COUNT-EXACTLY-<num>: <pattern>`
Scans the input and succeeds when a line containing exactly `NUM` entries of Scans the input and succeeds when a line containing exactly `NUM` entries of
`PATTERN` is found. `PATTERN` is found.
* `CHECK-DAG: pattern` * `CHECK-DAG: <pattern>`
Works similar to the usual `CHECK` pragma, but also matches if there exists a Works similar to the usual `CHECK` pragma, but also matches if there exists a
way to reorder the CHECK-DAG pragmas to satisfy all patterns. way to reorder the CHECK-DAG pragmas to satisfy all patterns.
For example the following pattern: For example the following pattern:
@ -110,3 +110,18 @@ annotations from the example above one would write:
bar bar
end end
``` ```
* `CHECK-SOURCE-HIGHLIGHTED: <pattern>`
Check for highlighted source ranges. This is useful when writing tests regarding generated error messages that require source code highlighting.
For example the following pattern:
```
# CHECK-SOURCE-HIGHLIGHTED: raise Exception("raised exception
```
would match the following input:
```
def method_that_raises() -> torch.Tensor:
raise Exception("raised exception") # noqa: TRY002
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ <--- HERE
builtins.Exception: raised exception
```
* `CHECK-REGEX: <pattern>`
Scans the input until `PATTERN` is matched, accepts RE syntax for std::regex.