argparsing: add ArgumentParser subclass borg's usual defaults

Borg's ArgumentParser (in borg.helpers.argparsing) now subclasses
jsonargparse's ArgumentParser and pre-sets two defaults that every
borg parser uses:

  formatter_class = RawDescriptionHelpFormatter
  add_help        = False

Author: ThomasWaldmann

src/borg/archiver/__init__.py

@@ -246,7 +246,7 @@ def add_argument(*args, **kwargs):
     def build_parser(self):
         from ._common import define_common_options
 
-        parser = ArgumentParser(prog=self.prog, description="Borg - Deduplicated Backups", add_help=False)
+        parser = ArgumentParser(prog=self.prog, description="Borg - Deduplicated Backups")
         # paths and patterns must have an empty list as default everywhere
         parser.common_options = self.CommonOptions(define_common_options)
         parser.add_argument(
@@ -255,10 +255,10 @@ def build_parser(self):
         parser.add_argument("--cockpit", dest="cockpit", action="store_true", help="Start the Borg TUI")
         parser.common_options.add_common_group(parser, provide_defaults=True)
 
-        common_parser = ArgumentParser(add_help=False, prog=self.prog)
+        common_parser = ArgumentParser(prog=self.prog)
         parser.common_options.add_common_group(common_parser)
 
-        mid_common_parser = ArgumentParser(add_help=False, prog=self.prog)
+        mid_common_parser = ArgumentParser(prog=self.prog)
         parser.common_options.add_common_group(mid_common_parser)
 
         if parser.prog == "borgfs":

src/borg/archiver/analyze_cmd.py

@@ -6,7 +6,7 @@
 from ..constants import *  # NOQA
 from ..helpers import bin_to_hex, Error
 from ..helpers import ProgressIndicatorPercent
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..manifest import Manifest
 from ..remote import RemoteRepository
 from ..repository import Repository
@@ -126,12 +126,6 @@ def build_parser_analyze(self, subparsers, common_parser, mid_common_parser):
             to recreate existing archives without them.
             """
         )
-        subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_analyze.__doc__,
-            epilog=analyze_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
-        )
+        subparser = ArgumentParser(parents=[common_parser], description=self.do_analyze.__doc__, epilog=analyze_epilog)
         subparsers.add_subcommand("analyze", subparser, help="analyze archives")
         define_archive_filters_group(subparser)

src/borg/archiver/benchmark_cmd.py

@@ -11,7 +11,7 @@
 from ..helpers import json_print
 from ..helpers import msgpack
 from ..helpers import get_reset_ec
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..item import Item
 from ..platform import SyncFile
 
@@ -346,11 +346,7 @@ def build_parser_benchmarks(self, subparsers, common_parser, mid_common_parser):
         benchmark_epilog = process_epilog("These commands do various benchmarks.")
 
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description="benchmark command",
-            epilog=benchmark_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description="benchmark command", epilog=benchmark_epilog
         )
         subparsers.add_subcommand("benchmark", subparser, help="benchmark command")
 
@@ -398,11 +394,7 @@ def build_parser_benchmarks(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_benchmark_crud.__doc__,
-            epilog=bench_crud_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[common_parser], description=self.do_benchmark_crud.__doc__, epilog=bench_crud_epilog
         )
         benchmark_parsers.add_subcommand(
             "crud", subparser, help="benchmarks Borg CRUD (create, extract, update, delete)."
@@ -423,11 +415,7 @@ def build_parser_benchmarks(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_benchmark_cpu.__doc__,
-            epilog=bench_cpu_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[common_parser], description=self.do_benchmark_cpu.__doc__, epilog=bench_cpu_epilog
         )
         benchmark_parsers.add_subcommand("cpu", subparser, help="benchmarks Borg CPU-bound operations.")
         subparser.add_argument("--json", action="store_true", help="format output as JSON")

src/borg/archiver/check_cmd.py

@@ -3,7 +3,7 @@
 from ..constants import *  # NOQA
 from ..helpers import set_ec, EXIT_WARNING, CancelledByUser, CommandError, IntegrityError
 from ..helpers import yes
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 
 from ..logger import create_logger
 
@@ -182,13 +182,7 @@ def build_parser_check(self, subparsers, common_parser, mid_common_parser):
         ``borg compact`` would remove the archives' data completely.
         """
         )
-        subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_check.__doc__,
-            epilog=check_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
-        )
+        subparser = ArgumentParser(parents=[common_parser], description=self.do_check.__doc__, epilog=check_epilog)
         subparsers.add_subcommand("check", subparser, help="verify the repository")
         subparser.add_argument(
             "--repository-only", dest="repo_only", action="store_true", help="only perform repository checks"

src/borg/archiver/compact_cmd.py

@@ -5,7 +5,7 @@
 from ..cache import write_chunkindex_to_repo_cache, build_chunkindex_from_repo
 from ..cache import files_cache_name, discover_files_cache_names
 from ..helpers import get_cache_dir
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..constants import *  # NOQA
 from ..hashindex import ChunkIndex, ChunkIndexEntry
 from ..helpers import set_ec, EXIT_ERROR, format_file_size, bin_to_hex
@@ -257,13 +257,7 @@ def build_parser_compact(self, subparsers, common_parser, mid_common_parser):
             thus it cannot compute before/after compaction size statistics).
             """
         )
-        subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_compact.__doc__,
-            epilog=compact_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
-        )
+        subparser = ArgumentParser(parents=[common_parser], description=self.do_compact.__doc__, epilog=compact_epilog)
         subparsers.add_subcommand("compact", subparser, help="compact the repository")
         subparser.add_argument(
             "-n", "--dry-run", dest="dry_run", action="store_true", help="do not change the repository"

src/borg/archiver/completion_cmd.py

@@ -65,7 +65,7 @@
     relative_time_marker_validator,
     parse_file_size,
 )
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..helpers.argparsing import _ActionSubCommands
 from ..helpers.argparsing import prepare_actions_context, shtab_prepare_actions, bash_compgen_typehint
 from ..helpers.time import timestamp
@@ -762,11 +762,7 @@ def build_parser_completion(self, subparsers, common_parser, mid_common_parser):
         )
 
         subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_completion.__doc__,
-            epilog=completion_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[common_parser], description=self.do_completion.__doc__, epilog=completion_epilog
         )
         subparsers.add_subcommand("completion", subparser, help="output shell completion script")
         subparser.add_argument(

src/borg/archiver/create_cmd.py

@@ -29,7 +29,7 @@
 from ..helpers import iter_separated
 from ..helpers import MakePathSafeAction
 from ..helpers import Error, CommandError, BackupWarning, FileChangedWarning
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..manifest import Manifest
 from ..patterns import PatternMatcher
 from ..platform import is_win32
@@ -772,13 +772,7 @@ def build_parser_create(self, subparsers, common_parser, mid_common_parser):
         """
         )
 
-        subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_create.__doc__,
-            epilog=create_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
-        )
+        subparser = ArgumentParser(parents=[common_parser], description=self.do_create.__doc__, epilog=create_epilog)
         subparsers.add_subcommand("create", subparser, help="create a backup")
 
         # note: --dry-run and --stats are mutually exclusive, but we do not want to abort when

src/borg/archiver/debug_cmd.py

@@ -10,7 +10,7 @@
 from ..helpers import StableDict
 from ..helpers import archivename_validator, CompressionSpec
 from ..helpers import CommandError, RTError
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..manifest import Manifest
 from ..platform import get_process_id
 from ..repository import Repository, LIST_SCAN_LIMIT, repo_lister
@@ -319,10 +319,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
 
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description="debugging command (not intended for normal use)",
             epilog=debug_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         subparsers.add_subcommand("debug", subparser, help="debugging command (not intended for normal use)")
 
@@ -336,11 +334,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_info.__doc__,
-            epilog=debug_info_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_info.__doc__, epilog=debug_info_epilog
         )
         debug_parsers.add_subcommand("info", subparser, help="show system infos for debugging / bug reports (debug)")
 
@@ -351,10 +345,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_dump_archive_items.__doc__,
             epilog=debug_dump_archive_items_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand("dump-archive-items", subparser, help="dump archive items (metadata) (debug)")
         subparser.add_argument("name", metavar="NAME", type=archivename_validator, help="specify the archive name")
@@ -366,10 +358,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_dump_archive.__doc__,
             epilog=debug_dump_archive_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand("dump-archive", subparser, help="dump decoded archive metadata (debug)")
         subparser.add_argument("name", metavar="NAME", type=archivename_validator, help="specify the archive name")
@@ -382,10 +372,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_dump_manifest.__doc__,
             epilog=debug_dump_manifest_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand("dump-manifest", subparser, help="dump decoded repository metadata (debug)")
         subparser.add_argument("path", metavar="PATH", type=str, help="file to dump data into")
@@ -397,10 +385,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_dump_repo_objs.__doc__,
             epilog=debug_dump_repo_objs_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand("dump-repo-objs", subparser, help="dump repo objects (debug)")
 
@@ -411,10 +397,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_search_repo_objs.__doc__,
             epilog=debug_search_repo_objs_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand("search-repo-objs", subparser, help="search repo objects (debug)")
         subparser.add_argument(
@@ -430,11 +414,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
                 """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_id_hash.__doc__,
-            epilog=debug_id_hash_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_id_hash.__doc__, epilog=debug_id_hash_epilog
         )
         debug_parsers.add_subcommand("id-hash", subparser, help="compute id-hash for some file content (debug)")
         subparser.add_argument(
@@ -448,11 +428,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
                 """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_parse_obj.__doc__,
-            epilog=debug_parse_obj_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_parse_obj.__doc__, epilog=debug_parse_obj_epilog
         )
         debug_parsers.add_subcommand("parse-obj", subparser, help="parse borg object file into meta dict and data")
         subparser.add_argument("id", metavar="ID", type=str, help="hex object ID to get from the repo")
@@ -473,11 +449,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
                 """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_format_obj.__doc__,
-            epilog=debug_format_obj_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_format_obj.__doc__, epilog=debug_format_obj_epilog
         )
         debug_parsers.add_subcommand("format-obj", subparser, help="format file and metadata into a Borg object file")
         subparser.add_argument("id", metavar="ID", type=str, help="hex object ID to get from the repo")
@@ -510,11 +482,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_get_obj.__doc__,
-            epilog=debug_get_obj_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_get_obj.__doc__, epilog=debug_get_obj_epilog
         )
         debug_parsers.add_subcommand("get-obj", subparser, help="get object from repository (debug)")
         subparser.add_argument("id", metavar="ID", type=str, help="hex object ID to get from the repo")
@@ -526,11 +494,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_put_obj.__doc__,
-            epilog=debug_put_obj_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_put_obj.__doc__, epilog=debug_put_obj_epilog
         )
         debug_parsers.add_subcommand("put-obj", subparser, help="put object to repository (debug)")
         subparser.add_argument("id", metavar="ID", type=str, help="hex object ID to put into the repo")
@@ -542,11 +506,7 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         """
         )
         subparser = ArgumentParser(
-            parents=[mid_common_parser],
-            add_help=False,
-            description=self.do_debug_delete_obj.__doc__,
-            epilog=debug_delete_obj_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
+            parents=[mid_common_parser], description=self.do_debug_delete_obj.__doc__, epilog=debug_delete_obj_epilog
         )
         debug_parsers.add_subcommand("delete-obj", subparser, help="delete object from repository (debug)")
         subparser.add_argument(
@@ -560,10 +520,8 @@ def build_parser_debug(self, subparsers, common_parser, mid_common_parser):
         )
         subparser = ArgumentParser(
             parents=[mid_common_parser],
-            add_help=False,
             description=self.do_debug_convert_profile.__doc__,
             epilog=debug_convert_profile_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
         )
         debug_parsers.add_subcommand(
             "convert-profile", subparser, help="convert Borg profile to Python profile (debug)"

src/borg/archiver/delete_cmd.py

@@ -3,7 +3,7 @@
 from ._common import with_repository
 from ..constants import *  # NOQA
 from ..helpers import format_archive, CommandError, bin_to_hex, archivename_validator
-from ..helpers.argparsing import ArgumentParser, RawDescriptionHelpFormatter
+from ..helpers.argparsing import ArgumentParser
 from ..manifest import Manifest
 
 from ..logger import create_logger
@@ -78,13 +78,7 @@ def build_parser_delete(self, subparsers, common_parser, mid_common_parser):
         patterns, see :ref:`borg_patterns`).
         """
         )
-        subparser = ArgumentParser(
-            parents=[common_parser],
-            add_help=False,
-            description=self.do_delete.__doc__,
-            epilog=delete_epilog,
-            formatter_class=RawDescriptionHelpFormatter,
-        )
+        subparser = ArgumentParser(parents=[common_parser], description=self.do_delete.__doc__, epilog=delete_epilog)
         subparsers.add_subcommand("delete", subparser, help="delete archives")
         subparser.add_argument(
             "-n", "--dry-run", dest="dry_run", action="store_true", help="do not change the repository"