Lazy logger message string evaluation

by

The logging module already has partial support for what you want to do. Do this:

log.debug("Some message: a=%s b=%s", a, b)

… instead of this:

log.debug("Some message: a=%s b=%s" % (a, b))

The logging module is smart enough to not produce the complete log message unless the message actually gets logged somewhere.

To apply this feature to your specific request, you could create a lazyjoin class.

class lazyjoin:
    def __init__(self, s, items):
        self.s = s
        self.items = items
    def __str__(self):
        return self.s.join(self.items)

Use it like this (note the use of a generator expression, adding to the laziness):

logger.info('Stupid log message %s', lazyjoin(' ', (str(i) for i in range(20))))

Here is a demo that shows this works.

>>> import logging
>>> logging.basicConfig(level=logging.INFO)
>>> logger = logging.getLogger("log")
>>> class DoNotStr:
...     def __str__(self):
...         raise AssertionError("the code should not have called this")
... 
>>> logger.info('Message %s', DoNotStr())
Traceback (most recent call last):
...
AssertionError: the code should not have called this
>>> logger.debug('Message %s', DoNotStr())
>>>

In the demo, The logger.info() call hit the assertion error, while logger.debug() did not get that far.

More Related Contents:

  1. Where is a complete example of logging.config.dictConfig?
  2. How to add a custom loglevel to Python’s logging facility
  3. python exception message capturing
  4. Can Python’s logging format be modified depending on the message log level?
  5. How to configure logging to syslog in Python?
  6. How do I log from my Python Spark script
  7. How to write custom python logging handler?
  8. python logging to database
  9. Suppress newline in Python logging module
  10. Naming Python loggers
  11. Python logging: use milliseconds in time format
  12. Django Setup Default Logging
  13. How to use logging.getLogger(__name__) in multiple modules
  14. Run subprocess and print output to logging
  15. Does python logging flush every log?
  16. No handlers could be found for logger
  17. How to use Python’s RotatingFileHandler
  18. redirect prints to log file
  19. Set logging levels
  20. How to change filehandle with Python logging on the fly with different classes and imports
  21. Can structured logging be done with Pythons standard library?
  22. Python Logging – Disable logging from imported modules
  23. Redirect Python ‘print’ output to Logger
  24. How to use Paramiko logging?
  25. How do I disable log messages from the Requests library?
  26. How can I color Python logging output?
  27. How to write to a file, using the logging Python module?
  28. Log output of multiprocessing.Process
  29. How do I log a Python error with debug information?
  30. How to list all existing loggers using python.logging module

Leave a Comment