Skip to content

REF: "bare_pytest_raises" to use the ast module #32932

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

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions scripts/validate_unwanted_patterns.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"""

import argparse
import ast
import os
import sys
import token
Expand Down Expand Up @@ -83,23 +84,34 @@ def bare_pytest_raises(file_obj: IO[str]) -> Iterable[Tuple[int, str]]:
-----
GH #23922
"""
tokens: List = list(tokenize.generate_tokens(file_obj.readline))
contents = file_obj.read()
tree = ast.parse(contents)

for node in ast.walk(tree):
if not isinstance(node, ast.Call):
continue

for counter, current_token in enumerate(tokens, start=1):
if not (current_token.type == token.NAME and current_token.string == "raises"):
try:
if not (node.func.value.id == "pytest" and node.func.attr == "raises"):
continue
except AttributeError:
continue
for next_token in tokens[counter:]:
if next_token.type == token.NAME and next_token.string == "match":
break
# token.NEWLINE refers to the end of a logical line
# unlike token.NL or "\n" which represents a newline
if next_token.type == token.NEWLINE:

if not node.keywords:
yield (
node.lineno,
"Bare pytests raise have been found. "
"Please pass in the argument 'match' as well the exception.",
)
else:
# Means that there are arguments that are being passed in,
# now we validate that `match` is one of the passed in arguments
if not any(keyword.arg == "match" for keyword in node.keywords):
yield (
current_token.start[0],
node.lineno,
"Bare pytests raise have been found. "
"Please pass in the argument 'match' as well the exception.",
)
break


def strings_to_concatenate(file_obj: IO[str]) -> Iterable[Tuple[int, str]]:
Expand Down