apsbits.utils.logging_setup

Configure logging for this session.

Public

configure_logging()

Configure logging as described in file.

Internal

_setup_console_logger(logger, cfg)	Reconfigure the root logger as configured by the user.
_setup_file_logger(logger, cfg)	Record log messages in file(s).
_setup_ipython_logger(logger, cfg)	Internal: Log IPython console session In and Out to a file.
_setup_module_logging(cfg)	Internal: Set logging level for each named module.

See also

https://blueskyproject.io/bluesky/main/debugging.html

Functions

addLoggingLevel(levelName, levelNum[, ...])	Comprehensively adds a new logging level to the logging module and the currently configured logging class.
configure_logging()	Configure logging as described in file.

apsbits.utils.logging_setup._setup_console_logger(logger, cfg)

Reconfigure the root logger as configured by the user.

We can’t apply user configurations in configure_logging() above because the code to read the config file triggers initialization of the logging system.

See also

https://docs.python.org/3/library/logging.html#logging.basicConfig

apsbits.utils.logging_setup._setup_file_logger(logger, cfg)

Record log messages in file(s).

apsbits.utils.logging_setup._setup_ipython_logger(logger, cfg)

Internal: Log IPython console session In and Out to a file.

See logrotate? int he IPython console for more information.

apsbits.utils.logging_setup._setup_module_logging(cfg)

Internal: Set logging level for each named module.

apsbits.utils.logging_setup.addLoggingLevel(levelName, levelNum, methodName=None)

Comprehensively adds a new logging level to the logging module and the currently configured logging class.

levelName becomes an attribute of the logging module with the value levelNum. methodName becomes a convenience method for both logging itself and the class returned by logging.getLoggerClass() (usually just logging.Logger). If methodName is not specified, levelName.lower() is used.

To avoid accidental clobberings of existing attributes, this method will raise an AttributeError if the level name is already an attribute of the logging module or if the method name is already present

Example

>>> addLoggingLevel('TRACE', logging.INFO - 5)
>>> logging.getLogger(__name__).setLevel("TEST")
>>> logging.getLogger(__name__).test('that worked')
>>> logging.test('so did this')
>>> logging.TEST
5

apsbits.utils.logging_setup.configure_logging()

Configure logging as described in file.