Back to all reviewers

Use standardized logging pattern

stanfordnlp/dspy
Based on 4 comments
Python

Always use the standardized logging pattern with module-level loggers instead of print statements or direct logging calls. This ensures consistent logging behavior, proper log level control, and better debugging capabilities across the codebase.

Logging Python

Reviewer Prompt

Always use the standardized logging pattern with module-level loggers instead of print statements or direct logging calls. This ensures consistent logging behavior, proper log level control, and better debugging capabilities across the codebase.

The standard pattern is:

import logging

logger = logging.getLogger(__name__)
logger.info("Your message here")
logger.warning("Warning message")
logger.debug("Debug info", exc_info=True)  # Include exception info when relevant

Replace print statements with appropriate log levels:

  • Use logger.error() or logger.warning() instead of print(e) for exceptions
  • Use logger.info() for general information
  • Use logger.debug() for detailed debugging information

In modules where the dspy logger isn’t available (like dsp folder), follow the same pattern by creating a module-level logger. This maintains consistency and allows proper log level configuration across the entire application.

4
Comments Analyzed
Python
Primary Language
Logging
Category

Source Discussions