Skip to content

Added capture_stderr decorator to test_validate_docstrings #22543

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.

Sign up for GitHub

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 3 commits into from
Sep 4, 2018
Merged

Added capture_stderr decorator to test_validate_docstrings #22543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43f7f7c
Added capture_stderr decorator
WillAyd Aug 30, 2018
49ea82d
Py27 compat
WillAyd Aug 30, 2018
bf3b929
Merge remote-tracking branch 'upstream/master' into capture-stdout
WillAyd Sep 3, 2018
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
2 changes: 1 addition & 1 deletion pandas/util/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ def capture_stderr(f):
AssertionError: assert 'foo\n' == 'bar\n'
"""

@wraps(f)
@compat.wraps(f)
Copy link
Member Author

@WillAyd WillAyd Aug 30, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like wraps wasn't preserving the signature in Py27 which would cause this to choke when combined with a parametrized function. Simply switched to the function from compat for now - providing as reference in case anyone runs into a similar issue in the future

def wrapper(*args, **kwargs):
try:
sys.stderr = StringIO()
Expand Down
6 changes: 6 additions & 0 deletions scripts/tests/test_validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import validate_docstrings
validate_one = validate_docstrings.validate_one

from pandas.util.testing import capture_stderr


class GoodDocStrings(object):
"""
Expand Down Expand Up @@ -518,21 +520,25 @@ def _import_path(self, klass=None, func=None):

return base_path

@capture_stderr
def test_good_class(self):
assert validate_one(self._import_path(
klass='GoodDocStrings')) == 0

@capture_stderr
@pytest.mark.parametrize("func", [
'plot', 'sample', 'random_letters', 'sample_values', 'head', 'head1',
'contains', 'mode'])
def test_good_functions(self, func):
assert validate_one(self._import_path(
klass='GoodDocStrings', func=func)) == 0

@capture_stderr
def test_bad_class(self):
assert validate_one(self._import_path(
klass='BadGenericDocStrings')) > 0

@capture_stderr
@pytest.mark.parametrize("func", [
'func', 'astype', 'astype1', 'astype2', 'astype3', 'plot', 'method'])
def test_bad_generic_functions(self, func):
Expand Down