Multiple refactors on main() and parse_cmd_line_arguments().

lpozo · lpozo · commit 6772f939c1e3 · 2021-02-10T15:20:07.000-05:00
On main():

- Remove blank likes
- Update the order of the arguments to DirectoryTree constructor

On parse_cmd_line_arguments():

- Remove unneeded upper case letter from strings
- Move the version attribute up
- Remove the unneeded type argument because str is the default type for command-line arguments
diff --git a/rptree/cli.py b/rptree/cli.py
@@ -1,4 +1,4 @@
-"""This module provides RP Tree cli."""
+"""This module provides the RP Tree CLI."""
 
 import argparse
 import pathlib
@@ -11,44 +11,42 @@
 def main():
     args = parse_cmd_line_arguments()
     root_dir = pathlib.Path(args.root_dir)
-
     if not root_dir.is_dir():
         print("The specified root directory doesn't exist")
         sys.exit()
-
-    tree = DirectoryTree(root_dir, args.output_file, args.dir_only)
+    tree = DirectoryTree(
+        root_dir, dir_only=args.dir_only, output_file=args.output_file
+    )
     tree.generate()
 
 
 def parse_cmd_line_arguments():
     parser = argparse.ArgumentParser(
-        prog="RP Tree",
-        description="Directory Tree Generator",
-        epilog="Thanks for Using RP Tree!",
+        prog="tree",
+        description="RP Tree, a directory tree generator",
+        epilog="Thanks for using RP Tree!",
     )
-    parser.version = f"{parser.prog} {__version__}"
+    parser.version = f"RP Tree v{__version__}"
+    parser.add_argument("-v", "--version", action="version")
     parser.add_argument(
         "root_dir",
         metavar="ROOT_DIR",
         nargs="?",
         default=".",
-        type=str,
-        help="Generate a Full and Recursive Directory Tree",
+        help="Generate a full directory tree starting at ROOT_DIR",
     )
     parser.add_argument(
         "-d",
         "--dir-only",
         action="store_true",
-        help="Generate a Directory-Only Tree",
+        help="Generate a directory-only tree",
     )
     parser.add_argument(
         "-o",
         "--output-file",
         metavar="OUTPUT_FILE",
         nargs="?",
         default=sys.stdout,
-        type=str,
-        help="Generate a Full Directory Tree and Save it to a File",
+        help="Generate a full directory tree and save it to a file",
     )
-    parser.add_argument("-v", "--version", action="version")
     return parser.parse_args()
