Refine code after running flake8.

shlib/extended_pathlib.py

@@ -40,6 +40,7 @@ def _is_readable(path):
 
 PosixPath.is_readable = _is_readable
 
+
 # is_writable {{{1
 def _is_writable(path):
     """
@@ -53,6 +54,7 @@ def _is_writable(path):
 
 PosixPath.is_writable = _is_writable
 
+
 # is_executable {{{1
 def _is_executable(path):
     """
@@ -66,6 +68,7 @@ def _is_executable(path):
 
 PosixPath.is_executable = _is_executable
 
+
 # is_hidden {{{1
 def _is_hidden(path):
     """
@@ -75,10 +78,11 @@ def _is_hidden(path):
     False
 
     """
-    return path.exists() and str(path).startswith('.')
+    return path.exists() and path.name.startswith('.')
 
 PosixPath.is_hidden = _is_hidden
 
+
 # path_from {{{1
 def _path_from(path, start):
     """
@@ -94,6 +98,7 @@ def _path_from(path, start):
 
 PosixPath.path_from = _path_from
 
+
 # sans_ext {{{1
 def _sans_ext(path):
     """
@@ -108,6 +113,7 @@ def _sans_ext(path):
     """
     return path.parent / path.stem
 
+
 PosixPath.sans_ext = _sans_ext
 
 # Python 3.5 extensions {{{1
@@ -173,4 +179,3 @@ def _expanduser(self):
         return self
 
     PosixPath.expanduser = _expanduser
-

shlib/shlib.py

@@ -1,6 +1,6 @@
 # shlib -- Scripting utilities
 #
-# A light-weight package with few dependencies that allows users to do 
+# A light-weight package with few dependencies that allows users to do
 # shell-script like things relatively easily in Python.
 
 # License {{{1
@@ -27,12 +27,11 @@
     from .extended_pathlib import Path
 except ImportError:
     from pathlib import Path
+from six import string_types
 import itertools
-import shlex
 import shutil
 import errno
 import os
-import sys
 
 # Parameters {{{1
 PREFERENCES = dict(
@@ -43,11 +42,11 @@
 
 # Utilities {{{1
 # is_str {{{2
-from six import string_types
 def is_str(obj):
     """Identifies strings in all their various guises."""
     return isinstance(obj, string_types)
 
+
 # is_iterable {{{2
 def is_iterable(obj):
     """Identifies objects that can be iterated over, including strings."""
@@ -58,18 +57,21 @@ def is_iterable(obj):
         from collections import Iterable
     return isinstance(obj, Iterable)
 
+
 # is_collection {{{2
 def is_collection(obj):
     """Identifies objects that can be iterated over, excluding strings."""
     return is_iterable(obj) and not is_str(obj)
 
+
 # to_path {{{2
 def to_path(*args):
     try:
         return Path(*args).expanduser()
     except AttributeError:
         return Path(*args)
 
+
 # to_paths {{{2
 def to_paths(args):
     "Iterate through up to two levels of arguments, converting them to paths"
@@ -80,12 +82,14 @@ def to_paths(args):
         else:
             yield to_path(arg)
 
+
 # to_str {{{2
 def to_str(path):
     # first convert to path to assure ~ expansion is done, then convert back to 
     # string.
     return str(to_path(path))
 
+
 # raise_os_error {{{2
 # Raise an error based on the errno.
 def raise_os_error(errno, filename=None):
@@ -94,11 +98,13 @@ def raise_os_error(errno, filename=None):
     else:
         raise OSError(errno, os.strerror(errno))
 
+
 # split_cmd {{{2
 def split_cmd(cmd):
     from shlex import split
     return split(cmd)
 
+
 # quote_arg {{{2
 def quote_arg(arg):
     """Return a shell-escaped version of the string *arg*."""
@@ -117,12 +123,14 @@ def quote(arg):
                 return "'" + arg.replace("'", "'\"'\"'") + "'"
     return quote(str(arg))
 
+
 # _use_log {{{2
 def _use_log(log):
     if log is None:
         return PREFERENCES['log_cmd']
     return log
 
+
 # Preferences {{{1
 def set_prefs(**kwargs):
     """Set ShLib preferences
@@ -150,6 +158,7 @@ def set_state(state):
     PREFERENCES = state
     return old_state
 
+
 # File system utility functions (cp, mv, rm, ln, touch, mkdir, ls, etc.) {{{1
 # cp {{{2
 def cp(*paths):
@@ -176,6 +185,7 @@ def cp(*paths):
     else:
         shutil.copy2(to_str(src), to_str(dest))
 
+
 # mv {{{2
 def mv(*paths):
     "Move file or directory (supports moves across filesystems)"
@@ -204,6 +214,7 @@ def mv(*paths):
         shutil.move(to_str(src), to_str(dest))
 
 
+
 # rm {{{2
 def rm(*paths):
     "Remove files or directories (equivalent to rm -rf)"
@@ -221,12 +232,14 @@ def rm(*paths):
             if err.errno != errno.ENOENT:
                 raise
 
+
 # ln {{{2
 def ln(src, dest):
     "Create symbolic link."
     dest = to_path(dest)
     dest.symlink_to(src)
 
+
 # touch {{{2
 def touch(*paths):
     """
@@ -235,6 +248,7 @@ def touch(*paths):
     for path in to_paths(paths):
         path.touch()
 
+
 # mkdir {{{2
 def mkdir(*paths):
     """
@@ -254,6 +268,7 @@ def mkdir(*paths):
             if err.errno != errno.EEXIST or path.is_file():
                 raise
 
+
 # mount/umount {{{2
 class mount:
 
@@ -274,9 +289,11 @@ def __exit__(self, exc_type, exc_value, exc_traceback):
 def umount(path):
     Run(['umount', path])
 
+
 def is_mounted(path):
     return Run(['mountpoint', '-q', path], '0,1').status == 0
 
+
 # cd {{{2
 class cd:
     def __init__(self, path):
@@ -290,22 +307,26 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, exc_traceback):
         os.chdir(to_str(self.starting_dir))
 
+
 # cwd {{{2
 def cwd():
     """Return current working directory as a pathlib path"""
     return Path.cwd()
 
+
 # chmod {{{2
 def chmod(mode, *paths):
     "Change the mode bits of one or more file or directory"
     for path in to_paths(paths):
         path.chmod(mode)
 
+
 # getmod {{{2
 def getmod(path):
     "Return the permission bits for a file or directory"
     return os.stat(str(path)).st_mode & 0o777
 
+
 # ls {{{2
 def ls(*paths, **kwargs):
     """
@@ -316,12 +337,12 @@ def ls(*paths, **kwargs):
 
     Args:
         paths: the paths to list ('.' if no paths given).
-        select: a returned path will match this glob string, use **/* to enable 
+        select: a returned path will match this glob string, use **/* to enable
             recursion
         reject: a returned path will not match this glob string
         only: specifies the type of returned paths, choose from 'file' or 'dir'
-        hidden (bool): specifies whether hidden files should be returned, if 
-            not given hidden files are returned if select string starts with 
+        hidden (bool): specifies whether hidden files should be returned, if
+            not given hidden files are returned if select string starts with
             '.'
 
     KSK: it is a bit weird that I allow paths to be a list, but not select or
@@ -378,6 +399,7 @@ def acceptable(path):
                 if acceptable(each):
                     yield each
 
+
 # lsd {{{2
 def lsd(*args, **kwargs):
     """
@@ -407,6 +429,7 @@ def lsd(*args, **kwargs):
     for d in ls(*args, **kwargs):
         yield d
 
+
 # lsf {{{2
 def lsf(*args, **kwargs):
     """
@@ -432,6 +455,7 @@ def lsf(*args, **kwargs):
     for f in ls(*args, **kwargs):
         yield f
 
+
 # Path list functions (leaves, cartesian_product, brace_expand, etc.) {{{1
 def _leaves(path, hidden, report):
     try:
@@ -447,6 +471,7 @@ def _leaves(path, hidden, report):
         if report:
             report(e)
 
+
 # leaves()  {{{2
 def leaves(path, hidden=False, report=None):
     """
@@ -464,10 +489,11 @@ def leaves(path, hidden=False, report=None):
     for each in _leaves(Path(path), hidden, report):
         yield each
 
+
 # cartesian_product()  {{{2
 def cartesian_product(*fragments):
     """
-    Combine path fragments to to a path list. Each fragment must be a string or 
+    Combine path fragments to to a path list. Each fragment must be a string or
     path or an iterable that generates strings or paths.
     """
     if not len(fragments):
@@ -476,6 +502,7 @@ def cartesian_product(*fragments):
         *(f if is_collection(f) else (f,) for f in fragments)
     )]
 
+
 # brace_expand()  {{{2
 try:
     from braceexpand import braceexpand
@@ -488,6 +515,7 @@ def brace_expand(pattern):
 except ImportError:
     pass
 
+
 # Execution classes and functions (Cmd, Run, Sh, Start, run, bg, shbg, which) {{{1
 # Command class {{{2
 class Cmd(object):
@@ -540,6 +568,7 @@ def __init__(
         self.option_args = option_args
         self._interpret_modes(modes)
 
+
     # _interpret_modes {{{3
     def _interpret_modes(self, modes):
         accept = ''
@@ -753,6 +782,7 @@ def __init__(
         self._interpret_modes(modes)
         self.run(stdin)
 
+
 # Sh class (deprecated) {{{2
 class Sh(Cmd):
     """Run a command immediately in the shell.
@@ -866,6 +896,7 @@ def run(cmd, stdin=None, accept=0, shell=False):
         raise OSError(None, "unexpected exit status (%d)." % status)
     return status
 
+
 # sh (deprecated) {{{2
 def sh(cmd, stdin=None, accept=0, shell=True):
     "Execute a command with a shell without capturing its output"
@@ -883,6 +914,7 @@ def bg(cmd, stdin=None, shell=False):
         process.stdin.close()
     return process.pid
 
+
 # shbg (deprecated) {{{2
 def shbg(cmd, stdin=None, shell=True):
     "Execute a command with a shell in the background without capturing its output."
@@ -901,6 +933,7 @@ def which(name, path=None, flags=os.X_OK):
             result.append(p)
     return result
 
+
 # render_command {{{2
 def render_command(cmd, option_args=None, width=70):
     """ Render a command.

tests/REF

@@ -0,0 +1,3 @@
+line1
+line2
+line3

tests/TEST

@@ -0,0 +1,2 @@
+line1
+line2

tests/test_shlib.rst

@@ -1 +1 @@
-../shlib.py
+../shlib/shlib.py