Flawless 项目使用教程

Flawless 项目使用教程

flawless A simple Python framework to catch exceptions, figure out which developer wrote the buggy code, and send them a stacktrace 项目地址: https://gitcode.com/gh_mirrors/fl/flawless

1. 项目目录结构及介绍

Flawless 项目的目录结构如下：

flawless/
├── config/
├── examples/
├── flawless/
│   ├── __init__.py
│   ├── client/
│   └── server/
├── tests/
├── .gitignore
├── CHANGES
├── LICENSE
├── MANIFEST.in
├── PKG-INFO
├── README.md
├── flawless_daemon.py
├── requirements.txt
└── setup.py

目录介绍

• config/: 存放项目的配置文件。
• examples/: 包含一些示例代码，展示了如何将 Flawless 集成到不同的 Python 应用中。
• flawless/: 项目的主要代码库，包含客户端和服务器端的实现。
  • client/: 客户端代码，负责捕获异常并发送给服务器。
  • server/: 服务器端代码，负责接收异常报告并处理。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• CHANGES: 项目变更记录。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 用于打包项目的清单文件。
• PKG-INFO: 项目包信息文件。
• README.md: 项目介绍和使用说明。
• flawless_daemon.py: 项目的主启动文件。
• requirements.txt: 项目依赖库列表。
• setup.py: 项目安装脚本。

2. 项目启动文件介绍

flawless_daemon.py

flawless_daemon.py 是 Flawless 项目的主启动文件。它负责启动 Flawless 服务器，并处理来自客户端的异常报告。

主要功能

• 配置加载: 从配置文件中加载服务器配置。
• 异常处理: 接收并处理客户端发送的异常报告。
• 开发者通知: 根据异常报告，使用 git blame 确定责任开发者，并发送邮件通知。

启动命令

$ flawless start -conf path/to/flawless.cfg

3. 项目配置文件介绍

flawless.cfg

flawless.cfg 是 Flawless 项目的配置文件，用于配置服务器的各项参数。

配置项

• server_host: 服务器监听的主机地址。
• server_port: 服务器监听的端口号。
• email_host: 用于发送邮件的 SMTP 服务器地址。
• email_port: SMTP 服务器端口号。
• email_user: SMTP 用户名。
• email_password: SMTP 密码。
• report_only_after_minimum_date: 仅报告在此日期之后修改的代码引发的异常。
• whitelist: 异常白名单配置，用于忽略某些已知的异常。

示例配置

[server]
server_host = 0.0.0.0
server_port = 8080

[email]
email_host = smtp.example.com
email_port = 587
email_user = user@example.com
email_password = password

[report]
report_only_after_minimum_date = 2023-01-01

[whitelist]
file = path/to/file.py
function = some_function
line = some_line_of_code

通过以上配置，Flawless 服务器将能够正确启动并处理异常报告。

flawless A simple Python framework to catch exceptions, figure out which developer wrote the buggy code, and send them a stacktrace 项目地址: https://gitcode.com/gh_mirrors/fl/flawless