-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Fix for warning test arguments with default values #13044
Open
huangbenny
wants to merge
3
commits into
pytest-dev:main
Choose a base branch
from
huangbenny:warning_test_args
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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 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 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 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 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,52 @@ | ||
from _pytest.pytester import Pytester | ||
|
||
def test_no_default_argument(pytester: Pytester) -> None: | ||
pytester.makepyfile( | ||
""" | ||
def test_with_default_param(param): | ||
assert param == 42 | ||
""" | ||
) | ||
result = pytester.runpytest() | ||
result.stdout.fnmatch_lines([ | ||
"*fixture 'param' not found*" | ||
]) | ||
|
||
|
||
def test_default_argument_warning(pytester: Pytester) -> None: | ||
pytester.makepyfile( | ||
""" | ||
def test_with_default_param(param=42): | ||
assert param == 42 | ||
""" | ||
) | ||
result = pytester.runpytest() | ||
result.stdout.fnmatch_lines([ | ||
"*PytestDefaultArgumentWarning: Test function 'test_with_default_param' has a default argument 'param=42'.*" | ||
]) | ||
|
||
|
||
def test_no_warning_for_no_default_param(pytester: Pytester) -> None: | ||
pytester.makepyfile( | ||
""" | ||
def test_without_default_param(param): | ||
assert param is None | ||
""" | ||
) | ||
result = pytester.runpytest() | ||
assert "PytestDefaultArgumentWarning" not in result.stdout.str() | ||
|
||
|
||
def test_warning_for_multiple_default_params(pytester: Pytester) -> None: | ||
pytester.makepyfile( | ||
""" | ||
def test_with_multiple_defaults(param1=42, param2="default"): | ||
assert param1 == 42 | ||
assert param2 == "default" | ||
""" | ||
) | ||
result = pytester.runpytest() | ||
result.stdout.fnmatch_lines([ | ||
"*PytestDefaultArgumentWarning: Test function 'test_with_multiple_defaults' has a default argument 'param1=42'.*", | ||
"*PytestDefaultArgumentWarning: Test function 'test_with_multiple_defaults' has a default argument 'param2=default'.*" | ||
]) |
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'm not entirely convinced this is the right place for this. I wonder if something like
FixtureManager.getfixtureinfo
(where we already take care of reading the function's arguments) would make more sense maybe?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.
In my most recent commit, I updated the warning checks to be in the getfixtureinfo. After looking into the function more, I also thought that it would be better to include the checks in that function.