ChemkinLogger

class ansys.chemkin.core.logger.ChemkinLogger(level: int = logging.ERROR, logger_name: str = 'PyChemkin')

Bases: object

Provides the singleton logger for the PyChemkin.

Parameters

to_filebool, default: False

Whether to include the logs in a file.

Overview

Methods

get_logger	Get the logger.
set_level	Set the logger output level.
enable_output	Enable logger output to a given stream.
add_file_handler	Save logs to a file in addition to printing them to the standard output.

Import detail

from ansys.chemkin.core.logger import ChemkinLogger

Method detail

ChemkinLogger.get_logger() → logging.Logger

Get the logger.

Returns

Logger

Logger.

ChemkinLogger.set_level(level: int) → None

Set the logger output level.

Parameters

levelint, {0, 10, 20, 30, 40, 50}

Output Level of the logger. 0 = NOTSET 10 = DEBUG 20 = INFO 30 = WARNING 40 = ERROR 50 = CRITICAL

ChemkinLogger.enable_output(stream=None)

Enable logger output to a given stream.

If a stream is not specified, sys.stderr is used.

Parameters

stream: TextIO, default: sys.stderr

Stream to output the log output to.

ChemkinLogger.add_file_handler(logs_dir: str = './.log')

Save logs to a file in addition to printing them to the standard output.

Parameters

logs_dirstr, default: "./.log"

Directory of the logs.