xmipp3-installer 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

xmipp3_installer/application/cli/arguments/params.py

@@ -1,6 +1,6 @@
 """### Containis all param constants needed for the argument parsing part of Xmipp's installation."""
 
-from xmipp3_installer.application.cli.arguments import DEFAULT_BUILD_DIR
+from xmipp3_installer.application.cli import arguments
 
 # Definition of all params found in the
 SHORT_VERSION = 'short'
@@ -14,6 +14,8 @@ PARAM_BRANCH = 'branch'
 PARAM_MODELS_DIRECTORY = 'directory'
 PARAM_TEST_NAMES = 'testNames'
 PARAM_SHOW_TESTS = 'show'
+PARAM_ALL_FUNCTIONS = 'all_functions'
+PARAM_ALL_PROGRAMS = 'all_programs'
 PARAM_GIT_COMMAND = 'command'
 PARAM_LOGIN = 'login'
 PARAM_MODEL_PATH = 'modelPath'
@@ -21,56 +23,64 @@ PARAM_UPDATE = 'update'
 PARAM_OVERWRITE = 'overwrite'
 PARAM_KEEP_OUTPUT = "keep_output"
 PARAMS = {
-	PARAM_SHORT: {
-		LONG_VERSION: "--short",
-		DESCRIPTION: "If set, only version number is shown."
-	},
-	PARAM_JOBS: {
-		SHORT_VERSION: "-j",
-		LONG_VERSION: "--jobs",
-		DESCRIPTION: "Number of jobs. Defaults to all available."
-	},
-	PARAM_BRANCH: {
-		SHORT_VERSION: "-b",
-		LONG_VERSION: "--branch",
-		DESCRIPTION: "Branch for the source repositories."
-	},
-	PARAM_MODELS_DIRECTORY: {
-		SHORT_VERSION: "-d",
-		LONG_VERSION: "--directory",
-		DESCRIPTION: f"Directory where models will be saved. Default is \"{DEFAULT_BUILD_DIR}\"."
-	},
-	PARAM_TEST_NAMES: {
-		SHORT_VERSION: PARAM_TEST_NAMES,
-		DESCRIPTION: "Name of the tests to run. If combined with --show, greps the test names from the test list."
-	},
-	PARAM_SHOW_TESTS: {
-		LONG_VERSION: "--show",
-		DESCRIPTION: "Shows the tests available and how to invoke those."
-	},
-	PARAM_GIT_COMMAND: {
-		SHORT_VERSION: PARAM_GIT_COMMAND,
-		DESCRIPTION: "Git command to run on all source repositories."
-	},
-	PARAM_LOGIN: {
-		SHORT_VERSION: "login",
-		DESCRIPTION: "Login (usr@server) for remote host to upload the model with. Must have write permisions to such machine."
-	},
-	PARAM_MODEL_PATH: {
-		SHORT_VERSION: PARAM_MODEL_PATH,
-		DESCRIPTION: "Path to the model to upload to remote host."
-	},
-	PARAM_UPDATE: {
-		LONG_VERSION: "--update",
-		DESCRIPTION: "Flag to update an existing model"
-	},
-	PARAM_OVERWRITE: {
-		SHORT_VERSION: "-o",
-		LONG_VERSION: "--overwrite",
-		DESCRIPTION: "If set, current config file will be overwritten with a new one."
-	},
-	PARAM_KEEP_OUTPUT: {
-		LONG_VERSION: "--keep-output",
-		DESCRIPTION: "If set, output sent through the terminal won't substitute lines, looking more like the log."
-	}
+  PARAM_SHORT: {
+    LONG_VERSION: "--short",
+    DESCRIPTION: "If set, only version number is shown."
+  },
+  PARAM_JOBS: {
+    SHORT_VERSION: "-j",
+    LONG_VERSION: "--jobs",
+    DESCRIPTION: "Number of jobs. Defaults to all available."
+  },
+  PARAM_BRANCH: {
+    SHORT_VERSION: "-b",
+    LONG_VERSION: "--branch",
+    DESCRIPTION: "Branch for the source repositories."
+  },
+  PARAM_MODELS_DIRECTORY: {
+    SHORT_VERSION: "-d",
+    LONG_VERSION: "--directory",
+    DESCRIPTION: f"Directory where models will be saved. Default is \"{arguments.DEFAULT_MODELS_DIR}\"."
+  },
+  PARAM_TEST_NAMES: {
+    SHORT_VERSION: PARAM_TEST_NAMES,
+    DESCRIPTION: "Name of the tests to run."
+  },
+  PARAM_SHOW_TESTS: {
+    LONG_VERSION: "--show",
+    DESCRIPTION: "Shows the tests available and how to invoke those."
+  },
+  PARAM_ALL_FUNCTIONS : {
+    LONG_VERSION: "--all-functions",
+    DESCRIPTION: "If set, all function tests will be run."
+  },
+  PARAM_ALL_PROGRAMS : {
+    LONG_VERSION: "--all-programs",
+    DESCRIPTION: "If set, all program tests will be run."
+  },
+  PARAM_GIT_COMMAND: {
+    SHORT_VERSION: PARAM_GIT_COMMAND,
+    DESCRIPTION: "Git command to run on all source repositories."
+  },
+  PARAM_LOGIN: {
+    SHORT_VERSION: "login",
+    DESCRIPTION: "Login (usr@server) for remote host to upload the model with. Must have write permissions to such machine."
+  },
+  PARAM_MODEL_PATH: {
+    SHORT_VERSION: PARAM_MODEL_PATH,
+    DESCRIPTION: "Path to the model to upload to remote host."
+  },
+  PARAM_UPDATE: {
+    LONG_VERSION: "--update",
+    DESCRIPTION: "Flag to update an existing model"
+  },
+  PARAM_OVERWRITE: {
+    SHORT_VERSION: "-o",
+    LONG_VERSION: "--overwrite",
+    DESCRIPTION: "If set, current config file will be overwritten with a new one."
+  },
+  PARAM_KEEP_OUTPUT: {
+    LONG_VERSION: "--keep-output",
+    DESCRIPTION: "If set, output sent through the terminal won't substitute lines, looking more like the log."
+  }
 }

xmipp3_installer/application/cli/cli.py

@@ -16,256 +16,237 @@ from xmipp3_installer.application.logger.logger import logger
 from xmipp3_installer.installer import installer_service
 
 def main():
-	"""### Main entry point function that starts the execution."""
-	parser = __generate_parser()
-	parser = __add_params(parser)
-	__add_default_usage_mode()
-	args = vars(parser.parse_args())
-	__validate_args(args, parser)
-	installation_manager = installer_service.InstallationManager(args)
-	ret_code = installation_manager.run_installer()
-	sys.exit(ret_code)
+  """### Main entry point function that starts the execution."""
+  parser = __generate_parser()
+  parser = __add_params(parser)
+  __add_default_usage_mode()
+  args = vars(parser.parse_args())
+  __validate_args(args, parser)
+  installation_manager = installer_service.InstallationManager(args)
+  ret_code = installation_manager.run_installer()
+  sys.exit(ret_code)
 
 def __generate_parser() -> argparse.ArgumentParser:
-	"""
-	### Generates an argument parser for the installer.
+  """
+  ### Generates an argument parser for the installer.
 
-	#### Returns:
-	- (ArgumentParser): Argument parser.
-	"""
-	return ErrorHandlerArgumentParser(
-		prog=arguments.XMIPP_PROGRAM_NAME,
-		formatter_class=GeneralHelpFormatter,
-	)
+  #### Returns:
+  - (ArgumentParser): Argument parser.
+  """
+  return ErrorHandlerArgumentParser(
+    prog=arguments.XMIPP_PROGRAM_NAME,
+    formatter_class=GeneralHelpFormatter,
+  )
 
 def __add_params(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
-	"""
-	### Inserts the params into the given parser.
+  """
+  ### Inserts the params into the given parser.
 
-	#### Params:
-	- parser (ArgumentParser): Argument parser.
+  #### Params:
+  - parser (ArgumentParser): Argument parser.
 
-	#### Returns:
-	- (ArgumentParser): Argument parser with inserted params.
-	"""
-	subparsers = parser.add_subparsers(dest=modes.MODE)
-	default_jobs = __get_default_job_number()
+  #### Returns:
+  - (ArgumentParser): Argument parser with inserted params.
+  """
+  subparsers = parser.add_subparsers(dest=modes.MODE)
+  default_jobs = __get_default_job_number()
 
-	add_model_subparser = subparsers.add_parser(modes.MODE_ADD_MODEL, formatter_class=ModeHelpFormatter)
-	__add_params_mode_add_model(add_model_subparser)
+  add_model_subparser = subparsers.add_parser(modes.MODE_ADD_MODEL, formatter_class=ModeHelpFormatter)
+  __add_params_mode_add_model(add_model_subparser)
 
-	all_subparser = subparsers.add_parser(modes.MODE_ALL, formatter_class=ModeHelpFormatter)
-	__add_params_mode_all(all_subparser, default_jobs)
+  all_subparser = subparsers.add_parser(modes.MODE_ALL, formatter_class=ModeHelpFormatter)
+  __add_params_mode_all(all_subparser, default_jobs)
 
-	subparsers.add_parser(modes.MODE_CLEAN_ALL, formatter_class=ModeHelpFormatter)
+  subparsers.add_parser(modes.MODE_CLEAN_ALL, formatter_class=ModeHelpFormatter)
 
-	subparsers.add_parser(modes.MODE_CLEAN_BIN, formatter_class=ModeHelpFormatter)
+  subparsers.add_parser(modes.MODE_CLEAN_BIN, formatter_class=ModeHelpFormatter)
 
-	compile_and_install_subparser = subparsers.add_parser(modes.MODE_COMPILE_AND_INSTALL, formatter_class=ModeHelpFormatter)
-	__add_params_mode_compile_and_install(compile_and_install_subparser, default_jobs)
+  compile_and_install_subparser = subparsers.add_parser(modes.MODE_COMPILE_AND_INSTALL, formatter_class=ModeHelpFormatter)
+  __add_params_mode_compile_and_install(compile_and_install_subparser, default_jobs)
 
-	build_config_subparser = subparsers.add_parser(modes.MODE_CONFIG_BUILD, formatter_class=ModeHelpFormatter)
-	__add_params_mode_config_build(build_config_subparser)
+  build_config_subparser = subparsers.add_parser(modes.MODE_CONFIG_BUILD, formatter_class=ModeHelpFormatter)
+  __add_params_mode_config_build(build_config_subparser)
 
-	config_subparser = subparsers.add_parser(modes.MODE_CONFIG, formatter_class=ModeHelpFormatter)
-	__add_params_mode_config(config_subparser)
+  config_subparser = subparsers.add_parser(modes.MODE_CONFIG, formatter_class=ModeHelpFormatter)
+  __add_params_mode_config(config_subparser)
 
-	get_models_subparser = subparsers.add_parser(modes.MODE_GET_MODELS, formatter_class=ModeHelpFormatter)
-	__add_params_mode_get_models(get_models_subparser)
+  get_models_subparser = subparsers.add_parser(modes.MODE_GET_MODELS, formatter_class=ModeHelpFormatter)
+  __add_params_mode_get_models(get_models_subparser)
 
-	get_sources_subparser = subparsers.add_parser(modes.MODE_GET_SOURCES, formatter_class=ModeHelpFormatter)
-	__add_params_mode_get_sources(get_sources_subparser)
+  get_sources_subparser = subparsers.add_parser(modes.MODE_GET_SOURCES, formatter_class=ModeHelpFormatter)
+  __add_params_mode_get_sources(get_sources_subparser)
 
-	git_subparser = subparsers.add_parser(modes.MODE_GIT, formatter_class=ModeHelpFormatter)
-	__add_params_mode_git(git_subparser)
+  git_subparser = subparsers.add_parser(modes.MODE_GIT, formatter_class=ModeHelpFormatter)
+  __add_params_mode_git(git_subparser)
 
-	test_subparser = subparsers.add_parser(modes.MODE_TEST, formatter_class=ModeHelpFormatter)
-	__add_params_mode_test(test_subparser)
+  test_subparser = subparsers.add_parser(modes.MODE_TEST, formatter_class=ModeHelpFormatter)
+  __add_params_mode_test(test_subparser)
 
-	version_subparser = subparsers.add_parser(modes.MODE_VERSION, formatter_class=ModeHelpFormatter)
-	__add_params_mode_version(version_subparser)
+  version_subparser = subparsers.add_parser(modes.MODE_VERSION, formatter_class=ModeHelpFormatter)
+  __add_params_mode_version(version_subparser)
 
-	return parser
+  return parser
 
 def __add_params_mode_add_model(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "addModel"
+  """
+  ### Adds params for mode "addModel".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_LOGIN))
-	subparser.add_argument(*format.get_param_names(params.PARAM_MODEL_PATH))
-	subparser.add_argument(*format.get_param_names(params.PARAM_UPDATE), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_LOGIN))
+  subparser.add_argument(*format.get_param_names(params.PARAM_MODEL_PATH))
+  subparser.add_argument(*format.get_param_names(params.PARAM_UPDATE), action='store_true')
 
 def __add_params_mode_all(subparser: argparse.ArgumentParser, default_jobs: int):
-	"""
-	### Adds params for mode "all"
+  """
+  ### Adds params for mode "all".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	- default_jobs (int): Default number of jobs to run the task.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_JOBS), type=int, default=default_jobs)
-	subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
-	subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  - default_jobs (int): Default number of jobs to run the task.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_JOBS), type=int, default=default_jobs)
+  subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
+  subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
 
 def __add_params_mode_compile_and_install(subparser: argparse.ArgumentParser, default_jobs: int):
-	"""
-	### Adds params for mode "compileAndInstall"
+  """
+  ### Adds params for mode "compileAndInstall".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	- default_jobs (int): Default number of jobs to run the task.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_JOBS), type=int, default=default_jobs)
-	subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
-	subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  - default_jobs (int): Default number of jobs to run the task.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_JOBS), type=int, default=default_jobs)
+  subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
+  subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
 
 def __add_params_mode_config_build(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "configBuild"
+  """
+  ### Adds params for mode "configBuild".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
 
 def __add_params_mode_config(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "config"
+  """
+  ### Adds params for mode "config".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_OVERWRITE), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_OVERWRITE), action='store_true')
 
 def __add_params_mode_get_models(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "getModels"
+  """
+  ### Adds params for mode "getModels".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(
-		*format.get_param_names(params.PARAM_MODELS_DIRECTORY),
-		default=__get_project_root_subpath(arguments.DEFAULT_MODELS_DIR)
-	)
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(
+    *format.get_param_names(params.PARAM_MODELS_DIRECTORY),
+    default=os.path.abspath(arguments.DEFAULT_MODELS_DIR)
+  )
 
 def __add_params_mode_get_sources(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "getSources"
+  """
+  ### Adds params for mode "getSources".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
-	subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_BRANCH))
+  subparser.add_argument(*format.get_param_names(params.PARAM_KEEP_OUTPUT), action='store_true')
 
 def __add_params_mode_git(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "git"
+  """
+  ### Adds params for mode "git".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_GIT_COMMAND), nargs='+')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_GIT_COMMAND), nargs='+')
 
 def __add_params_mode_test(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "test"
-
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_TEST_NAMES), nargs='*', default=None)
-	subparser.add_argument(*format.get_param_names(params.PARAM_SHOW_TESTS), action='store_true')
+  """
+  ### Adds params for mode "test".
+
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  group = subparser.add_mutually_exclusive_group(required=True)
+  group.add_argument(*format.get_param_names(params.PARAM_TEST_NAMES), nargs='*', default=[])
+  group.add_argument(*format.get_param_names(params.PARAM_SHOW_TESTS), action='store_true')
+  group.add_argument(*format.get_param_names(params.PARAM_ALL_FUNCTIONS), action='store_true')
+  group.add_argument(*format.get_param_names(params.PARAM_ALL_PROGRAMS), action='store_true')
 
 def __add_params_mode_version(subparser: argparse.ArgumentParser):
-	"""
-	### Adds params for mode "version"
+  """
+  ### Adds params for mode "version".
 
-	#### Params:
-	- subparser (ArgumentParser): Subparser to add the params to.
-	"""
-	subparser.add_argument(*format.get_param_names(params.PARAM_SHORT), action='store_true')
+  #### Params:
+  - subparser (ArgumentParser): Subparser to add the params to.
+  """
+  subparser.add_argument(*format.get_param_names(params.PARAM_SHORT), action='store_true')
 
 def __get_default_job_number() -> int:
-	"""
-	### Gets the default number of jobs to be used by parallelizable tasks.
-	Returned number will be 120% of CPU cores, due to not all jobs taking 
-	100% of CPU time continuously.
-
-	#### Returns:
-	- (int): Default number of jobs.
-	"""
-	return multiprocessing.cpu_count() + int(multiprocessing.cpu_count() * 0.2)
-
-def __get_project_root_subpath(subpath: str) -> str:
-	"""
-	### Returns a subpath of Xmipp's root directory.
-
-	#### Params:
-	- subpath (str): Subpath inside the root directory.
-
-	#### Returns:
-	- (str): Absolute path to given subpath.
-	"""
-	return os.path.join(__get_project_root_dir(), subpath)
+  """
+  ### Gets the default number of jobs to be used by parallelizable tasks.
 
-def __get_project_root_dir() -> str:
-	"""
-	### Returns the root directory of Xmipp.
+  Returned number will be 120% of CPU cores, due to not all jobs taking 
+  100% of CPU time continuously.
 
-	#### Returns:
-	- (str): Absolute path to Xmipp's root directory.
-	"""
-	return os.path.dirname(os.path.abspath(__file__))
+  #### Returns:
+  - (int): Default number of jobs.
+  """
+  return multiprocessing.cpu_count() + int(multiprocessing.cpu_count() * 0.2)
 
 def __add_default_usage_mode():
-	"""
-	### Sets the usage mode as the default one when a mode has not been specifically provided.
-	"""
-	no_args_provided = len(sys.argv) == 1
-	args_provided = len(sys.argv) > 1
-	if no_args_provided or (
-		args_provided and __is_first_arg_optional() and not __help_requested()
-		): 
-		sys.argv.insert(1, modes.MODE_ALL)
+  """### Sets the usage mode as the default one when a mode has not been specifically provided."""
+  no_args_provided = len(sys.argv) == 1
+  args_provided = len(sys.argv) > 1
+  if no_args_provided or (
+    args_provided and __is_first_arg_optional() and not __help_requested()
+    ): 
+    sys.argv.insert(1, modes.MODE_ALL)
 
 def __is_first_arg_optional() -> bool:
-	"""
-	### Returns True if the first argument provided is optional.
+  """
+  ### Returns True if the first argument provided is optional.
 
-	#### Returns:
-	- (bool): True if the first argument received is optional.
-	"""
-	return sys.argv[1].startswith('-')
+  #### Returns:
+  - (bool): True if the first argument received is optional.
+  """
+  return sys.argv[1].startswith('-')
 
 def __help_requested() -> bool:
-	"""
-	### Returns True if help is at least one of the args.
+  """
+  ### Returns True if help is at least one of the args.
 
-	#### Returns:
-	- (bool): True if help is at least one of the args.
-	"""
-	return '-h' in sys.argv or '--help' in sys.argv
+  #### Returns:
+  - (bool): True if help is at least one of the args.
+  """
+  return '-h' in sys.argv or '--help' in sys.argv
 
 def __validate_args(args: Dict[str, Any], parser: argparse.ArgumentParser):
-	"""
-	### Performs validations on the arguments.
-
-	#### Params:
-	- args (dict(str, any)): Arguments to be validated.
-	- parser (ArgumentParser): Argument parser.
-	"""
-	jobs = args.get('jobs', 1)
-	if jobs < 1:
-		parser.error(f"Wrong job number \"{jobs}\". Number of jobs has to be 1 or greater.")
-	
-	branch = args.get('branch')
-	if branch is not None and len(branch.split(' ')) > 1:
-		parser.error(f"Incorrect branch name \"{branch}\". Branch names can only be one word long.")
-	
-	if args.get('keep_output', False):
-		logger.set_allow_substitution(False)
+  """
+  ### Performs validations on the arguments.
+
+  #### Params:
+  - args (dict(str, any)): Arguments to be validated.
+  - parser (ArgumentParser): Argument parser.
+  """
+  jobs = args.get('jobs', 1)
+  if jobs < 1:
+    parser.error(f"Wrong job number \"{jobs}\". Number of jobs has to be 1 or greater.")
+  
+  branch = args.get('branch')
+  if branch is not None and len(branch.split(' ')) > 1:
+    parser.error(f"Incorrect branch name \"{branch}\". Branch names can only be one word long.")
+  
+  if args.get('keep_output', False):
+    logger.set_allow_substitution(False)