Settings Command (autotransform.scripts.commands.settings)
The settings command is used to update AutoTransform settings, such as scheduler.json files, manager.json files, configs and imported components.
- autotransform.scripts.commands.settings.add_args(parser: ArgumentParser) None
Adds the args to a subparser that are required to update/view settings.
- Parameters
parser (ArgumentParser) – The parser for the command.
- autotransform.scripts.commands.settings.get_components_to_add(component_dict: Dict[str, ComponentImport]) Dict[str, ComponentImport]
Gets a dictionary of new components to add to the custom component imports.
- Parameters
component_dict (Dict[str, ComponentImport]) – The existing custom components.
- Returns
The components to add to the dictionary.
- Return type
Dict[str, ComponentImport]
- autotransform.scripts.commands.settings.get_components_to_remove(component_dict: Dict[str, ComponentImport]) List[str]
Gets a list of components to remove from the dictionary using console input.
- Parameters
component_dict (Dict[str, ComponentImport]) – The custom component dictionary.
- Returns
The keys to remove from the dictionary.
- Return type
List[str]
- autotransform.scripts.commands.settings.handle_config(path: str, config_type: str, update: bool) None
Handles updating a config file.
- Parameters
path (str) – The path to the file.
config_type (str) – The type of config being updated (i.e. user).
update (bool) – Whether to update the config.
- autotransform.scripts.commands.settings.handle_custom_components(update: bool) None
Handle updating/viewing custom components.
- Parameters
update (bool) – Whether to apply updates to the custom components.
- autotransform.scripts.commands.settings.handle_manager(update: bool) None
Handle updating/viewing the Manager.
- Parameters
update (bool) – Whether to apply updates to the Manager.
- autotransform.scripts.commands.settings.handle_scheduler(update: bool) None
Handle updating/viewing the Scheduler.
- Parameters
update (bool) – Whether to apply updates to the Scheduler.
- autotransform.scripts.commands.settings.handle_schema(update: bool, file_path: str) None
Handle updating/viewing a Schema.
- Parameters
update (bool) – Whether to apply updates to the Schema.
file_path (str) – The path to the Schema file.
- autotransform.scripts.commands.settings.settings_command_main(args: Namespace) None
The main method for the settings command, handles the actual execution of updating and viewing settings.
- Parameters
args (Namespace) – The arguments supplied to the settings command.