rimport: Modernize help.

Author: samsrabin

rimport

@@ -2,26 +2,9 @@
 # TODO: Move all the Python into new file rimport.py for simpler testing. Keep rimport as a
 # convenience wrapper.
 """
-A drop-in CLI replacement for the legacy `rimport` csh tool.
-
-This script preserves the original command-line interface:
-
-  SYNOPSIS
-      rimport  [-file filename] [-list filelist] [-inputdata inputdata_dir] [-help]
-
-  OPTIONS
-      -file filename
-         provide a single filename relative to the top inputdata directory
-      -list filelist
-         provide a file that contains a list of filenames to import. all filenames
-         in the list are relative to the top inputdata area.
-      -inputdata inputdata_dir
-         change the default local top level inputdata directory
-      -help
-         get help about this tool
-
-Customize the `do_new_action(path)` function to implement the new behavior.
-By default, it prints which files would be processed.
+Copy files from CESM inputdata directory to a publishing directory.
+
+Do `rimport --help` for more information.
 """
 from __future__ import annotations
 
@@ -34,43 +17,27 @@ from pathlib import Path
 from typing import Iterable, List
 
 
-class PlainHelpFormatter(argparse.RawTextHelpFormatter):
-    pass
-
-
 def build_parser() -> argparse.ArgumentParser:
-    synopsis = (
-        "rimport  [-file filename] [-list filelist] [-inputdata inputdata_dir] [-help]"
-    )
-
-    description = (
-        "SYNOPSIS\n"
-        f"      {synopsis}\n\n"
-        "OPTIONS\n"
-        "      -file filename\n"
-        "         provide a single filename relative to the top inputdata directory\n"
-        "      -list filelist\n"
-        "         provide a file that contains a list of filenames to import. all filenames\n"
-        "         in the list are relative to the top inputdata area.\n"
-        "      -inputdata inputdata_dir\n"
-        "         change the default local top level inputdata directory\n"
-        "      -help\n"
-        "         get help about this tool\n"
-    )
-
     parser = argparse.ArgumentParser(
-        prog="rimport",
-        description=description,
-        formatter_class=PlainHelpFormatter,
-        add_help=False,  # preserve original -help only
-        usage=synopsis,
+        description="Copy files from CESM inputdata directory to a publishing directory."
     )
 
     # Mutually exclusive: -file or -list (one required)
     group = parser.add_mutually_exclusive_group(required=True)
-    group.add_argument("-file", dest="file", metavar="filename", help=argparse.SUPPRESS)
     group.add_argument(
-        "-list", dest="filelist", metavar="filelist", help=argparse.SUPPRESS
+        "-file",
+        dest="file",
+        metavar="filename",
+        help="Provide a single filename relative to the top inputdata directory",
+    )
+    group.add_argument(
+        "-list",
+        dest="filelist",
+        metavar="filelist",
+        help=(
+            "Provide a file that contains a list of filenames to import. All filenames in the list"
+            "are relative to the top inputdata area."
+        ),
     )
 
     parser.add_argument(
@@ -80,12 +47,9 @@ def build_parser() -> argparse.ArgumentParser:
         default=os.path.join(
             "/glade", "campaign", "cesm", "cesmdata", "cseg", "inputdata"
         ),
-        help=argparse.SUPPRESS,
+        help="Change the default local top level inputdata directory.",
     )
 
-    # Provide -help to mirror legacy behavior
-    parser.add_argument("-help", action="help", help=argparse.SUPPRESS)
-
     return parser
 
 

tests/rimport/test_build_parser.py

@@ -32,11 +32,6 @@ def test_parser_creation(self):
         parser = rimport.build_parser()
         assert isinstance(parser, argparse.ArgumentParser)
 
-    def test_parser_prog_name(self):
-        """Test that parser has correct program name."""
-        parser = rimport.build_parser()
-        assert parser.prog == "rimport"
-
     def test_file_argument_accepted(self):
         """Test that -file argument is accepted."""
         parser = rimport.build_parser()
@@ -71,7 +66,7 @@ def test_file_or_list_required(self, capsys):
         # Check that the error message explains the problem
         captured = capsys.readouterr()
         stderr_lines = captured.err.strip().split("\n")
-        assert "rimport: error: one of the arguments" in stderr_lines[-1]
+        assert "error: one of the arguments" in stderr_lines[-1]
 
     def test_inputdata_default(self):
         """Test that -inputdata has correct default value."""
@@ -89,9 +84,9 @@ def test_inputdata_custom(self):
         args = parser.parse_args(["-file", "test.txt", "-inputdata", custom_path])
         assert args.inputdata == custom_path
 
-    @pytest.mark.parametrize("help_flag", ["-help", "-h"])
+    @pytest.mark.parametrize("help_flag", ["-help", "-h", "--help"])
     def test_help_flags_show_help(self, help_flag):
-        """Test that -help and -h flags trigger help."""
+        """Test that all help flag options trigger help."""
         parser = rimport.build_parser()
         with pytest.raises(SystemExit) as exc_info:
             parser.parse_args([help_flag])

tests/rimport/test_cmdline.py

@@ -249,7 +249,7 @@ def test_error_for_empty_list_file(self, rimport_script, test_env, rimport_env):
         assert result.returncode == 2
         assert "no filenames found" in result.stderr
 
-    @pytest.mark.parametrize("help_flag", ["-help", "-h"])
+    @pytest.mark.parametrize("help_flag", ["-help", "-h", "--help"])
     def test_help_flag_shows_help(self, rimport_script, help_flag):
         """Test that help flags show help message."""
         command = [sys.executable, rimport_script, help_flag]
@@ -263,8 +263,8 @@ def test_help_flag_shows_help(self, rimport_script, help_flag):
 
         # Help should exit with code 0
         assert result.returncode == 0
-        assert "SYNOPSIS" in result.stdout
-        assert "OPTIONS" in result.stdout
+        assert "usage:" in result.stdout
+        assert "options:" in result.stdout
 
     def test_list_with_comments_and_blanks(self, rimport_script, test_env, rimport_env):
         """Test that list file with comments and blank lines works correctly."""