Skip to content

MAINT Improve method detection in numpydoc validation script #15532

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
Nov 16, 2019
Merged

MAINT Improve method detection in numpydoc validation script #15532

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dfc182
MAINT Improve method dectection in test_docstrings.py
rth Nov 3, 2019
23c87c9
Fix for properties
rth Nov 4, 2019
bde9750
Improve comment
rth Nov 4, 2019
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
36 changes: 26 additions & 10 deletions maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,22 @@

def get_all_methods():
estimators = all_estimators()
for name, estimator in estimators:
for name, Estimator in estimators:
if name.startswith("_"):
# skip private classes
continue
methods = [el for el in dir(estimator) if not el.startswith("_")]
methods = []
for name in dir(Estimator):
if name.startswith("_"):
continue
method_obj = getattr(Estimator, name)
if (hasattr(method_obj, '__call__')
or isinstance(method_obj, property)):
methods.append(name)
methods.append(None)

for method in sorted(methods, key=lambda x: str(x)):
yield estimator, method
yield Estimator, method


def filter_errors(errors, method):
Expand Down Expand Up @@ -102,15 +109,24 @@ def repr_errors(res, estimator=None, method: Optional[str] = None) -> str:
raise NotImplementedError

if estimator is not None:
obj_signature = signature(getattr(estimator, method))
obj = getattr(estimator, method)
try:
obj_signature = signature(obj)
except TypeError:
# In particular we can't parse the signature of properties
obj_signature = (
"\nParsing of the method signature failed, "
"possibly because this is a property."
)

obj_name = estimator.__name__ + "." + method
else:
obj_signature = ""
obj_name = method

msg = "\n\n" + "\n\n".join(
[
res["file"],
str(res["file"]),
obj_name + str(obj_signature),
res["docstring"],
"# Errors",
Expand All @@ -123,10 +139,10 @@ def repr_errors(res, estimator=None, method: Optional[str] = None) -> str:
return msg


@pytest.mark.parametrize("estimator, method", get_all_methods())
def test_docstring(estimator, method, request):
base_import_path = estimator.__module__
import_path = [base_import_path, estimator.__name__]
@pytest.mark.parametrize("Estimator, method", get_all_methods())
def test_docstring(Estimator, method, request):
base_import_path = Estimator.__module__
import_path = [base_import_path, Estimator.__name__]
if method is not None:
import_path.append(method)

Expand All @@ -144,7 +160,7 @@ def test_docstring(estimator, method, request):
res["errors"] = list(filter_errors(res["errors"], method))

if res["errors"]:
msg = repr_errors(res, estimator, method)
msg = repr_errors(res, Estimator, method)

raise ValueError(msg)

Expand Down