Tidy up code

workflow/background.py

@@ -8,9 +8,7 @@
 # Created on 2014-04-06
 #
 
-"""
-Run background tasks
-"""
+"""Run background tasks."""
 
 from __future__ import print_function, unicode_literals
 
@@ -34,40 +32,38 @@ def wf():
 
 
 def _arg_cache(name):
-    """Return path to pickle cache file for arguments
+    """Return path to pickle cache file for arguments.
 
     :param name: name of task
     :type name: ``unicode``
     :returns: Path to cache file
     :rtype: ``unicode`` filepath
 
     """
-
     return wf().cachefile('{0}.argcache'.format(name))
 
 
 def _pid_file(name):
-    """Return path to PID file for ``name``
+    """Return path to PID file for ``name``.
 
     :param name: name of task
     :type name: ``unicode``
     :returns: Path to PID file for task
     :rtype: ``unicode`` filepath
 
     """
-
     return wf().cachefile('{0}.pid'.format(name))
 
 
 def _process_exists(pid):
-    """Check if a process with PID ``pid`` exists
+    """Check if a process with PID ``pid`` exists.
 
     :param pid: PID to check
     :type pid: ``int``
     :returns: ``True`` if process exists, else ``False``
     :rtype: ``Boolean``
-    """
 
+    """
     try:
         os.kill(pid, 0)
     except OSError:  # not running
@@ -76,8 +72,7 @@ def _process_exists(pid):
 
 
 def is_running(name):
-    """
-    Test whether task is running under ``name``
+    """Test whether task is running under ``name``.
 
     :param name: name of task
     :type name: ``unicode``
@@ -113,7 +108,6 @@ def _background(stdin='/dev/null', stdout='/dev/null',
     :type stderr: filepath
 
     """
-
     # Do first fork.
     try:
         pid = os.fork()
@@ -150,8 +144,7 @@ def _background(stdin='/dev/null', stdout='/dev/null',
 
 
 def run_in_background(name, args, **kwargs):
-    """Pickle arguments to cache file, then call this script again via
-    :func:`subprocess.call`.
+    r"""Cache arguments then call this script again via :func:`subprocess.call`.
 
     :param name: name of task
     :type name: ``unicode``
@@ -175,7 +168,6 @@ def run_in_background(name, args, **kwargs):
     return immediately and will not run the specified command.
 
     """
-
     if is_running(name):
         wf().logger.info('Task `{0}` is already running'.format(name))
         return
@@ -199,12 +191,12 @@ def run_in_background(name, args, **kwargs):
 
 
 def main(wf):  # pragma: no cover
-    """
+    """Run command in a background process.
+
     Load cached arguments, fork into background, then call
-    :meth:`subprocess.call` with cached arguments
+    :meth:`subprocess.call` with cached arguments.
 
     """
-
     name = wf.args[0]
     argcache = _arg_cache(name)
     if not os.path.exists(argcache):