freckles.utils package

Submodules

freckles.utils.host_utils module

freckles.utils.host_utils.get_buildah_details(target_string)[source]
freckles.utils.host_utils.get_docker_details(target_string)[source]
freckles.utils.host_utils.get_host_details(host_string)[source]

Parse a string to get user, protocol, host, etc.

Parameters:host_string (str) – the string
Returns:a dict containing the differnt parts
Return type:dict
freckles.utils.host_utils.get_lxd_details(target_string)[source]
freckles.utils.host_utils.get_pi_details(target_string)[source]
freckles.utils.host_utils.get_podman_details(target_string)[source]
freckles.utils.host_utils.get_vagrant_details(target_string)[source]
freckles.utils.host_utils.list_vagrant_hosts()[source]
freckles.utils.host_utils.parse_target_string(target_string)[source]
freckles.utils.host_utils.parse_vagrant_ssh_config_string(config_string)[source]

freckles.utils.profile module

freckles.utils.runs module

class freckles.utils.runs.FrecklesCurrentRunsWatcher[source]

Bases: freckles.utils.runs.FrecklesRunWatcher

current_runs
run_finished(uuid)[source]
run_started(uuid, alias, run_data, index)[source]
stop()[source]
class freckles.utils.runs.FrecklesLogFileHander(run_alias, watch_path=None, created_callback=None, callback=None, finished_callback=None, adapter_log=None, index=0)[source]

Bases: watchdog.events.FileSystemEventHandler

on_created(event)[source]

Called when a file or directory is created.

Parameters:event (DirCreatedEvent or FileCreatedEvent) – Event representing file/directory creation.
on_deleted(event)[source]

Called when a file or directory is deleted.

Parameters:event (DirDeletedEvent or FileDeletedEvent) – Event representing file/directory deletion.
on_modified(event)[source]

Called when a file or directory is modified.

Parameters:event (DirModifiedEvent or FileModifiedEvent) – Event representing file/directory modification.
class freckles.utils.runs.FrecklesRunLogTerminalOutput(run_alias, run_data, watch_path=None, adapter_log=None, index=0)[source]

Bases: freckles.utils.runs.FrecklesLogFileHander

COLORS = ['\x1b[32m', '\x1b[36m', '\x1b[34m', '\x1b[91m', '\x1b[35m', '\x1b[33m', '\x1b[31m']
finished(print_status=True)[source]
updated(data)[source]
updated_adapter(data)[source]
updated_log(data)[source]
class freckles.utils.runs.FrecklesRunWatcher[source]

Bases: object

run_finished(uuid)[source]
run_started(uuid, alias, run_data, index)[source]
stop()[source]
class freckles.utils.runs.FrecklesRunsListFileHandler(callback)[source]

Bases: watchdog.events.FileSystemEventHandler

on_any_event(event)[source]

Catch-all event handler.

Parameters:event (FileSystemEvent) – The event object representing the file system event.
class freckles.utils.runs.FrecklesRunsLogTerminalOutput(watch_path=None, adapter_log=False)[source]

Bases: freckles.utils.runs.FrecklesRunWatcher

run_finished(uuid)[source]
run_started(uuid, alias, run_data, index)[source]
stop()[source]
class freckles.utils.runs.RunWatchManager(*run_watchers)[source]

Bases: object

join_runs_watch()[source]
run_finished(uuid)[source]
run_started(uuid, alias, run_data, index)[source]
start()[source]
stop()[source]
update_current_runs(current_runs)[source]
freckles.utils.runs.clean_runs_log_file()[source]
freckles.utils.runs.convert_log_file_row(row)[source]
freckles.utils.runs.freckles_run_process_exists(run_data)[source]
freckles.utils.runs.get_current_runs()[source]
freckles.utils.runs.get_last_run()[source]
freckles.utils.runs.print_task_detail(run_detail, alias=None, color=None)[source]
freckles.utils.runs.watch_log_file(env_dir, event_handler)[source]
freckles.utils.runs.watch_runs(event_handler)[source]
freckles.utils.runs.write_runs_log(properties, adapter_name, state)[source]

freckles.utils.utils module

freckles.utils.utils.augment_meta_loader_conf(loader_conf_orig)[source]
freckles.utils.utils.convert_dataclass_type_filter(arg_type)[source]
freckles.utils.utils.generate_frecklet_src_jinja_env(template_dir, extra_filters=None)[source]
freckles.utils.utils.print_frecklet_list(frecklet_dict)[source]
freckles.utils.utils.print_multi_column_table(data, headers)[source]
freckles.utils.utils.print_template_error(template_error)[source]
freckles.utils.utils.print_two_column_table(data, header_one, header_two)[source]

freckles.utils.versions module

freckles.utils.versions.get_versions()[source]

Module contents