freegenes.logger package¶

Submodules¶

freegenes.logger.compatibility module¶

freegenes.logger.compatibility.decodeUtf8String(inputStr)[source]¶

Convert an UTF8 sequence into a string

Required for compatibility with Python 2 where str==bytes inputStr – Either a str or bytes instance with UTF8 encoding

freegenes.logger.message module¶

class freegenes.logger.message.FreeGenesMessage(MESSAGELEVEL=None)[source]¶

Bases: object

abort(message)[source]¶

addColor(level, text)[source]¶: addColor to the prompt (usually prefix) if terminal supports, and specified to do so

critical(message)[source]¶

custom(prefix, message, color='\x1b[95m')[source]¶

debug(message)[source]¶

emit(level, message, prefix=None, color=None)[source]¶: emit is the main function to print the message optionally with a prefix :param level: the level of the message :param message: the message to print :param prefix: a prefix for the message

emitError(level)[source]¶: determine if a level should print to stderr, includes all levels but INFO and QUIET

emitOutput(level)[source]¶: determine if a level should print to stdout only includes INFO

error(message)[source]¶

exit(message, return_code=1)[source]¶

get_logs(join_newline=True)[source]¶: ‘get_logs will return the complete history, joined by newline (default) or as is.

info(message)[source]¶

isEnabledFor(messageLevel)[source]¶: check if a messageLevel is enabled to emit a level

is_quiet()[source]¶: is_quiet returns true if the level is under 1

log(message)[source]¶

newline()[source]¶

println(message)[source]¶

show_progress(iteration, total, length=40, min_level=0, prefix=None, carriage_return=True, suffix=None, symbol=None)[source]¶: create a terminal progress bar, default bar shows for verbose+ :param iteration: current iteration (Int) :param total: total iterations (Int) :param length: character length of bar (Int)

spinner = <freegenes.logger.spinner.Spinner object>¶

table(rows, col_width=2)[source]¶: table will print a table of entries. If the rows is a dictionary, the keys are interpreted as column names. if not, a numbered list is used.

useColor()[source]¶: useColor will determine if color should be added to a print. Will check if being run in a terminal, and if has support for ascii

verbose(message)[source]¶

verbose1(message)[source]¶

verbose2(message)[source]¶

verbose3(message)[source]¶

warning(message)[source]¶

write(stream, message)[source]¶: write will write a message to a stream, first checking the encoding

freegenes.logger.message.convert2boolean(arg)[source]¶: convert2boolean is used for environmental variables that must be returned as boolean

freegenes.logger.message.get_logging_level()[source]¶: configure a logging to standard out based on the user’s selected level, which should be in an environment variable called MESSAGELEVEL. if MESSAGELEVEL is not set, the info level (1) is assumed (all informational messages).

freegenes.logger.message.get_user_color_preference()[source]¶

freegenes.logger.progress module¶

class freegenes.logger.progress.ProgressBar(label='', width=32, hide=None, empty_char=' ', filled_char='-', expected_size=None, every=1)[source]¶

Bases: object

done()[source]¶

format_time(seconds)[source]¶

show(progress, count=None)[source]¶

freegenes.logger.progress.bar(it, label='', width=32, hide=None, empty_char=' ', filled_char='-', expected_size=None, every=1)[source]¶: Progress iterator. Wrap your iterables with it.