Using logging in multiple modules

by

Best practice is, in each module, to have a logger defined like this:

import logging
logger = logging.getLogger(__name__)

near the top of the module, and then in other code in the module do e.g.

logger.debug('My message with %s', 'variable data')

If you need to subdivide logging activity inside a module, use e.g.

loggerA = logging.getLogger(__name__ + '.A')
loggerB = logging.getLogger(__name__ + '.B')

and log to loggerA and loggerB as appropriate.

In your main program or programs, do e.g.:

def main():
    "your program code"

if __name__ == '__main__':
    import logging.config
    logging.config.fileConfig('/path/to/logging.conf')
    main()

or 

def main():
    import logging.config
    logging.config.fileConfig('/path/to/logging.conf')
    # your program code

if __name__ == '__main__':
    main()

See here for logging from multiple modules, and here for logging configuration for code which will be used as a library module by other code.

Update: When calling fileConfig(), you may want to specify disable_existing_loggers=False if you’re using Python 2.6 or later (see the docs for more information). The default value is True for backward compatibility, which causes all existing loggers to be disabled by fileConfig() unless they or their ancestor are explicitly named in the configuration. With the value set to False, existing loggers are left alone. If using Python 2.7/Python 3.2 or later, you may wish to consider the dictConfig() API which is better than fileConfig() as it gives more control over the configuration.

More Related Contents:

  1. String formatting: % vs. .format vs. f-string literal
  2. How should I log while using multiprocessing in Python?
  3. Making Python loggers output all messages to stdout in addition to log file
  4. logger configuration to log to file and print to stdout
  5. Log all requests from the python-requests module
  6. Getting console.log output from Chrome with Selenium Python API bindings
  7. How to disable logging on the standard error stream?
  8. How to redirect stdout and stderr to logger in Python
  9. How to add a custom loglevel to Python’s logging facility
  10. How do I add custom field to Python log format string?
  11. log messages appearing twice with Python Logging
  12. using Python logger class to generate multiple logs for different log levels
  13. Python, want logging with log rotation and compression
  14. Get Output From the logging Module in IPython Notebook
  15. logging with filters
  16. How can I disable logging while running unit tests in Python Django?
  17. How do I get my FastAPI application’s console log in JSON format with a different structure and different fields?
  18. Can Python’s logging format be modified depending on the message log level?
  19. Deadlock with logging multiprocess/multithread python script
  20. How to configure logging to syslog in Python?
  21. How do I log from my Python Spark script
  22. How to write custom python logging handler?
  23. Naming Python loggers
  24. Python logging: use milliseconds in time format
  25. Django Setup Default Logging
  26. Run subprocess and print output to logging
  27. Does python logging flush every log?
  28. How to log Keras loss output to a file
  29. redirect prints to log file
  30. Python Logging – Disable logging from imported modules

Leave a Comment