Skip to content

Logging

Functionality for event logging.

Code

import logging

Create

Action Code Details
Root logger
logging.root
Module-level logger
logger = logging.getLogger(__name__)

Update

Update root logger

The root API is inconsistent with the logger API

Action Code Details
Set root logging level to lvl
logging.basicConfig(level=lvl)
Set root logging level to critical or fatal
logging.basicConfig(level='CRITICAL')
Set root logging level to error
logging.basicConfig(level='ERROR')
Set root logging level to warning
logging.basicConfig(level='WARNING')
Set root logging level to info
logging.basicConfig(level='INFO')
Set root logging level to debug
logging.basicConfig(level='DEBUG')
Disable root logger
logging.root.disable = True
Re-enable root logger
logging.root.disable = False
Capture warnings outputted via the warnings module
logging.captureWarnings(True)
For example, warnings.warn('uh oh')
Set message format to show full datetime
logging.basicConfig(format='%(asctime)s %(message)s')

Specific logger

Update specific logger stored in variable logger

Action Code Details
Set logging level to lvl
logger.setLevel(lvl)
See levels here
Set logging level to critical or fatal
logger.setLevel('CRITICAL')
Set logging level to error
logger.setLevel('ERROR')
Set logging level to warning
logger.setLevel('WARNING')
Set logging level to info
logger.setLevel('INFO')
Set logging level to debug
logger.setLevel('DEBUG')
Disable logger
logger.disable = True
Re-enable logger
logger.disable = False

Usage

For logging to a specific logger, call the respective function on the logger instead of logging.

Action Code Details
Log error
logging.error('my error msg')
Log error with exception stack trace
logging.exception('my error msg')
For use in exception handling
Log unavoidable warning
logging.warning('my warning msg')
Log avoidable warning
import warnings
warnings.warn('my warning msg')
Make sure that logging.captureWarnings(True)
Log info
logging.info('my info msg')
Log debug message
logging.debug('my debug msg')