Source code for ptulsconv.reporting

"""
Reporting logic. These methods provide reporting methods to the package and
take some pains to provide nice-looking escape codes if we're writing to a
tty.
"""

import sys



[docs]
def print_banner_style(message):
    if sys.stderr.isatty():
        sys.stderr.write("\n\033[1m%s\033[0m\n\n" % message)
    else:
        sys.stderr.write("\n%s\n\n" % message)




[docs]
def print_section_header_style(message):
    if sys.stderr.isatty():
        sys.stderr.write("\n\033[4m%s\033[0m\n\n" % message)
    else:
        sys.stderr.write("%s\n\n" % message)




[docs]
def print_status_style(message):
    if sys.stderr.isatty():
        sys.stderr.write("\033[3m - %s\033[0m\n" % message)
    else:
        sys.stderr.write(" - %s\n" % message)




[docs]
def print_warning(warning_string):
    if sys.stderr.isatty():
        sys.stderr.write("\033[3m - %s\033[0m\n" % warning_string)
    else:
        sys.stderr.write(" - %s\n" % warning_string)




[docs]
def print_advisory_tagging_error(failed_string, position,
                                 parent_track_name=None, clip_time=None):
    if sys.stderr.isatty():
        sys.stderr.write("\n")
        sys.stderr.write(" ! \033[33;1mTagging error: \033[0m")
        ok_string = failed_string[:position]
        not_ok_string = failed_string[position:]
        sys.stderr.write("\033[32m\"%s\033[31;1m%s\"\033[0m\n" %
                         (ok_string, not_ok_string))

        if parent_track_name is not None:
            sys.stderr.write(" !   > On track \"%s\"\n" % parent_track_name)

        if clip_time is not None:
            sys.stderr.write(" !   > In clip name at %s\n" % clip_time)
    else:
        sys.stderr.write("\n")
        sys.stderr.write(" ! Tagging error: \"%s\"\n" % failed_string)
        sys.stderr.write(" ! %s _______________⬆\n" % (" " * position))

        if parent_track_name is not None:
            sys.stderr.write(" !   > On track \"%s\"\n" % parent_track_name)

        if clip_time is not None:
            sys.stderr.write(" !   > In clip name at %s\n" % clip_time)

    sys.stderr.write("\n")




[docs]
def print_fatal_error(message):
    if sys.stderr.isatty():
        sys.stderr.write("\n\033[5;31;1m*** %s ***\033[0m\n" % message)
    else:
        sys.stderr.write("\n%s\n" % message)