gridtest.logger package¶
Submodules¶
gridtest.logger.message module¶
Copyright (C) 2017-2020 Vanessa Sochat.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
class
gridtest.logger.message.
GridTestMessage
(MESSAGELEVEL=None)[source]¶ Bases:
object
-
addColor
(level, text)[source]¶ addColor to the prompt (usually prefix) if terminal supports, and specified to do so
-
emit
(level, message, prefix=None, color=None)[source]¶ emit is the main function to print the message optionally with a prefix
- Arguments:
level (int) : the level of the message
message (str) : the message to print
prefix (str) : a prefix for the message
-
emitError
(level)[source]¶ determine if a level should print to stderr, includes all levels but INFO and QUIET
-
failure
(message)[source]¶ Given a message string, print as a failure in red.
- Parameters:
message: the message to print in red (indicating failure).
-
get_logs
(join_newline=True)[source]¶ ‘get_logs will return the complete history, joined by newline (default) or as is.
-
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+
- Parameters
iteration (current iteration (Int))
total (total iterations (Int))
length (character length of bar (Int))
-
spinner
= <gridtest.logger.spinner.Spinner object>¶
-
success
(message)[source]¶ Given a message string, print as a success in green.
- Parameters:
message: the message to print in green (indicating success).
-
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.
-
-
gridtest.logger.message.
convert2boolean
(arg)[source]¶ convert2boolean is used for environmental variables that must be returned as boolean
gridtest.logger.namer module¶
Copyright (C) 2018-2020 Vanessa Sochat.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
gridtest.logger.progress module¶
clint.textui.progress¶
A derivation of clint version, to not introduce a dependency and add custom functionality. Credit to base code goes to https://github.com/kennethreitz/clint/blob/master/clint/textui/progress.py
gridtest.logger.spinner module¶
Copyright (C) 2017-2020 Vanessa Sochat.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.