The logger.py module#

Summary#

PySpeosCustomAdapter

Keeps the reference to the speos instance name dynamic.

PySpeosPercentStyle

Customized PercentStyle class for overwriting default format styles.

PySpeosFormatter

Provides the customized Formatter class for overwriting default format styles.

InstanceFilter

Ensures that the instance_name record always exists.

Logger

Provides the logger used for each PySpeos session.

addfile_handler

Add a file handler to the input.

add_stdout_handler

Add a standout handler to the logger.

string_to_loglevel

LOG_LEVEL

FILE_NAME

DEBUG

INFO

WARN

ERROR

CRITICAL

STDOUT_MSG_FORMAT

FILE_MSG_FORMAT

DEFAULT_STDOUT_HEADER

DEFAULT_FILE_HEADER

NEW_SESSION_HEADER

LOG

Description#

Logging module.

This module supplies a general framework for logging in PySpeos. This module is built upon logging library and it does not intend to replace it but rather provide a way to interact between logging and pyspeos.

The loggers used in the module include the name of the instance, which is intended to be unique. This name is printed in all active outputs and is used to track the different PySpeos instances.

Usage#

Global logger#

There is a global logger named pyspeos_global that is created at ansys.speos.core.__init__. If you want to use this global logger, you must call it at the top of your module:

from ansys.speos.core import LOG

You can also rename it to avoid conflicts with other loggers (if any):

from ansys.speos.core import LOG as logger

It should be noticed that the default logging level of LOG is ERROR. You can change this and output lower-level messages with:

LOG.logger.setLevel("DEBUG")
LOG.file_handler.setLevel("DEBUG")  # If present.
LOG.stdout_handler.setLevel("DEBUG")  # If present.

Alternatively, you can ensure all the handlers are set to the input log level with:

LOG.setLevel("DEBUG")

By default, this logger does not log to a file. If you want to do so, you can add a file handler with:

import os

file_path = os.path.join(os.getcwd(), "pyspeos.log")
LOG.log_to_file(file_path)

This sets the logger to be redirected also to this file. If you want to change the characteristics of this global logger from the beginning of the execution, you must edit the __init__ file in the directory ansys.speos.core.

To log using this logger, call the desired method as a normal logger with:

>>> import logging
>>> from ansys.speos.core.logger import Logger
>>> LOG = Logger(level=logging.DEBUG, to_file=False, to_stdout=True)
>>> LOG.debug("This is LOG debug message.")
DEBUG -  -   -  - This is LOG debug message.

Instance Logger#

Every time an instance of ansys.speos.core.speos.Speos is created, a logger is created and stored in LOG._instances. This field is a dictionary where the key is the name of the created logger. These instance loggers inherit the pyspeos_global output handlers and logging level unless otherwise specified. The way this logger works is very similar to the global logger. If you want to add a file handler, you can use the log_to_file() method. If you want to change the log level, you can use the logger.Logging.setLevel() method. You can use this logger like this:

>>> from ansys.speos.core import SpeosClient
>>> speos = SpeosClient()
>>> speos._log.info("This is a useful message")
INFO - GRPC_127.0.0.1:50056 -  <...> -  - This is a useful message

Other loggers#

You can create your own loggers using a Python logging library as you would do in any other script. There would be no conflicts between these loggers.

Module detail#

logger.addfile_handler(logger, filename=FILE_NAME, level=LOG_LEVEL, write_headers=False)#

Add a file handler to the input.

Parameters:
loggerlogging.Logger or logging.Logger, optional

Logger to add the file handler to.

filenamestr, optional

Name of the output file. The default is "pyspeos.log".

levelint, optional

Level of logging. The default is LOG_LEVEL.

write_headersbool, optional

Whether to write the headers to the file. The default is False.

Returns:
logger

Logger or Logger object.

logger.add_stdout_handler(logger, level=LOG_LEVEL, write_headers=False)#

Add a standout handler to the logger.

Parameters:
loggerlogging.Logger or logging.Logger

Logger to add the file handler to.

levelin, optional
Level of logging. The default is 10, in which case the

logging.DEBUG level is used.

write_headersbool, optional

Whether to write headers to the file. The default is False.

Returns:
logger

Logger or Logger object.

logger.LOG_LEVEL = 10#
logger.FILE_NAME = 'pyspeos.log'#
logger.DEBUG = 10#
logger.INFO = 20#
logger.WARN = 30#
logger.ERROR = 40#
logger.CRITICAL = 50#
logger.STDOUT_MSG_FORMAT = '%(levelname)s - %(instance_name)s -  %(module)s - %(funcName)s - %(message)s'#
logger.FILE_MSG_FORMAT = '%(levelname)s - %(instance_name)s -  %(module)s - %(funcName)s - %(message)s'#
logger.DEFAULT_STDOUT_HEADER = Multiline-String#
Show Value
"""
LEVEL - INSTANCE NAME - MODULE - FUNCTION - MESSAGE
"""
logger.DEFAULT_FILE_HEADER = Multiline-String#
Show Value
"""
LEVEL - INSTANCE NAME - MODULE - FUNCTION - MESSAGE
"""
logger.NEW_SESSION_HEADER = Multiline-String#
Show Value
"""
===============================================================================
       NEW SESSION - Uninferable
==============================================================================="""
logger.LOG#
logger.string_to_loglevel#