purge_multitask_logs

sofia_redux.toolkit.utilities.multiprocessing.purge_multitask_logs(log_directory, log_pickle_file, use_logger=None)

Remove all temporary logging files/directories and handle log records.

The user must supply a log_directory containing pickle files of the log records to handle. The log_pickle_file contains the logger used to handle these records. Following completion, both the ‘log_directory` and log_pickle_file will be deleted from the file system.

Parameters:

log_directorystr

The directory in which the log records for each run were stored. This directory will be removed.

log_pickle_filestr

The pickle file containing the logger for multitask. This will be removed.

use_loggerLogger, optional

The logger to handle any log records. If not supplied, defaults to that found in the log_pickle_file.

Returns:

None