-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
CI: Disallow bare pytest raise #30737
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
#!/usr/bin/env python | ||
""" | ||
GH #23922 | ||
|
||
Check for the use of bare pytest raise. | ||
|
||
For example: | ||
|
||
>>> with pytest.raise(ValueError): | ||
... # Some code that raises ValueError | ||
|
||
Instead of: | ||
|
||
>>> with pytest.raise(ValueError, match="foo"): | ||
... # Some code that raises ValueError | ||
""" | ||
|
||
import argparse | ||
import os | ||
import sys | ||
import token | ||
import tokenize | ||
from typing import Generator, List, Tuple | ||
|
||
FILE_EXTENSIONS_TO_CHECK = ".py" | ||
|
||
|
||
def main(source_path: str, output_format: str) -> bool: | ||
""" | ||
Main entry point of the script. | ||
|
||
Parameters | ||
---------- | ||
source_path : str | ||
Source path representing path to a file/directory. | ||
output_format : str | ||
Output format of the script. | ||
|
||
Returns | ||
------- | ||
bool | ||
True if found any bare pytest raises. | ||
|
||
Raises | ||
------ | ||
ValueError | ||
If the `source_path` is not pointing to existing file/directory. | ||
""" | ||
if not os.path.exists(source_path): | ||
raise ValueError( | ||
"Please enter a valid path, pointing to a valid file/directory." | ||
) | ||
|
||
is_failed: bool = False | ||
|
||
msg = "Bare pytests raise have been found." | ||
|
||
if os.path.isfile(source_path): | ||
for source_path, line_number in bare_pytest_raise(source_path): | ||
is_failed = True | ||
print( | ||
output_format.format( | ||
source_path=source_path, line_number=line_number, msg=msg | ||
) | ||
) | ||
|
||
for subdir, _, files in os.walk(source_path): | ||
for file_name in files: | ||
if any( | ||
file_name.endswith(extension) for extension in FILE_EXTENSIONS_TO_CHECK | ||
): | ||
for source_path, line_number in bare_pytest_raise( | ||
os.path.join(subdir, file_name) | ||
): | ||
is_failed = True | ||
print( | ||
output_format.format( | ||
source_path=source_path, line_number=line_number, msg=msg | ||
) | ||
) | ||
return is_failed | ||
|
||
|
||
def bare_pytest_raise(source_path: str) -> Generator[Tuple[str, int], None, None]: | ||
""" | ||
Yielding the files and line numbers of files with bare pytest raise. | ||
|
||
Parameters | ||
---------- | ||
source_path : str | ||
File path pointing to a single file. | ||
|
||
Yields | ||
------ | ||
source_path : str | ||
Source file path. | ||
line_number : int | ||
Line number of bare pytests raise. | ||
""" | ||
with open(source_path, "r") as file_name: | ||
tokens: List = list(tokenize.generate_tokens(file_name.readline)) | ||
|
||
for counter, current_token in enumerate(tokens, start=1): | ||
if current_token[0] == token.NAME and current_token[1] == "raises": | ||
for next_token in tokens[counter:]: | ||
if next_token[0] == token.NAME and next_token[1] == "match": | ||
break | ||
if next_token[0] == token.NEWLINE: | ||
yield source_path, current_token[2][0] | ||
break | ||
|
||
|
||
if __name__ == "__main__": | ||
parser = argparse.ArgumentParser( | ||
description="Validate there's no use of bare pytest raise" | ||
) | ||
|
||
parser.add_argument( | ||
"path", nargs="?", default=".", help="Source path of file/directory to check." | ||
) | ||
parser.add_argument( | ||
"--format", | ||
"-f", | ||
default="{source_path}:{line_number}:{msg}", | ||
help="Output format of the error message.", | ||
) | ||
|
||
args = parser.parse_args() | ||
|
||
sys.exit(main(source_path=args.path, output_format=args.format)) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think it would be nice to encapsulate most of the boiler plate in a common file used in the other validate_* scripts. can you do this as a pre-cursor PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is exactly what I was a about to ask, if I should do so.
The only question I have is how the script should be activated?
for example like this:
or