rimport can now accept positional args (files to process).

To match relink behavior.

Author: samsrabin

rimport

@@ -71,6 +71,12 @@ def build_parser() -> argparse.ArgumentParser:
         ),
     )
 
+    parser.add_argument(
+        "items_to_process",
+        nargs="*",
+        help="One or more files to process. (Optional; can use --file instead to process just one.)"
+    )
+
     # Add inputdata_root option flags
     shared.add_inputdata_root(parser)
 
@@ -305,14 +311,15 @@ def print_can_file_be_downloaded(file_can_be_downloaded: bool):
         logger.info("%sFile is not (yet) available for download.", INDENT)
 
 
-def get_files_to_process(file: str, filelist: str):
+def get_files_to_process(file: str, filelist: str, items_to_process: list):
     """Get list of files to process.
 
-    Uses --file and/or --filelist arguments.
+    Uses --file and/or --filelist arguments, as well as positional items_to_process if given.
 
     Args:
         file (str): Single file to process.
         filelist (str): File containing list of files to process.
+        items_to_process (list): List of files to process.
 
     Returns:
         list: List of files to process
@@ -334,6 +341,9 @@ def get_files_to_process(file: str, filelist: str):
             return None, 2
         files_to_process.extend(files_in_list)
 
+    if items_to_process:
+        files_to_process.extend(items_to_process)
+
     if not files_to_process:
         logger.error("rimport: At least one of --file or --filelist is required")
         return None, 2
@@ -382,7 +392,7 @@ def main(argv: List[str] | None = None) -> int:
         return 2
 
     # Determine the list of relative filenames to handle
-    files_to_process, status = get_files_to_process(args.file, args.filelist)
+    files_to_process, status = get_files_to_process(args.file, args.filelist, args.items_to_process)
     if status:
         return status
 

tests/rimport/test_build_parser.py

@@ -68,6 +68,27 @@ def test_file_and_list_not_mutually_exclusive(self, capsys):
         args = parser.parse_args(["-file", file, "-list", filelist])
         assert args.file == file
         assert args.filelist == filelist
+        assert args.items_to_process == []
+
+    def test_positional_items_to_process(self):
+        """Test that positional items_to_process are accepted"""
+        parser = rimport.build_parser()
+        items_to_process = ["abc123", "def456"]
+        args = parser.parse_args(items_to_process)
+        assert args.file is None
+        assert args.filelist is None
+        assert args.items_to_process == items_to_process
+
+    def test_file_and_list_ok_with_items_to_process(self):
+        """Test that -file and -list can be used together with items_to_process"""
+        parser = rimport.build_parser()
+        file = "test.txt"
+        filelist = "files.txt"
+        items_to_process = ["abc123", "def456"]
+        args = parser.parse_args(["-file", file, "-list", filelist, *items_to_process])
+        assert args.file == file
+        assert args.filelist == filelist
+        assert args.items_to_process == items_to_process
 
     def test_inputdata_default(self):
         """Test that -inputdata has correct default value."""

tests/rimport/test_get_files_to_process.py

@@ -39,7 +39,7 @@ def test_single_file_relpath(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=filename, filelist=None
+            file=filename, filelist=None, items_to_process=None,
         )
 
         # Verify
@@ -60,7 +60,7 @@ def test_single_file_abspath(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=test_file, filelist=None
+            file=test_file, filelist=None, items_to_process=None,
         )
 
         # Verify
@@ -87,7 +87,7 @@ def test_filelist_relpath_with_relpaths(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist_relpath
+            file=None, filelist=filelist_relpath, items_to_process=None,
         )
 
         # Verify
@@ -113,7 +113,7 @@ def test_filelist_abspath_with_relpaths(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist
+            file=None, filelist=filelist, items_to_process=None,
         )
 
         # Verify
@@ -140,7 +140,7 @@ def test_filelist_relpath_with_abspaths(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist_relpath
+            file=None, filelist=filelist_relpath, items_to_process=None,
         )
 
         # Verify
@@ -166,7 +166,7 @@ def test_filelist_abspath_with_abspaths(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist
+            file=None, filelist=filelist, items_to_process=None,
         )
 
         # Verify
@@ -178,7 +178,7 @@ def test_filelist_not_found(self):
         filelist = "bsfearirn"
         assert not os.path.exists(filelist)
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist
+            file=None, filelist=filelist, items_to_process=None,
         )
         assert result == 2
         assert files_to_process is None
@@ -188,11 +188,81 @@ def test_filelist_empty(self, tmp_path):
         filelist = tmp_path / "bsfearirn"
         filelist.write_text("")
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=filelist
+            file=None, filelist=filelist, items_to_process=[],
         )
         assert result == 2
         assert files_to_process is None
 
+    def test_items_to_process_abspaths(self, tmp_path):
+        """Test giving it a list of absolute paths in items_to_process"""
+        # Setup
+        inputdata_root = tmp_path / "inputdata"
+        inputdata_root.mkdir()
+        staging_root = tmp_path / "staging"
+        staging_root.mkdir()
+
+        filenames = []
+        for i in range(2):
+            filename = inputdata_root / f"test{i}.txt"
+            filenames.append(str(filename))
+            filename.write_text("def567")
+
+        # Run
+        files_to_process, result = rimport.get_files_to_process(
+            file=None, filelist=None, items_to_process=filenames,
+        )
+
+        # Verify
+        assert result == 0
+        assert files_to_process == filenames
+
+    def test_items_to_process_relpaths(self, tmp_path):
+        """Test giving it a list of relative paths in items_to_process"""
+        # Setup
+        inputdata_root = tmp_path / "inputdata"
+        inputdata_root.mkdir()
+
+        filenames = []
+        for i in range(2):
+            filename = inputdata_root / f"test{i}.txt"
+            filenames.append(os.path.basename(filename))
+            filename.write_text("def567")
+
+        # Run
+        files_to_process, result = rimport.get_files_to_process(
+            file=None, filelist=None, items_to_process=filenames,
+        )
+
+        # Verify
+        assert result == 0
+        assert files_to_process == filenames
+
+    def test_items_to_process_mixpaths(self, tmp_path):
+        """Test giving it a list of absolute and relative paths in items_to_process"""
+        # Setup
+        inputdata_root = tmp_path / "inputdata"
+        inputdata_root.mkdir()
+
+        filenames = []
+        for i in range(2):
+            filename = inputdata_root / f"test{i}.txt"
+            filenames.append(os.path.basename(filename))
+            filename.write_text("def567")
+        for i in range(2):
+            filename = inputdata_root / f"test{2*i}.txt"
+            filenames.append(str(filename))
+            filename.write_text("def567")
+        assert len(filenames) == 4
+
+        # Run
+        files_to_process, result = rimport.get_files_to_process(
+            file=None, filelist=None, items_to_process=filenames,
+        )
+
+        # Verify
+        assert result == 0
+        assert files_to_process == filenames
+
     def test_single_file_and_list(self, tmp_path):
         """Test giving it a single file by its relative path"""
         # Setup
@@ -216,18 +286,18 @@ def test_single_file_and_list(self, tmp_path):
 
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=filename, filelist=filelist
+            file=filename, filelist=filelist, items_to_process=None,
         )
 
         # Verify
         assert result == 0
         assert files_to_process == [filename] + filenames
 
-    def test_single_or_list_required(self):
-        """Test that either file or filelist is required"""
+    def test_single_or_filelist_or_list_required(self):
+        """Test that at least one of file, filelist, items_to_process is required"""
         # Run
         files_to_process, result = rimport.get_files_to_process(
-            file=None, filelist=None
+            file=None, filelist=None, items_to_process=None,
         )
 
         # Verify