Skip to content

DOC: Validate in docstrings that numpy and pandas are not imported #23161

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 13 commits into from
Nov 4, 2018
Merged

DOC: Validate in docstrings that numpy and pandas are not imported #23161

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8655fdd
Check numpy and pandas in Examples
thoo Oct 15, 2018
5c071ec
Made changes as recommended
thoo Oct 16, 2018
5aff727
remove rstrip
thoo Oct 16, 2018
374c9ea
remove BadExamples class
thoo Oct 27, 2018
881b011
Merge remote-tracking branch 'repo_org/master' into check_np_pd_fromE…
thoo Oct 27, 2018
d824414
Merge remote-tracking branch 'repo_org/master' into check_np_pd_fromE…
thoo Oct 27, 2018
5d785c3
Merge remote-tracking branch 'repo_org/master' into check_np_pd_fromE…
thoo Nov 3, 2018
3e512ac
Change as recommended
thoo Nov 3, 2018
a2011b2
Change double to single quote
thoo Nov 3, 2018
0243b91
a few more changes
thoo Nov 3, 2018
d123b5c
a few more changes
thoo Nov 3, 2018
ec78655
changes in return
thoo Nov 3, 2018
ce37c8a
Retrigger Travis CI
thoo Nov 4, 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
17 changes: 17 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 @@ -218,6 +218,18 @@ def mode(self, axis, numeric_only):
"""
pass

def good_import(self):
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
def good_import(self):
def good_imports(self):

"""
Ensure import other than numpy and pandas are fine.

Examples
--------
This example does not import pandas or import numpy.
>>> import time
>>> import datetime
"""
pass


class BadGenericDocStrings(object):
"""Everything here has a bad docstring
Expand Down Expand Up @@ -700,6 +712,11 @@ def test_bad_generic_functions(self, func):
marks=pytest.mark.xfail),
pytest.param('BadReturns', 'no_punctuation', ('foo',),
marks=pytest.mark.xfail),
# Examples tests
('BadGenericDocStrings', 'method',
('Examples should not have `import numpy` ',)),
('BadGenericDocStrings', 'method',
('Examples should not have `import pandas` ',)),
# See Also tests
('BadSeeAlso', 'prefix_pandas',
('pandas.Series.rename in `See Also` section '
Expand Down
11 changes: 11 additions & 0 deletions scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,12 @@ def examples_errors(self):
error_msgs += f.getvalue()
return error_msgs

@property
def examples_codes(self):
codes = doctest.DocTestParser().get_examples(self.raw_doc)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
codes = doctest.DocTestParser().get_examples(self.raw_doc)
lines = doctest.DocTestParser().get_examples(self.raw_doc)

codes = [line.source for line in codes]
return ' '.join(codes)
Copy link
Member

Choose a reason for hiding this comment

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

Can you return a list with each line instead? We'll reuse this property to validate pep8 too, and returning a single string with all the code joined is not useful in that case.

Also, at least to me examples_codes is somehow misleading. Can you use examples_source_code instead?



def validate_one(func_name):
"""
Expand Down Expand Up @@ -531,6 +537,11 @@ def validate_one(func_name):
examples_errs = doc.examples_errors
if examples_errs:
errs.append('Examples do not pass tests')
examples_codes = doc.examples_codes
if 'import numpy' in examples_codes:
errs.append('Examples should not have `import numpy` ')
if 'import pandas' in examples_codes:
errs.append('Examples should not have `import pandas` ')
Copy link
Member

Choose a reason for hiding this comment

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

I think the error could be more descriptive. pandas does not need to be imported in the examples, as it's assumed to be already imported as pd. I think something like that provides more useful information to devs facing this error.


return {'type': doc.type,
'docstring': doc.clean_doc,
Expand Down