本项目演示了如何在 Python 项目中使用标准库 logging
进行日志记录。
logging_tutorial/
├── main.py
├── transform.py
├── app.log
- 如何配置日志格式、日志级别和日志文件
- 如何在代码中记录不同级别的日志(DEBUG, INFO, WARNING, ERROR, CRITICAL)
- 如何在函数调用和异常处理中记录日志
-
安装 Python
确保你已安装 Python 3.x。
-
运行示例代码
在命令行中运行:
python main.py
-
查看日志输出
日志会被写入到
app.log
文件中。你可以用文本编辑器打开查看。
在 main.py
中,使用如下方式配置日志:
import logging # 第一步:import logging 模块
# 第二步: 设置logging 的细节
logging.basicConfig(
filemode="a", # 追加模式
format="%(asctime)s - %(levelname)s- %(filename)s:%(lineno)s - %(message)s", # 日志格式
filename="app.log", # 日志文件名
level=logging.INFO, # 日志级别
)
# 第三步: 创建logger object
logger = logging.getLogger(__name__)
# 第四步: 在你想要加logging 的地方加上logging 信息
logger.info("你想要加的logging 信息写在这里")
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")
主函数被 try/except 包裹,异常会被记录到日志:
try:
main()
except Exception as e:
logger.error("An error occurred: %s", e, exc_info=True)
raise
- 可以在
transform.py
里也引入 logger,实现模块级日志。 - 可调整
level
为DEBUG
以输出更多调试信息。