[skip ci] Integrate flake8 into validate_docstrings.py

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

Author: FHaase

scripts/validate_docstrings.py

@@ -24,6 +24,9 @@
 import inspect
 import importlib
 import doctest
+
+from flake8.api import legacy as flake8
+
 try:
     from io import StringIO
 except ImportError:
@@ -40,7 +43,6 @@
 from numpydoc.docscrape import NumpyDocString
 from pandas.io.formats.printing import pprint_thing
 
-
 PRIVATE_CLASSES = ['NDFrame', 'IndexOpsMixin']
 DIRECTIVES = ['versionadded', 'versionchanged', 'deprecated']
 
@@ -331,6 +333,12 @@ def parameter_mismatches(self):
 
         return errs
 
+    @property
+    def pep8_violations(self):
+        style_guide = flake8.get_style_guide(doctests=True)
+        report = style_guide.input_file(filename=self.source_file_name)
+        return report.get_statistics('')
+
     @property
     def correct_parameters(self):
         return not bool(self.parameter_mismatches)
@@ -446,7 +454,7 @@ def validate_one(func_name):
         if doc.summary != doc.summary.lstrip():
             errs.append('Summary contains heading whitespaces.')
         elif (doc.is_function_or_method
-                and doc.summary.split(' ')[0][-1] == 's'):
+              and doc.summary.split(' ')[0][-1] == 's'):
             errs.append('Summary must start with infinitive verb, '
                         'not third person (e.g. use "Generate" instead of '
                         '"Generates")')
@@ -490,6 +498,12 @@ def validate_one(func_name):
         for param_err in param_errs:
             errs.append('\t{}'.format(param_err))
 
+    pep8_errs = doc.pep8_violations
+    if pep8_errs:
+        errs.append('Errors in doctest sections')
+        for pep8_err in pep8_errs:
+            errs.append('\t{}'.format(pep8_err))
+
     if doc.is_function_or_method:
         if not doc.returns and "return" in doc.method_source:
             errs.append('No Returns section found')

setup.cfg

@@ -28,6 +28,31 @@ exclude =
     doc/temp/*.py,
     .eggs/*.py,
     versioneer.py
+    .tox
+    .git
+
+doctests = True
+#TODO fix doctests
+exclude_from_doctest =
+    ./pandas/_libs
+    ./pandas/api
+    ./pandas/compat
+    ./pandas/computation
+    ./pandas/core
+    ./pandas/errors
+    ./pandas/io
+    ./pandas/plotting
+    ./pandas/tests
+    ./pandas/tools
+    ./pandas/tseries
+    ./pandas/types
+    ./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