olaf.utils.path_utils

Functions

natural_sort_key(s)

Key function for sorting strings in "natural" order.

save_df_file(clean_df, save_file, header_info)

is_within_dates(dates, folder_name)

Check if the folder name contains a date that is within the given date range.

Module Contents

olaf.utils.path_utils.natural_sort_key(s)

Key function for sorting strings in “natural” order. :param s: string to sort

Returns:

list of strings and numbers to sort

Return type:

list

Parameters:

s (str)

olaf.utils.path_utils.save_df_file(clean_df, save_file, header_info)
olaf.utils.path_utils.is_within_dates(dates, folder_name)

Check if the folder name contains a date that is within the given date range.

Parameters:
  • dates – Tuple of (start_date, end_date) in string format

  • folder_name – String name of folder which might contain a date

Returns:

True if folder date is in range, False otherwise

Return type:

bool