logging.console module

Functions that configure the pwfdf-api’s logging stream to sys.stderr.

Function

Description

verbose

Configures the console logger at the DEBUG level

info

Configures the console logger at the INFO level

quiet

Configures the console logger at the WARNING level
pwfdf_api.logging.console.verbose(format=None)

Sets the console logger to the DEBUG level

verbose()
verbose(format)

Sets the pwfdf-api package’s sys.stderr StreamHandler to log at the DEBUG level, and ensures the pwfdf-api base logger passes messages at this level. Also removes any pre-existing sys.stderr StreamHandlers for the pwfdf-api package. Returns the new StreamHandler.

By default, retains any pre-existing formatter. Use format to specify a new logging format instead. Here, format may either be a logging format string, or a logging.Formatter object.

Inputs:
Outputs:

StreamHandler – The new pwfdf-api StreamHandler for sys.stderr

pwfdf_api.logging.console.info(format=None)

Sets the console logger to the INFO level

info()
info(format)

Sets the pwfdf-api package’s sys.stderr StreamHandler to log at the INFO level, and ensures the pwfdf-api base logger passes messages at this level. Also removes any pre-existing sys.stderr StreamHandlers for the pwfdf-api package. Returns the new StreamHandler.

By default, retains any pre-existing formatter. Use format to specify a new logging format instead. Here, format may either be a logging format string, or a logging.Formatter object.

Inputs:
Outputs:

StreamHandler – The new pwfdf-api StreamHandler for sys.stderr

pwfdf_api.logging.console.quiet(format=None)

Sets the console logger to the WARNING level

quiet()
quiet(format)

Sets the pwfdf-api package’s sys.stderr StreamHandler to log at the WARNING level, and ensures the pwfdf-api base logger passes messages at this level. Also removes any pre-existing sys.stderr StreamHandlers for the pwfdf-api package. Returns the new StreamHandler.

By default, retains any pre-existing formatter. Use format to specify a new logging format instead. Here, format may either be a logging format string, or a logging.Formatter object.

Inputs:
Outputs:

StreamHandler – The new pwfdf-api StreamHandler for sys.stderr