EGMStoolkit.usermessage

module documentation

(source)

Module to generate the EGMS-toolkit message

The module allows to generate the different user messages (e.g., error, warning, verbose).

(From EGMStoolkit package)

Changelog:

Define the logging level

The function defines the logging level.

Parameters
level:`str`	Level of logging. Can be `NOTSET`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `CRITICAL`.
Returns
`str`	level of logging

def egmstoolkitprint(msg, log, verbose): (source) ¶

Print a message

The function print an message for the verbose and the log.

def errormsg(namescript, defname, filescript, copyright, msg1, log): (source) ¶

Create an error message

The function creates an error message.

Parameters
namescript:`str`	Name of the `EGMStoolkit` module
defname:`str`	Name of the function
filescript:`str`	Full path of the `EGMStoolkit` module
copyright:`str`	Copyright
msg1:`str`	Message
log:`str` or `None`	log value
Returns
`str`	Output message

def openingmsg(namescript, defname, filescript, copyright, msg, log, verbose): (source) ¶

Display an opening message

The function creates an opening message for the verbose and the log.

Parameters
namescript:`str`	Name of the `EGMStoolkit` module
defname:`str`	Name of the function
filescript:`str`	Full path of the `EGMStoolkit` module
copyright:`str`	Copyright
msg:`str`	Message
log:`str` or `None`	log value
verbose:`bool`	verbose value

def warningmsg(namescript, defname, filescript, msg1, log, verbose): (source) ¶

Create a warning message

The function creates a warning message.

Parameters
namescript:`str`	Name of the `EGMStoolkit` module
defname:`str`	Name of the function
filescript:`str`	Full path of the `EGMStoolkit` module
msg1:`str`	Message
log:`str` or `None`	log value
verbose:`bool`	verbose value
Returns
`str`	Output message if verbose is `True`