Add pathclass and betterhelp to brename.py.

brename.py

@@ -18,11 +18,16 @@ import re
 import sys
 import unicodedata
 
+from voussoirkit import betterhelp
 from voussoirkit import interactive
+from voussoirkit import pathclass
 from voussoirkit import safeprint
 from voussoirkit import spinal
 from voussoirkit import stringtools
 
+# These constants are provided for use in your eval string
+cwd = pathclass.cwd()
+
 # These variables are provided so that if you have any difficulty typing
 # literal quotes etc into your command line, you can just use these variable
 # names in your eval string.
@@ -53,31 +58,27 @@ def unicode_normalize(s):
 def brename(transformation, autoyes=False, do_naturalsort=False, recurse=False):
     if recurse:
         walker = spinal.walk_generator('.', yield_files=True, yield_directories=True)
-        olds = [x.absolute_path for x in walker]
+        olds = list(walker)
     else:
-        olds = [os.path.join(os.getcwd(), x) for x in os.listdir('.')]
+        olds = cwd.listdir()
 
     if do_naturalsort:
-        olds.sort(key=natural_sorter)
+        olds.sort(key=lambda x: natural_sorter(x.absolute_path))
     else:
         olds.sort()
 
     pairs = []
     for (index, old) in enumerate(olds):
-        new = old
-        directory = os.path.dirname(new)
-        basename = os.path.basename(new)
-        new = basename
-
         # These variables are assigned so that you can use them in your
         # transformation string.
-        (noext, ext) = os.path.splitext(basename)
-        x = new
-        extension = ext
+        x = old.basename
+        parent = old.parent
+        noext = old.replace_extension('').basename
+        ext = old.extension.ext
         index1 = index + 1
 
         new = eval(transformation)
-        new = os.path.join(directory, new)
+        new = parent.with_child(new)
         if new == old:
             continue
         pairs.append((old, new))
@@ -107,10 +108,10 @@ def longest_length(li):
 def loop(pairs, dry=False):
     for (old, new) in pairs:
         if dry:
-            line = f'{old}\n{new}\n'
+            line = f'{old.absolute_path}\n{new.absolute_path}\n'
             safeprint.safeprint(line)
         else:
-            os.rename(old, new)
+            os.rename(old.absolute_path, new.absolute_path)
 
 def brename_argparse(args):
     return brename(
@@ -120,17 +121,53 @@ def brename_argparse(args):
         recurse=args.recurse,
     )
 
+DOCSTRING = '''
+brename - batch file renaming
+=============================
+
+> brename.py eval_string <flags>
+
+eval_string:
+    A string which will be evaluated by Python's eval. The name of the file or
+    folder will be in the variable `x`. In addition, many other variables are
+    provided for your convenience:
+    `quote` ("), `apostrophe` (') so you don't have to escape command quotes.
+    `hyphen` (-) because leading hyphens often cause problems with argparse.
+    `stringtools` entire stringtools module. See voussoirkit/stringtools.py.
+    `space` ( ), `dot` (.), `underscore` (_) so you don't have to add quotes to
+    your command while using these common characters.
+    `index` the file's index within the loop.
+    `index1` the file's index+1, in case you want your names to start from 1.
+    `parent` a pathclass.Path object for the directory containing the file.
+    `cwd` a pathclass.Path object for the cwd of this program session.
+    `noext` the name of the file, but without its extension.
+    `ext` the file's extension, with no dot.
+
+-y | --yes:
+    Accept the results without confirming.
+
+--recurse:
+    Recurse into subfolders and rename those files too.
+
+--naturalsort:
+    Before renaming, the files will be sorted using natural sort instead of the
+    default lexicographic sort. Natural sort means that "My file 20" will come
+    before "My file 100" because 20<100. Lexicographic sort means 100 will come
+    first because 1 is before 2.
+    The purpose of this flag is so your index and index1 variables are applied
+    in the order you desire.
+'''
+
 def main(argv):
     parser = argparse.ArgumentParser(description=__doc__)
 
     parser.add_argument('transformation', help='python command using x as variable name')
-    parser.add_argument('-y', '--yes', dest='autoyes', action='store_true', help='accept results without confirming')
-    parser.add_argument('--recurse', dest='recurse', action='store_true', help='operate on subdirectories also')
+    parser.add_argument('-y', '--yes', dest='autoyes', action='store_true')
+    parser.add_argument('--recurse', dest='recurse', action='store_true')
     parser.add_argument('--naturalsort', dest='do_naturalsort', action='store_true')
     parser.set_defaults(func=brename_argparse)
 
-    args = parser.parse_args(argv)
-    return args.func(args)
+    return betterhelp.single_main(argv, parser, DOCSTRING)
 
 if __name__ == '__main__':
     raise SystemExit(main(sys.argv[1:]))