utils_logging.py

import logging


def text_emphasis(text, char="*", num_char=20):
    """
    Add formatting emphasis to text with asterisks
    :param text: str
    :return: str
    """
    return char * num_char + str(text) + char * num_char


def elapsed_time(start, finish):
    """
    TODO docstring
    :param start:
    :param finish:
    :return:
    """
    return "Time - {:.0f} sec | {:.2f} min".format(finish - start, (finish - start) / 60)


def prepare_logging_str(ex, attr, one_line=True):
    logging_str = attr + ": " + str(getattr(ex, attr, "NO " + attr))
    if one_line:
        logging_str = logging_str.replace("\r\n", " ")
        logging_str = logging_str.replace("\n", " ")
    return logging_str


def log_exception(ex, migration_log=None, extra_msg=""):
    logging.error(text_emphasis("Error", char='!', num_char=10))

    ex_type = "type: " + str(type(ex))
    ex_doc = prepare_logging_str(ex, "__doc__")
    ex_msg = prepare_logging_str(ex, "message")
    ex_str = prepare_logging_str(ex, "__str__")
    if migration_log is not None:
        migration_log["error_msg_list"].append(extra_msg + ex_type + ex_doc + ex_msg + ex_str)

    logging.error(extra_msg)
    logging.error(ex_type + ex_doc + ex_msg + ex_str)
    logging.error(ex)
    logging.error(text_emphasis("", char='!', num_char=13))


def log_uploaded_file_stats(migration_log):
    concrete_file_num = len(migration_log["concrete_file_list"])
    concrete_file_size_total = sum(
        [f["file_size_mb"] if f["file_size_mb"] > 0 else 0 for f in migration_log["concrete_file_list"]])
    logging.info("Uploaded concrete files: {}; Size {} MB".format(concrete_file_num, concrete_file_size_total))

    logging.info("Created ref files: {}".format(len(migration_log["ref_file_list"])))
    ref_big_file_list = list(filter(lambda f: (f["big_file_flag"] == True), migration_log["ref_file_list"]))
    logging.info("Big ref files list:".format(len(ref_big_file_list)))
    for f_big in ref_big_file_list:
        logging.info(f_big)

    logging.info("Not-resolving ref files: {}".format(len(migration_log["bad_ref_file_list"])))
    bad_ref_file_list = migration_log["bad_ref_file_list"]
    logging.info("Not-resolving ref files list:".format(len(bad_ref_file_list)))
    for bad_ref in bad_ref_file_list:
        logging.info(bad_ref)