`Logger`#

class ansys.speos.core.logger.Logger(level=logging.DEBUG, to_file=False, to_stdout=True, filename=FILE_NAME)#

Provides the logger used for each PySpeos session.

This class allows you to add handlers to the logger to output messages to a file or to the standard output.

Parameters:

levelint, default: 10: Logging level to filter the message severity allowed in the logger. By default, the logging.DEBUG level is used.
to_filebool, default: False: Whether to write log messages to a file.
to_stdoutbool, default: True: Whether to write log messages to the standard output (stdout).
filenamestr, default: “pyspeos.log”: Name of the file to write log log messages to.

Examples

Demonstrate logger usage from the Speos instance, which is automatically created when a speos instance is created.

>>> from ansys.speos.core import speos
>>> speos = Speos(loglevel="DEBUG")
>>> speos._log.info("This is a useful message")
INFO -  -   -  - This is LOG debug message.

Import the global pyspeos logger and add a file output handler.

>>> import os
>>> from ansys.speos.core import LOG
>>> file_path = os.path.join(os.getcwd(), "pyspeos.log")
>>> LOG.log_to_file(file_path)

Overview#

Methods

`log_to_file`	Add file handler to logger.
`log_to_stdout`	Add the standard output handler to the logger.
`setLevel`	Change the log level of the object and the attached handlers.
`add_child_logger`	Add a child logger to the main logger.
`add_instance_logger`	Add a logger for a speos instance.
`add_handling_uncaught_expections`	Redirect the output of an exception to a logger.

Attributes

`file_handler`
`std_out_handler`
`logger`
`debug`
`info`
`warning`
`error`
`critical`
`log`

Special methods

__getitem__

Magic method to allow retrieval of instances.

Import detail#

from ansys.speos.core.logger import Logger

Attribute detail#

Logger.file_handler = None#

Logger.std_out_handler = None#

Logger.logger#

Logger.debug#

Logger.info#

Logger.warning#

Logger.error#

Logger.critical#

Logger.log#

Method detail#

Logger.log_to_file(filename=FILE_NAME, level=LOG_LEVEL)#

Add file handler to logger.

Parameters:

filenamestr, optional: Name of the file to write log messages to. The default is "pyspeos.log".
levelint, optional: Level of logging. The default is 10, in which case the logging.DEBUG level is used.

Examples

Write to the "pyspeos.log" file in the current working directory.

>>> from ansys.speos.core import LOG
>>> import os
>>> file_path = os.path.join(os.getcwd(), "pyspeos.log")
>>> LOG.log_to_file(file_path)

Logger.log_to_stdout(level=LOG_LEVEL)#

Add the 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.

Logger.setLevel(level='DEBUG')#: Change the log level of the object and the attached handlers.

Logger.add_child_logger(suffix, level=None)#

Add a child logger to the main logger.

This logger is more general than an instance logger, which is designed to track the state of speos instances. If the logging level is in the arguments, a new logger with a reference to the _global logger handlers is created instead of a child logger.

Parameters:

suffixstr: Name of the child logger.
levelstr, optional: Level of logging. The default is None.

Returns:

logging.logger: Logger class.

Logger.add_instance_logger(name, client_instance, level=None)#

Add a logger for a speos instance.

The speos instance logger is a logger with an adapter that adds contextual information such as the speos instance name. This logger is returned, and you can use it to log events as a normal logger. It is stored in the _instances field.

Parameters:

namestr: Name for the new instance logger.
client_instanceansys.speos.core.kernel.client.SpeosClient: speos SpeosClient object, which should contain the get_name method.
levelint, optional: Level of logging. The default is None.

Returns:

PySpeosCustomAdapter: Logger adapter customized to add speos information to the logs. You can use this class to log events in the same way you would with the Logger class.

Logger.__getitem__(key)#: Magic method to allow retrieval of instances.

Logger.add_handling_uncaught_expections(logger)#

Redirect the output of an exception to a logger.

Parameters:

loggerstr: Name of the logger.

Logger#

Overview#

Import detail#

Attribute detail#

Method detail#

`Logger`#