cli make and back require the config file

Author: Fallen-Breath

prime_backup/cli/cli_entrypoint.py

@@ -65,7 +65,7 @@ def __create_command_adapters(cls) -> Dict[str, CliCommandAdapterBase]:
 	def main(self):
 		parser = argparse.ArgumentParser(description='Prime Backup v{} CLI tools'.format(cli_utils.get_plugin_version()), formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 		parser.add_argument('-d', '--db', default=_DEFAULT_STORAGE_ROOT, help='Path to the {db} database file, or path to the directory that contains the {db} database file, e.g. "/my/path/{db}", or "/my/path"'.format(db=db_constants.DB_FILE_NAME))
-		parser.add_argument('-c', '--config', help='Path to the Prime Backup config.json file. If omitted, attempt to load ../config/prime_backup/config.json relative to the database directory')
+		parser.add_argument('-c', '--config', help='Path to the Prime Backup config.json file. If omitted, attempt to load ../config/prime_backup/config.json relative to the database directory. Commands that need user backup settings, such as make and back, fail if no config file is found; other commands use default config')
 		parser.add_argument('--version', action='store_true', help='Show version and exit')
 		parser.add_argument('--debug', action='store_true', help='Enable debug logging')
 		subparsers = parser.add_subparsers(title='Command', help='Available commands', dest='command')

prime_backup/cli/cmd/__init__.py

@@ -25,6 +25,10 @@ class CliCommandHandlerBase(ABC):
 	def __init__(self):
 		self.logger: logging.Logger = logger.get()
 
+	@abstractmethod
+	def requires_user_config_file(self) -> bool:
+		raise NotImplementedError()
+
 	@property
 	def config(self) -> Config:
 		return Config.get()
@@ -47,18 +51,20 @@ def init_environment(self, db_path: Path, *, migrate: bool = False, config_path:
 			ErrorReturnCodes.invalid_argument.sys_exit()
 		self.init_db(root_path, create=False, migrate=migrate)
 
-	@classmethod
-	def load_config(cls, root_path: Path, config_path: Optional[Path]) -> Config:
+	def load_config(self, root_path: Path, config_path: Optional[Path]) -> Config:
 		if config_path is None:
 			auto_config_path = root_path.parent / 'config' / 'prime_backup' / 'config.json'
 			if auto_config_path.is_file():
-				config = cls.__load_config(auto_config_path)
+				config = self.__load_config(auto_config_path)
 				logger.get().info('Config file auto-detected and loaded from {!r}'.format(auto_config_path.as_posix()))
+			elif self.requires_user_config_file():
+				logger.get().error('Config file is required for this command, but it was not provided and the auto-detected path {!r} does not exist'.format(auto_config_path.as_posix()))
+				ErrorReturnCodes.invalid_argument.sys_exit()
 			else:
 				config = Config.get_default()
 				logger.get().info('Config file not provided; auto-detected path {!r} does not exist, using default config'.format(auto_config_path.as_posix()))
 		else:
-			config = cls.__load_config(config_path)
+			config = self.__load_config(config_path)
 			logger.get().info('Config file loaded from {!r}'.format(config_path.as_posix()))
 		return config
 

prime_backup/cli/cmd/cmd_back.py

@@ -35,6 +35,10 @@ def __init__(self, args: BackCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return True
+
 	def __get_backup(self) -> BackupInfo:
 		if self.args.backup_id is not None:
 			backup_id = cli_utils.parse_backup_id(self.args.backup_id)

prime_backup/cli/cmd/cmd_db_overview.py

@@ -20,6 +20,10 @@ def __init__(self, args: DbOverviewCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	@staticmethod
 	def __size_str(size: int) -> str:
 		return '{} ({} bytes)'.format(ByteCount(size).auto_str(), size)

prime_backup/cli/cmd/cmd_export.py

@@ -34,6 +34,10 @@ def __init__(self, args: ExportCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def handle(self):
 		fmt = cli_utils.get_ebf(self.args.output_path, self.args.format)
 		self.init_environment_from_args(self.args)

prime_backup/cli/cmd/cmd_extract.py

@@ -24,6 +24,10 @@ def __init__(self, args: ExtractCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def handle(self):
 		self.init_environment_from_args(self.args)
 

prime_backup/cli/cmd/cmd_fuse.py

@@ -27,6 +27,10 @@ def __init__(self, args: FuseCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def __adjust_fuse_config(self):
 		from prime_backup.cli.fuse.config import FuseConfig
 		fuse_config = FuseConfig.get()

prime_backup/cli/cmd/cmd_import.py

@@ -27,6 +27,10 @@ def __init__(self, args: ImportCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def handle(self):
 		fmt = cli_utils.get_ebf(self.args.input_path, self.args.format)
 		self.init_environment_from_args(self.args)

prime_backup/cli/cmd/cmd_init.py

@@ -22,6 +22,10 @@ def __init__(self, args: InitCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def handle(self):
 		root_path = self.args.db_path
 		if root_path.name == db_constants.DB_FILE_NAME and not root_path.is_dir():

prime_backup/cli/cmd/cmd_list.py

@@ -21,6 +21,10 @@ def __init__(self, args: ListCommandArgs):
 		super().__init__()
 		self.args = args
 
+	@override
+	def requires_user_config_file(self) -> bool:
+		return False
+
 	def handle(self):
 		self.init_environment_from_args(self.args)