Merge pull request #2371 from satra/sty/pepping

Sty/pepping

Author: effigies

CHANGES

@@ -4,6 +4,8 @@ Upcoming release (0.14.1)
 * FIX: Robustly handled outputs of 3dFWHMx across different versions of AFNI (https://github.com/nipy/nipype/pull/2373)
 * FIX: Cluster threshold in randomise + change default prefix (https://github.com/nipy/nipype/pull/2369)
 * MAINT: Cleaning / simplify ``Node`` (https://github.com/nipy/nipype/pull/#2325)
+* STY: Cleanup of PEP8 violations (https://github.com/nipy/nipype/pull/2358)
+* STY: Cleanup of trailing spaces and adding of missing newlines at end of files (https://github.com/nipy/nipype/pull/2355)
 
 0.14.0 (November 29, 2017)
 ==========================

build_docs.py

@@ -8,7 +8,8 @@
 
     python setup.py build_sphinx
 """
-from __future__ import print_function, division, unicode_literals, absolute_import
+from __future__ import (print_function, division, unicode_literals,
+                        absolute_import)
 from builtins import open, str
 
 # Standard library imports
@@ -28,7 +29,7 @@
 DOC_BUILD_DIR = os.path.join('doc', '_build', 'html')
 DOC_DOCTREES_DIR = os.path.join('doc', '_build', 'doctrees')
 
-################################################################################
+###############################################################################
 # Distutils Command class for installing nipype to a temporary location.
 
 
@@ -63,7 +64,7 @@ def finalize_options(self):
         pass
 
 
-################################################################################
+###############################################################################
 # Distutils Command class for API generation
 class APIDocs(TempInstall):
     description = \
@@ -93,7 +94,7 @@ def run(self):
             os.chdir('..')
 
 
-################################################################################
+###############################################################################
 # Code to copy the sphinx-generated html docs in the distribution.
 def relative_path(filename):
     """ Return the relative path to the file, assuming the file is
@@ -103,7 +104,7 @@ def relative_path(filename):
     return os.path.abspath(filename)[length:]
 
 
-################################################################################
+###############################################################################
 # Distutils Command class build the docs
 # Sphinx import.
 try:
@@ -165,7 +166,7 @@ def finalize_options(self):
             self.build_dir = os.path.join(*DOC_BUILD_DIR.split(os.sep)[:-1])
             BuildDoc.finalize_options(self)
 
-################################################################################
+###############################################################################
 # Distutils Command class to clean
 
 

doc/sphinxext/autosummary_generate.py

@@ -39,9 +39,9 @@ def main():
                  help="Phantom import modules from a file")
     p.add_option("-o", "--output-dir", action="store", type="string",
                  dest="output_dir", default=None,
-                 help=("Write all output files to the given directory (instead "
-                       "of writing them as specified in the autosummary:: "
-                       "directives)"))
+                 help=("Write all output files to the given directory "
+                       "(instead of writing them as specified in the "
+                       "autosummary:: directives)"))
     options, args = p.parse_args()
 
     if len(args) == 0:
@@ -161,9 +161,12 @@ def get_documented_in_lines(lines, module=None, filename=None):
 
     """
     title_underline_re = re.compile("^[-=*_^#]{3,}\s*$")
-    autodoc_re = re.compile(".. auto(function|method|attribute|class|exception|module)::\s*([A-Za-z0-9_.]+)\s*$")
+    autodoc_re = re.compile(
+        ".. auto(function|method|attribute|class|exception|module)::"
+        "\s*([A-Za-z0-9_.]+)\s*$")
     autosummary_re = re.compile(r'^\.\.\s+autosummary::\s*')
-    module_re = re.compile(r'^\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$')
+    module_re = re.compile(
+        r'^\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$')
     autosummary_item_re = re.compile(r'^\s+([_a-zA-Z][a-zA-Z0-9_.]*)\s*.*?')
     toctree_arg_re = re.compile(r'^\s+:toctree:\s*(.*?)\s*$')
 
@@ -189,7 +192,8 @@ def get_documented_in_lines(lines, module=None, filename=None):
                 m = autosummary_item_re.match(line)
                 if m:
                     name = m.group(1).strip()
-                    if current_module and not name.startswith(current_module + '.'):
+                    if current_module and not name.startswith(
+                            current_module + '.'):
                         name = "%s.%s" % (current_module, name)
                     documented.setdefault(name, []).append(
                         (filename, current_title, 'autosummary', toctree))
@@ -210,7 +214,8 @@ def get_documented_in_lines(lines, module=None, filename=None):
                     current_module = name
                     documented.update(get_documented_in_docstring(
                         name, filename=filename))
-                elif current_module and not name.startswith(current_module + '.'):
+                elif current_module and not name.startswith(
+                        current_module + '.'):
                     name = "%s.%s" % (current_module, name)
                 documented.setdefault(name, []).append(
                     (filename, current_title, "auto" + m.group(1), None))
@@ -230,5 +235,6 @@ def get_documented_in_lines(lines, module=None, filename=None):
 
     return documented
 
+
 if __name__ == "__main__":
     main()

doc/sphinxext/ipython_console_highlighting.py

@@ -59,7 +59,6 @@ class IPythonConsoleLexer(Lexer):
 
     def get_tokens_unprocessed(self, text):
         pylexer = PythonLexer(**self.options)
-        tblexer = PythonTracebackLexer(**self.options)
 
         curcode = ''
         insertions = []
@@ -72,21 +71,22 @@ def get_tokens_unprocessed(self, text):
                 insertions.append((len(curcode),
                                    [(0, Comment, line)]))
             elif input_prompt is not None:
-                insertions.append((len(curcode),
-                                   [(0, Generic.Prompt, input_prompt.group())]))
+                insertions.append((len(
+                    curcode), [(0, Generic.Prompt, input_prompt.group())]))
                 curcode += line[input_prompt.end():]
             elif continue_prompt is not None:
-                insertions.append((len(curcode),
-                                   [(0, Generic.Prompt, continue_prompt.group())]))
+                insertions.append((len(
+                    curcode), [(0, Generic.Prompt, continue_prompt.group())]))
                 curcode += line[continue_prompt.end():]
             elif output_prompt is not None:
-                insertions.append((len(curcode),
-                                   [(0, Generic.Output, output_prompt.group())]))
+                insertions.append((len(
+                    curcode), [(0, Generic.Output, output_prompt.group())]))
                 curcode += line[output_prompt.end():]
             else:
                 if curcode:
                     for item in do_insertions(insertions,
-                                              pylexer.get_tokens_unprocessed(curcode)):
+                                              pylexer.get_tokens_unprocessed(
+                                                  curcode)):
                         yield item
                         curcode = ''
                         insertions = []

doc/sphinxext/numpy_ext/docscrape.py

@@ -295,7 +295,8 @@ def _parse(self):
 
         for (section, content) in self._read_sections():
             if not section.startswith('..'):
-                section = ' '.join([s.capitalize() for s in section.split(' ')])
+                section = ' '.join([s.capitalize()
+                                    for s in section.split(' ')])
             if section in ('Parameters', 'Returns', 'Raises', 'Warns',
                            'Other Parameters', 'Attributes', 'Methods'):
                 self[section] = self._parse_param_list(content)
@@ -443,7 +444,7 @@ def __init__(self, func, role='func', doc=None, config={}):
                 argspec = inspect.formatargspec(*argspec)
                 argspec = argspec.replace('*', '\*')
                 signature = '%s%s' % (func_name, argspec)
-            except TypeError as e:
+            except TypeError:
                 signature = '%s()' % func_name
             self['Signature'] = signature
 
@@ -459,7 +460,6 @@ def __str__(self):
         out = ''
 
         func, func_name = self.get_func()
-        signature = self['Signature'].replace('*', '\*')
 
         roles = {'func': 'function',
                  'meth': 'method'}

doc/sphinxext/numpy_ext/numpydoc.py

@@ -11,7 +11,7 @@
 - Convert Parameters etc. sections to field lists.
 - Convert See Also section to a See also entry.
 - Renumber references.
-- Extract the signature from the docstring, if it can't be determined otherwise.
+- Extract signature from docstring, if it can't be determined otherwise.
 
 .. [1] https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt