isolate argparse creation for all remaining pipeline scripts

Author: yocabon

pipeline/kapture_hloc_pipeline_from_kapture_dataset.py

@@ -254,9 +254,9 @@ def hloc_pipeline_from_kapture_dataset(kapture_path_map: str,
         run_python_command(local_export_LTVL2020_path, export_LTVL2020_args, python_binary)
 
 
-def hloc_pipeline_from_kapture_dataset_command_line():
+def hloc_pipeline_from_kapture_dataset_get_parser():
     """
-    Parse the command line arguments to build a colmap map and localize using the given kapture data.
+    get the argparse object for the kapture_hloc_pipeline_from_kapture_dataset.py command
     """
     parser = argparse.ArgumentParser(description=('create a Colmap model (map) from data specified in kapture format.'))
     parser_verbosity = parser.add_mutually_exclusive_group()
@@ -325,6 +325,14 @@ def hloc_pipeline_from_kapture_dataset_command_line():
                                                  'export_LTVL2020'],
                         nargs='+', default=[],
                         help='steps to skip')
+    return parser
+
+
+def hloc_pipeline_from_kapture_dataset_command_line():
+    """
+    Parse the command line arguments to build a colmap map and localize using the given kapture data.
+    """
+    parser = hloc_pipeline_from_kapture_dataset_get_parser()
     args = parser.parse_args()
 
     logger.setLevel(args.verbose)

pipeline/kapture_pipeline_colmap_vocab_tree.py

@@ -165,9 +165,9 @@ def colmap_vocab_tree_pipeline(kapture_map_path: str,
         run_python_command(local_export_LTVL2020_path, export_LTVL2020_args, python_binary)
 
 
-def colmap_vocab_tree_pipeline_command_line():
+def colmap_vocab_tree_pipeline_get_parser():
     """
-    Parse the command line arguments to build a map and localize images using colmap on the given kapture data.
+    get the argparse object for the kapture_pipeline_colmap_vocab_tree.py command
     """
     parser = argparse.ArgumentParser(description='localize images given in kapture format on a colmap map')
     parser_verbosity = parser.add_mutually_exclusive_group()
@@ -226,6 +226,14 @@ def colmap_vocab_tree_pipeline_command_line():
                                                  'export_LTVL2020'],
                         nargs='+', default=[],
                         help='steps to skip')
+    return parser
+
+
+def colmap_vocab_tree_pipeline_command_line():
+    """
+    Parse the command line arguments to build a map and localize images using colmap on the given kapture data.
+    """
+    parser = colmap_vocab_tree_pipeline_get_parser()
     args = parser.parse_args()
 
     logger.setLevel(args.verbose)

pipeline/kapture_pipeline_image_retrieval_benchmark.py

@@ -388,6 +388,9 @@ def image_retrieval_benchmark(kapture_map_path: str,
 
 
 def image_retrieval_benchmark_get_parser():
+    """
+    get the argparse object for the kapture_pipeline_image_retrieval_benchmark.py command
+    """
     parser = argparse.ArgumentParser(description='run the image retrieval benchmark on kapture data')
     parser_verbosity = parser.add_mutually_exclusive_group()
     parser_verbosity.add_argument('-v', '--verbose', nargs='?', default=logging.WARNING, const=logging.INFO,

pipeline/kapture_pipeline_image_retrieval_benchmark_from_pairsfile.py

@@ -348,6 +348,9 @@ def image_retrieval_benchmark_from_pairsfile(kapture_map_path: str,
 
 
 def image_retrieval_benchmark_from_pairsfile_get_parser():
+    """
+    get the argparse object for the kapture_pipeline_image_retrieval_benchmark_from_pairsfile.py command
+    """
     parser = argparse.ArgumentParser(description='run the image retrieval benchmark on kapture data')
     parser_verbosity = parser.add_mutually_exclusive_group()
     parser_verbosity.add_argument('-v', '--verbose', nargs='?', default=logging.WARNING, const=logging.INFO,

pipeline/kapture_pipeline_localize.py

@@ -22,7 +22,9 @@
 import kapture_localization.utils.path_to_kapture  # noqa: F401
 import kapture.utils.logging
 from kapture.utils.paths import safe_remove_file
+
 logger = logging.getLogger('localization_pipeline')
+DEFAULT_TOPK = 20
 
 
 def localize_pipeline(kapture_map_path: str,
@@ -252,9 +254,9 @@ def localize_pipeline(kapture_map_path: str,
         run_python_command(local_export_LTVL2020_path, export_LTVL2020_args, python_binary)
 
 
-def localize_pipeline_command_line():
+def localize_pipeline_get_parser():
     """
-    Parse the command line arguments to localize images on a colmap map using the given kapture data.
+    get the argparse object for the kapture_pipeline_localize.py command
     """
     parser = argparse.ArgumentParser(description='localize images given in kapture format on a colmap map')
     parser_verbosity = parser.add_mutually_exclusive_group()
@@ -303,9 +305,8 @@ def localize_pipeline_command_line():
                                    ' can infer the python binary from the files itself, shebang or extension).')
     parser_python_bin.add_argument('--auto-python-binary', action='store_true', default=False,
                                    help='use sys.executable as python binary.')
-    default_topk = 20
     parser.add_argument('--topk',
-                        default=default_topk,
+                        default=DEFAULT_TOPK,
                         type=int,
                         help='the max number of top retained images when computing image pairs from global features')
     parser.add_argument('--config', default=1, type=int,
@@ -335,6 +336,14 @@ def localize_pipeline_command_line():
     parser.add_argument('--keypoints-type', default=None, help='kapture keypoints type.')
     parser.add_argument('--descriptors-type', default=None, help='kapture descriptors type.')
     parser.add_argument('--global-features-type', default=None, help='kapture global features type.')
+    return parser
+
+
+def localize_pipeline_command_line():
+    """
+    Parse the command line arguments to localize images on a colmap map using the given kapture data.
+    """
+    parser = localize_pipeline_get_parser()
     args = parser.parse_args()
 
     logger.setLevel(args.verbose)
@@ -343,7 +352,8 @@ def localize_pipeline_command_line():
         kapture.utils.logging.getLogger().setLevel(args.verbose)
         kapture_localization.utils.logging.getLogger().setLevel(args.verbose)
 
-    if args.pairsfile_path is not None and args.topk != default_topk:
+    # only show the warning if the user attempted to change the topk value since it'll have no effect
+    if args.pairsfile_path is not None and args.topk != DEFAULT_TOPK:
         logger.warning(f'pairsfile was given explicitely, paramerer topk={args.topk} will be ignored')
 
     args_dict = vars(args)

pipeline/kapture_pipeline_mapping.py

@@ -6,6 +6,7 @@
 """
 
 import argparse
+from ctypes import DEFAULT_MODE
 import logging
 import os
 import os.path as path
@@ -23,6 +24,7 @@
 from kapture.utils.paths import safe_remove_file
 
 logger = logging.getLogger('mapping_pipeline')
+DEFAULT_TOPK = 20
 
 
 def mapping_pipeline(kapture_path: str,
@@ -144,9 +146,9 @@ def mapping_pipeline(kapture_path: str,
         run_python_command(local_build_map_path, build_map_args, python_binary)
 
 
-def mapping_pipeline_command_line():
+def mapping_pipeline_get_parser():
     """
-    Parse the command line arguments to build a colmap map using the given kapture data.
+    get the argparse object for the kapture_pipeline_mapping.py command
     """
     parser = argparse.ArgumentParser(description=('create a Colmap model (map) from data specified in kapture format.'
                                                   'kapture data must contain keypoints, descriptors and '
@@ -190,9 +192,8 @@ def mapping_pipeline_command_line():
                                    ' can infer the python binary from the files itself, shebang or extension).')
     parser_python_bin.add_argument('--auto-python-binary', action='store_true', default=False,
                                    help='use sys.executable as python binary.')
-    default_topk = 20
     parser.add_argument('--topk',
-                        default=default_topk,
+                        default=DEFAULT_TOPK,
                         type=int,
                         help=('the max number of top retained images when computing image pairs from global features'
                               'ignored if global-features-path is None or pairfile is explicitely given'))
@@ -207,6 +208,14 @@ def mapping_pipeline_command_line():
     parser.add_argument('--keypoints-type', default=None, help='kapture keypoints type.')
     parser.add_argument('--descriptors-type', default=None, help='kapture descriptors type.')
     parser.add_argument('--global-features-type', default=None, help='kapture global features type.')
+    return parser
+
+
+def mapping_pipeline_command_line():
+    """
+    Parse the command line arguments to build a colmap map using the given kapture data.
+    """
+    parser = mapping_pipeline_get_parser()
     args = parser.parse_args()
 
     logger.setLevel(args.verbose)
@@ -215,7 +224,8 @@ def mapping_pipeline_command_line():
         kapture.utils.logging.getLogger().setLevel(args.verbose)
         kapture_localization.utils.logging.getLogger().setLevel(args.verbose)
 
-    if args.pairsfile_path is not None and args.topk != default_topk:
+    # only show the warning if the user attempted to change the topk value since it'll have no effect
+    if args.pairsfile_path is not None and args.topk != DEFAULT_TOPK:
         logger.warning(f'pairsfile was given explicitely, paramerer topk={args.topk} will be ignored')
 
     args_dict = vars(args)