Now consistently use -t flag for transcript generation for both history and load commands

Author: tleonhardt

CHANGELOG.md

@@ -9,7 +9,7 @@
     * The `with_argparser` decorators now add the Statement object created when parsing the command line to the
     `argparse.Namespace` object they pass to the `do_*` methods. It is stored in an attribute called `__statement__`.
     This can be useful if a command function needs to know the command line for things like logging.
-    * Added a `-r` option to the `load` command for automatically generating a transcript based on a script file
+    * Added a `-t` option to the `load` command for automatically generating a transcript based on a script file
 * Potentially breaking changes
     * The following commands now write to stderr instead of stdout when printing an error. This will make catching
     errors easier in pyscript.

cmd2/cmd2.py

@@ -3468,8 +3468,7 @@ def do_eos(self, _: argparse.Namespace) -> None:
                         )
 
     load_parser = ACArgumentParser(description=load_description)
-    setattr(load_parser.add_argument('-r', '--record_transcript',
-                                     help='record the output of the script as a transcript file'),
+    setattr(load_parser.add_argument('-t', '--transcript', help='record the output of the script as a transcript file'),
             ACTION_ARG_CHOICES, ('path_complete',))
     setattr(load_parser.add_argument('script_path', help="path to the script file"),
             ACTION_ARG_CHOICES, ('path_complete',))
@@ -3509,8 +3508,8 @@ def do_load(self, args: argparse.Namespace) -> None:
             self.perror("Problem accessing script from '{}': {}".format(expanded_path, ex))
             return
 
-        if args.record_transcript:
-            self._generate_transcript(script_commands, os.path.expanduser(args.record_transcript))
+        if args.transcript:
+            self._generate_transcript(script_commands, os.path.expanduser(args.transcript))
             return
 
         self.cmdqueue = script_commands + ['eos'] + self.cmdqueue

docs/transcript.rst

@@ -34,9 +34,9 @@ This is by far the easiest way to generate a transcript.
 
 Automatically from a script file
 --------------------------------
-A transcript can also be automatically generated from a script file using ``load -r``::
+A transcript can also be automatically generated from a script file using ``load -t``::
 
-    (Cmd) load scripts/script.txt -r transcript.txt
+    (Cmd) load scripts/script.txt -t transcript.txt
     2 commands and their outputs saved to transcript file 'transcript.txt'
     (Cmd)
 

tests/test_transcript.py

@@ -203,7 +203,7 @@ def test_load_record_transcript(base_app, request):
     os.close(fd)
 
     # Run the load command with the -r option to generate a transcript
-    run_cmd(base_app, 'load {} -r {}'.format(filename, transcript_fname))
+    run_cmd(base_app, 'load {} -t {}'.format(filename, transcript_fname))
 
     assert base_app.cmdqueue == []
     assert base_app._script_dir == []