sty: cleanup tools folder

Author: satra

tools/apigen.py

@@ -36,12 +36,13 @@ class ApiDocWriter(object):
     # only separating first two levels
     rst_section_levels = ['*', '=', '-', '~', '^']
 
-    def __init__(self,
-                 package_name,
-                 rst_extension='.rst',
-                 package_skip_patterns=None,
-                 module_skip_patterns=None,
-                 ):
+    def __init__(
+            self,
+            package_name,
+            rst_extension='.rst',
+            package_skip_patterns=None,
+            module_skip_patterns=None,
+    ):
         ''' Initialize package for parsing
 
         Parameters
@@ -298,8 +299,7 @@ def _survives_exclude(self, matchstr, match_type):
         elif match_type == 'package':
             patterns = self.package_skip_patterns
         else:
-            raise ValueError('Cannot interpret match type "%s"'
-                             % match_type)
+            raise ValueError('Cannot interpret match type "%s"' % match_type)
         # Match to URI without package name
         L = len(self.package_name)
         if matchstr[:L] == self.package_name:
@@ -343,21 +343,20 @@ def discover_modules(self):
         # raw directory parsing
         for dirpath, dirnames, filenames in os.walk(self.root_path):
             # Check directory names for packages
-            root_uri = self._path2uri(os.path.join(self.root_path,
-                                                   dirpath))
+            root_uri = self._path2uri(os.path.join(self.root_path, dirpath))
             for dirname in dirnames[:]:  # copy list - we modify inplace
                 package_uri = '.'.join((root_uri, dirname))
-                if (self._uri2path(package_uri) and
-                        self._survives_exclude(package_uri, 'package')):
+                if (self._uri2path(package_uri)
+                        and self._survives_exclude(package_uri, 'package')):
                     modules.append(package_uri)
                 else:
                     dirnames.remove(dirname)
             # Check filenames for modules
             for filename in filenames:
                 module_name = filename[:-3]
                 module_uri = '.'.join((root_uri, module_name))
-                if (self._uri2path(module_uri) and
-                        self._survives_exclude(module_uri, 'module')):
+                if (self._uri2path(module_uri)
+                        and self._survives_exclude(module_uri, 'module')):
                     modules.append(module_uri)
         # print sorted(modules)  #dbg
         return sorted(modules)
@@ -370,8 +369,7 @@ def write_modules_api(self, modules, outdir):
             if not api_str:
                 continue
             # write out to file
-            outfile = os.path.join(outdir,
-                                   m + self.rst_extension)
+            outfile = os.path.join(outdir, m + self.rst_extension)
             fileobj = open(outfile, 'wt')
             fileobj.write(api_str)
             fileobj.close()

tools/build_interface_docs.py

@@ -18,14 +18,15 @@
     outdir = os.path.join('interfaces', 'generated')
     docwriter = InterfaceHelpWriter(package)
     # Packages that should not be included in generated API docs.
-    docwriter.package_skip_patterns += ['\.external$',
-                                        '\.fixes$',
-                                        '\.utils$',
-                                        '\.pipeline',
-                                        '\.testing',
-                                        '\.caching',
-                                        '\.scripts',
-                                        ]
+    docwriter.package_skip_patterns += [
+        '\.external$',
+        '\.fixes$',
+        '\.utils$',
+        '\.pipeline',
+        '\.testing',
+        '\.caching',
+        '\.scripts',
+    ]
     # Modules that should not be included in generated API docs.
     docwriter.module_skip_patterns += [
         '\.version$',
@@ -41,20 +42,21 @@
         '\.testing',
         '\.scripts',
     ]
-    docwriter.class_skip_patterns += ['AFNICommand',
-                                      'ANTS',
-                                      'FSLCommand',
-                                      'FS',
-                                      'Info',
-                                      '^SPM',
-                                      'Tester',
-                                      'Spec$',
-                                      'Numpy'
-                                      # NipypeTester raises an
-                                      # exception when instantiated in
-                                      # InterfaceHelpWriter.generate_api_doc
-                                      'NipypeTester',
-                                      ]
+    docwriter.class_skip_patterns += [
+        'AFNICommand',
+        'ANTS',
+        'FSLCommand',
+        'FS',
+        'Info',
+        '^SPM',
+        'Tester',
+        'Spec$',
+        'Numpy'
+        # NipypeTester raises an
+        # exception when instantiated in
+        # InterfaceHelpWriter.generate_api_doc
+        'NipypeTester',
+    ]
     docwriter.write_api_docs(outdir)
     docwriter.write_index(outdir, 'gen', relative_to='interfaces')
     print('%d files written' % len(docwriter.written_modules))

tools/build_modref_templates.py

@@ -19,16 +19,17 @@
     outdir = os.path.join('api', 'generated')
     docwriter = ApiDocWriter(package)
     # Packages that should not be included in generated API docs.
-    docwriter.package_skip_patterns += ['\.external$',
-                                        '\.utils$',
-                                        '\.interfaces\.',
-                                        '\.workflows$',
-                                        '\.pipeline\.plugins$',
-                                        '\.testing$',
-                                        '\.fixes$',
-                                        '\.algorithms$',
-                                        '\.scripts$',
-                                        ]
+    docwriter.package_skip_patterns += [
+        '\.external$',
+        '\.utils$',
+        '\.interfaces\.',
+        '\.workflows$',
+        '\.pipeline\.plugins$',
+        '\.testing$',
+        '\.fixes$',
+        '\.algorithms$',
+        '\.scripts$',
+    ]
     # Modules that should not be included in generated API docs.
     docwriter.module_skip_patterns += [
         '\.version$',

tools/ex2rst

@@ -10,7 +10,6 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-
 """Helper to automagically generate ReST versions of examples"""
 from __future__ import (print_function, division, unicode_literals,
                         absolute_import)
@@ -38,18 +37,20 @@ def auto_image(line):
 
     # Match means it's an image spec, we rewrite it with extra tags
     ini_space = m.group(1)
-    lines = [line,
-             ini_space + '   :width: 500\n',
-             #ini_space + '   :height: 350\n'
-             ]
+    lines = [
+        line,
+        ini_space + '   :width: 500\n',
+        #ini_space + '   :height: 350\n'
+    ]
     fspec = m.group(2)
     if fspec.endswith('.*'):
         fspec = fspec.replace('.*', '.png')
     fspec = fspec.replace('fig/', '../_images/')
-    lines.append(ini_space + ('   :target: %s\n' % fspec) )
+    lines.append(ini_space + ('   :target: %s\n' % fspec))
     lines.append('\n')
     return ''.join(lines)
 
+
 def exfile2rst(filename):
     """Open a Python script and convert it into an ReST string.
     """
@@ -114,7 +115,7 @@ def exfile2rst(filename):
                     indocs = True
                     code2doc = True
                     # rescue what is left on the line
-                    proc_line = cleanline[3:] # strip """
+                    proc_line = cleanline[3:]  # strip """
             else:
                 # we are already in the docs
                 # handle doc end
@@ -191,14 +192,13 @@ def exfile2rstfile(filename, opts):
    This same script is also included in the %s source distribution under the
    :file:`examples` directory.
 
-"""    % (filename, opts.project)
+""" % (filename, opts.project)
 
         dfile.write(msg)
 
     dfile.close()
 
 
-
 def main():
     parser = OptionParser( \
         usage="%prog [options] <filename|directory> [...]", \
@@ -224,30 +224,53 @@ first (module-level) docstring instead.
 """ ) #'
 
     # define options
-    parser.add_option('--verbose', action='store_true', dest='verbose',
-                      default=False, help='print status messages')
-    parser.add_option('-x', '--exclude', action='append', dest='excluded',
-                      help="""\
+    parser.add_option(
+        '--verbose',
+        action='store_true',
+        dest='verbose',
+        default=False,
+        help='print status messages')
+    parser.add_option(
+        '-x',
+        '--exclude',
+        action='append',
+        dest='excluded',
+        help="""\
 Use this option to exclude single files from the to be parsed files. This is
 especially useful to exclude files when parsing complete directories. This
 option can be specified multiple times.
 """)
-    parser.add_option('-o', '--outdir', action='store', dest='outdir',
-                      type='string', default=None, help="""\
+    parser.add_option(
+        '-o',
+        '--outdir',
+        action='store',
+        dest='outdir',
+        type='string',
+        default=None,
+        help="""\
 Target directory to write the ReST output to. This is a required option.
 """)
-    parser.add_option('--no-sourceref', action='store_false', default=True,
-                      dest='sourceref', help="""\
+    parser.add_option(
+        '--no-sourceref',
+        action='store_false',
+        default=True,
+        dest='sourceref',
+        help="""\
 If specified, the source reference section will be suppressed.
 """)
-    parser.add_option('--project', type='string', action='store', default='',
-                      dest='project', help="""\
+    parser.add_option(
+        '--project',
+        type='string',
+        action='store',
+        default='',
+        dest='project',
+        help="""\
 Name of the project that contains the examples. This name is used in the
 'seealso' source references. Default: ''
 """)
 
     # parse options
-    (opts, args) = parser.parse_args() # read sys.argv[1:] by default
+    (opts, args) = parser.parse_args()  # read sys.argv[1:] by default
 
     # check for required options
     if opts.outdir is None:

tools/github.py

@@ -28,8 +28,11 @@ def get_local_branch():
     """Determine current branch
     """
     if is_git_repo():
-        o, _ = Popen('git branch | grep "\* "', shell=True, stdout=PIPE,
-                     cwd=os.path.dirname(nipype.__file__)).communicate()
+        o, _ = Popen(
+            'git branch | grep "\* "',
+            shell=True,
+            stdout=PIPE,
+            cwd=os.path.dirname(nipype.__file__)).communicate()
         return o.strip()[2:]
     else:
         return None
@@ -51,8 +54,12 @@ def create_hash_map():
     import pwd
     login_name = pwd.getpwuid(os.geteuid())[0]
     conn = http.client.HTTPSConnection("api.github.com")
-    conn.request("GET", "/repos/nipy/nipype",
-                 headers={'Authorization': 'Basic %s' % base64(login_name)})
+    conn.request(
+        "GET",
+        "/repos/nipy/nipype",
+        headers={
+            'Authorization': 'Basic %s' % base64(login_name)
+        })
     try:
         conn.request("GET", "/repos/nipy/nipype/git/trees/master?recursive=1")
     except: