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

scripts/tests/test_validate_docstrings.py

@@ -218,6 +218,18 @@ def mode(self, axis, numeric_only):
         """
         pass
 
+    def good_import(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
@@ -502,6 +514,33 @@ def no_punctuation(self):
         return "Hello world!"
 
 
+class BadExamples(object):
+
+    def numpy_import(self):
+        """
+        Provide example with numpy import.
+
+        Examples
+        --------
+        This example does not import pandas.
+        >>> import numpy as np
+        >>> import datetime
+        """
+        pass
+
+    def pandas_import(self):
+        """
+        Provide example with pandas import.
+
+        Examples
+        --------
+        This example does not import numpy.
+        >>> import pandas as pd
+        >>> import pickle
+        """
+        pass
+
+
 class TestValidator(object):
 
     def _import_path(self, klass=None, func=None):
@@ -600,7 +639,12 @@ def test_bad_generic_functions(self, func):
         pytest.param('BadReturns', 'no_description', ('foo',),
                      marks=pytest.mark.xfail),
         pytest.param('BadReturns', 'no_punctuation', ('foo',),
-                     marks=pytest.mark.xfail)
+                     marks=pytest.mark.xfail),
+        # Examples tests
+        ('BadExamples', 'numpy_import',
+         ('Examples should not have `import numpy` ',)),
+        ('BadExamples', 'pandas_import',
+         ('Examples should not have `import pandas` ',))
     ])
     def test_bad_examples(self, capsys, klass, func, msgs):
         result = validate_one(self._import_path(klass=klass, func=func))  # noqa:F821

scripts/validate_docstrings.py

@@ -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)
+        codes = [line.source for line in codes]
+        return ' '.join(codes)
+
 
 def validate_one(func_name):
     """
@@ -512,6 +518,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` ')
 
     return {'type': doc.type,
             'docstring': doc.clean_doc,