Master Python Config for Dynamic Logging in API Automation

Introduction

Effective log management is crucial in API automation. Python's config module, created by the logging package author, enables hierarchical configuration through external files, allowing flexible control over log levels, destinations, formats, and rotation.

Load Log Level from Configuration

Import the module and read the desired level:

import config
log_level = config.get('logging', 'level')
if log_level == 'DEBUG':
    # configure logger for DEBUG
    pass
elif log_level == 'INFO':
    # configure logger for INFO
    pass
elif log_level == 'WARNING':
    # configure logger for WARNING
    pass
elif log_level == 'ERROR':
    # configure logger for ERROR
    pass
elif log_level == 'CRITICAL':
    # configure logger for CRITICAL
    pass

Set Log Output Path Based on Environment

Determine the current environment and adjust the log file location accordingly:

import config
environment = config.get('app', 'environment')
if environment == 'development':
    # set log output to development path
    pass
elif environment == 'production':
    # set log output to production path
    pass

Dynamic Update of Log Level

Watch the configuration file for changes and refresh the logger when needed:

import config
config.watch_file('config.ini')

def on_config_update():
    log_level = config.get('logging', 'level')
    # update logger level
    pass

config.subscribe(on_config_update)

Control Log Format via Configuration

Read the format setting and apply the appropriate formatter:

import config
log_format = config.get('logging', 'format')
if log_format == 'SIMPLE':
    # use simple format
    pass
elif log_format == 'VERBOSE':
    # use verbose format
    pass

Configure Log File Backup

Enable or disable backup and set the number of retained files:

import config
backup_enabled = config.getboolean('logging', 'backup_enabled')
backup_count = config.getint('logging', 'backup_count')
if backup_enabled:
    # enable backup, set count
    pass
else:
    # disable backup
    pass

Conclusion

The five examples demonstrate how to leverage the config module for hierarchical logging configuration, giving developers the flexibility to adjust levels, destinations, formats, and rotation without changing code, which is especially valuable in automated API testing pipelines.