Added test, simplified temporary file usage

Signed-off-by: Fabian Haase <[email protected]>

Author: FHaase

scripts/tests/test_validate_docstrings.py

@@ -587,6 +587,29 @@ def prefix_pandas(self):
         pass
 
 
+class BadExamples(object):
+
+    def doctest(self):
+        """
+        Return whether each value contains `pat`.
+
+        Examples
+        --------
+        >>> import pandas as pd
+        >>> df = pd.DataFrame(np.ones((3, 3)),
+        ...                   columns=('a', 'b', 'c'))
+        >>> df.all(1)
+        0    True
+        1    True
+        2    True
+        dtype: bool
+
+        >>> df.all(bool_only=True)
+        Series([], dtype: bool)
+        """
+        pass
+
+
 class TestValidator(object):
 
     def _import_path(self, klass=None, func=None):
@@ -706,10 +729,13 @@ def test_bad_generic_functions(self, func):
         # See Also tests
         ('BadSeeAlso', 'prefix_pandas',
          ('pandas.Series.rename in `See Also` section '
-          'does not need `pandas` prefix',))
+          'does not need `pandas` prefix',)),
+        # Examples tests
+        ('BadExamples', 'doctest',
+         ('1 F821 undefined name \'np\'',))
     ])
     def test_bad_examples(self, capsys, klass, func, msgs):
-        result = validate_one(self._import_path(klass=klass, func=func))  # noqa:F821
+        result = validate_one(self._import_path(klass=klass, func=func))
         for msg in msgs:
             assert msg in ' '.join(result['errors'])
 

scripts/validate_docstrings.py

@@ -24,6 +24,7 @@
 import inspect
 import importlib
 import doctest
+import tempfile
 from contextlib import contextmanager
 
 from flake8.api import legacy as flake8
@@ -44,6 +45,7 @@
 from numpydoc.docscrape import NumpyDocString
 from pandas.io.formats.printing import pprint_thing
 
+
 PRIVATE_CLASSES = ['NDFrame', 'IndexOpsMixin']
 DIRECTIVES = ['versionadded', 'versionchanged', 'deprecated']
 
@@ -336,9 +338,9 @@ def parameter_mismatches(self):
 
     @property
     def pep8_violations(self):
-        with self._file_representation() as filename:
+        with self._file_representation() as file:
             style_guide = flake8.get_style_guide(doctests=True)
-            report = style_guide.input_file(filename=filename)
+            report = style_guide.input_file(filename=file.name)
             return report.get_statistics('')
 
     @contextmanager
@@ -347,29 +349,21 @@ def _file_representation(self):
         Temporarily creates file with current function inside.
         The signature and body are **not** included.
 
-        :returns filename of tmp file
+        :returns file
         """
         create_function = 'def {name}():\n' \
                           '    """{doc}"""\n' \
                           '    pass\n'
 
-        tmp_dir = os.path.join(BASE_PATH, 'build', 'validate_docstring')
-        os.makedirs(tmp_dir, exist_ok=True)
-
-        filename = os.path.join(tmp_dir, self.name + '.py')
-        with open(filename, 'w') as f:
-            name = self.name.split('.')[-1]
-            lines = self.clean_doc.split("\n")
-            indented_lines = [(' ' * 4) + line if line else ''
-                              for line in lines[1:]]
-            doc = '\n'.join([lines[0], *indented_lines])
-
-            f.write(create_function.format(name=name, doc=doc))
-        try:
-            yield filename
-        finally:
-            os.remove(filename)
-            os.rmdir(tmp_dir)
+        name = self.name.split('.')[-1]
+        lines = self.clean_doc.split("\n")
+        indented_lines = [(' ' * 4) + line if line else ''
+                          for line in lines[1:]]
+        doc = '\n'.join([lines[0], *indented_lines])
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.py') as file:
+            file.write(create_function.format(name=name, doc=doc))
+            file.flush()
+            yield file
 
     @property
     def correct_parameters(self):
@@ -534,6 +528,7 @@ def validate_one(func_name):
     if pep8_errs:
         errs.append('Errors in doctest sections')
         for pep8_err in pep8_errs:
+            print(pep8_err)
             errs.append('\t{}'.format(pep8_err))
 
     if doc.is_function_or_method:

setup.cfg

@@ -28,8 +28,6 @@ exclude =
     doc/temp/*.py,
     .eggs/*.py,
     versioneer.py
-    .tox
-    .git
 
 doctests = True
 #TODO fix doctests
@@ -45,12 +43,6 @@ exclude_from_doctest =
     ./pandas/tseries
     ./pandas/util
 
-[flake8-rst]
-ignore =
-    F821,  # undefined name
-    W391,  # blank line at end of file [Seems to be a bug (v0.4.1)]
-
-
 [yapf]
 based_on_style = pep8
 split_before_named_assigns = false