[cli][app] Add --ignore-user-config flag #240

Author: Breakthrough

docs/changelog.md

@@ -5,6 +5,16 @@
 
 #### Changelog
 
+### 1.8.1 (August 27, 2025)
+
+#### Release Notes
+
+Fixes issue with application not loading config files saved with v1.8.
+
+#### Changelog
+
+ * [general] Add `--ignore-user-config` flag to both `dvr-scan` and `dvr-scan-app` commands to allow the application to run even if the user config file is corrupted
+
 
 ### 1.8 (August 23, 2025)
 

dvr_scan/app/__main__.py

@@ -92,6 +92,13 @@ def get_cli_parser():
         version=get_license_info(),
     )
 
+    parser.add_argument(
+        "--ignore-user-config",
+        action="store_true",
+        default=False,
+        help=("Ignore loading the user config file if present."),
+    )
+
     parser.add_argument(
         "--debug",
         action="store_true",
@@ -130,6 +137,9 @@ def main():
     # Parse CLI args, override config if an override was specified on the command line.
     try:
         args = get_cli_parser().parse_args()
+        if args.ignore_user_config:
+            config_load_error = None
+            user_config = ConfigRegistry()
         init_logging(args, config)
         init_log += [(logging.INFO, "DVR-Scan Application %s" % dvr_scan.__version__)]
         if config_load_error and not hasattr(args, "config"):

dvr_scan/cli.py

@@ -492,6 +492,13 @@ def get_cli_parser(user_config: ConfigRegistry):
         help=("Use OpenCV provided presentation timestamp instead of calculated version."),
     )
 
+    parser.add_argument(
+        "--ignore-user-config",
+        action="store_true",
+        default=False,
+        help=("Ignore loading the user config file if present."),
+    )
+
     parser.add_argument(
         "--debug",
         action="store_true",

dvr_scan/controller.py

@@ -86,6 +86,9 @@ def parse_settings() -> ty.Optional[ScanSettings]:
     # Parse CLI args, override config if an override was specified on the command line.
     try:
         args = get_cli_parser(config).parse_args()
+        if args.ignore_user_config:
+            config_load_error = None
+            user_config = ConfigRegistry()
         debug_mode = args.debug
         init_logging(args=args, config=config)
         init_log += [(logging.INFO, "DVR-Scan %s" % dvr_scan.__version__)]

tests/test_cli.py

@@ -42,6 +42,7 @@
     "0",
     "--threshold",
     "0.2",
+    "--ignore-user-config"
 ]
 BASE_COMMAND_NUM_EVENTS = 3