PySpeosCustomAdapter

class ansys.speos.core.logger.PySpeosCustomAdapter(logger, extra=None)

Bases: logging.LoggerAdapter

Keeps the reference to the speos instance name dynamic.

If we use the standard approach, which is supplying extra input to the logger, we would need to keep inputing speos instances every time we do a log. Using adapters, we only need to specify the speos instance that we are referring to once.

Overview

Methods

process	Process extra Arguments.
log_to_file	Add a file handler to the logger.
log_to_stdout	Add a standard output handler to the logger.
setLevel	Change the log level of the object and the attached handlers.

Attributes

level
file_handler
stdout_handler
logger
std_out_handler

Import detail

from ansys.speos.core.logger import PySpeosCustomAdapter

Attribute detail

PySpeosCustomAdapter.level = None

PySpeosCustomAdapter.file_handler = None

PySpeosCustomAdapter.stdout_handler = None

PySpeosCustomAdapter.logger

PySpeosCustomAdapter.std_out_handler

Method detail

PySpeosCustomAdapter.process(msg, kwargs)

Process extra Arguments.

Parameters:

msgstr

Log message

kwargsdict

extra Arguments dictionary

Returns:

tuple[str, dict]

Message and processed extra arguments

PySpeosCustomAdapter.log_to_file(filename=FILE_NAME, level=LOG_LEVEL)

Add a file handler to the logger.

Parameters:

filenamestr, optional

Name of the file to write log messages to. The default is "pyspeos.log".

levelstr, optional

Level of logging. The default is 10, in which case the logging.DEBUG level is used.

PySpeosCustomAdapter.log_to_stdout(level=LOG_LEVEL)

Add a standard output handler to the logger.

Parameters:

levelint, optional

Level of logging. The default is 10, in which case the logging.DEBUG level is used.

PySpeosCustomAdapter.setLevel(level='DEBUG')

Change the log level of the object and the attached handlers.

Parameters:

levelint, optional

Level of logging. The default is 10, in which case the logging.DEBUG level is used.