### Python Logging 记录参数和错误信息的最佳实践 在 Python 中，`logging` 模块是一个功能强大且灵活的日志记录工具，能够帮助开发者记录程序运行过程中的各种信息。以下是记录函数参数和错误信息的最佳实践： #### 1. 配置日志记录器 为了确保日志记录的灵活性和可扩展性，建议配置一个日志记录器（Logger），并为其添加适当的处理器（Handler）和格式化器（Formatter）。以下是一个示例配置： ```python import logging # 创建日志记录器 logger = logging.getLogger("my_logger") logger.setLevel(logging.DEBUG) # 创建控制台处理器 console_handler = logging.StreamHandler() console_handler.setLevel(logging.DEBUG) # 创建文件处理器 file_handler = logging.FileHandler("app.log") file_handler.setLevel(logging.ERROR) # 定义日志格式 formatter = logging.Formatter( "%(asctime)s - %(name)s - %(levelname)s - %(message)s" ) console_handler.setFormatter(formatter) file_handler.setFormatter(formatter) # 将处理器添加到日志记录器 logger.addHandler(console_handler) logger.addHandler(file_handler) ``` #### 2. 记录函数参数 记录函数参数时，可以将参数作为日志消息的一部分。使用 `%(param_name)s` 格式化字符串或直接传递参数字典。例如： ```python def my_function(param1, param2): logger.info("Function called with param1=%s and param2=%s", param1, param2) # 函数逻辑... ``` 如果需要记录更复杂的对象，可以将其转换为 JSON 字符串以便于阅读和解析[^1]。 #### 3. 记录错误信息 当程序发生异常时，推荐使用 `logger.exception()` 方法记录堆栈追踪信息。该方法不仅记录错误消息，还会附带详细的堆栈信息，便于调试[^2]。例如： ```python try: result = 1 / 0 except ZeroDivisionError as e: logger.exception("An error occurred: %s", e) ``` 对于非异常情况下的错误信息，可以使用 `logger.error()` 或 `logger.warning()` 方法。这些方法不会自动记录堆栈信息，因此适合处理预期的错误场景。 #### 4. 自定义日志级别 如果需要记录自定义级别的日志信息，可以使用 `logger.log(level, msg)` 方法。例如： ```python CUSTOM_LEVEL = 25 # 自定义级别 logger.log(CUSTOM_LEVEL, "This is a custom level log message.") ``` 这种方法特别适用于记录特定业务逻辑中的关键事件。 #### 5. 安全性和性能优化 在记录日志时，需注意避免暴露敏感信息，例如用户密码、API 密钥等。可以通过参数替换或过滤机制来保护隐私数据[^3]。此外，尽量减少不必要的日志输出，以提高程序性能。 --- ### 示例代码 以下是一个完整的日志记录示例，展示了如何记录函数参数和错误信息： ```python import logging # 配置日志记录器 logger = logging.getLogger("example_logger") logger.setLevel(logging.DEBUG) # 控制台处理器 console_handler = logging.StreamHandler() console_handler.setLevel(logging.DEBUG) # 文件处理器 file_handler = logging.FileHandler("example.log") file_handler.setLevel(logging.ERROR) # 日志格式 formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s") console_handler.setFormatter(formatter) file_handler.setFormatter(formatter) # 添加处理器 logger.addHandler(console_handler) logger.addHandler(file_handler) # 示例函数 def divide(a, b): logger.info("Divide function called with a=%s and b=%s", a, b) try: result = a / b logger.info("Result of division: %s", result) return result except ZeroDivisionError as e: logger.exception("ZeroDivisionError occurred: %s", e) return None # 调用函数 divide(10, 0) ``` ---