跳转至

更新日志

本文档记录 chronflow 的所有重要变更。

格式基于 Keep a Changelog, 版本号遵循 语义化版本。

[0.3.0] - 2025-10-24

新增 ✨

任务自动发现功能

  • 🔍 添加 TaskDiscovery 类,支持自动扫描和注册定时任务
  • 📁 支持按目录扫描 - discover_tasks_from_directory()
  • 📦 支持按包名扫描 - discover_tasks_from_package()
  • 📝 支持模块列表导入 - discover_tasks_from_modules()
  • 🎯 支持通配符文件名匹配 (如 task.py, *_tasks.py)
  • ♻️ 支持递归扫描子目录
  • 🚫 支持排除特定文件模式
  • ✅ 自动注册发现的任务到调度器
  • 🛡️ 错误容错,导入失败的模块会被跳过

Scheduler 集成

  • 添加 discover_tasks_from_directory() 便捷方法
  • 添加 discover_tasks_from_package() 便捷方法
  • 添加 discover_tasks_from_modules() 便捷方法

修复 🐛

  • 🔧 修复 Cron 表达式秒级精度支持问题
  • 在 croniter 调用中添加 second_at_beginning=True 参数
  • 确保 6 段式 Cron 表达式正常工作 (秒 分 时 日 月 周)
  • 修复 @daily(), @hourly(), @weekly(), @monthly() 装饰器

改进 🔧

  • 📚 更新 MkDocs 配置,添加任务自动发现文档
  • 📝 添加详细的任务自动发现使用文档和示例
  • 🎯 优化项目集成示例,添加短间隔任务演示

示例

  • 添加 examples/task_discovery_example.py - 任务自动发现基础示例
  • 添加 examples/project_integration_example.py - 实际项目集成示例

文档

  • 添加 docs/task_discovery.md - 任务自动发现完整文档
  • 更新 README.md 添加自动发现功能介绍
  • 添加 TASK_DISCOVERY_SUMMARY.md - 功能实现总结

测试

  • 添加 tests/test_discovery.py - 13 个测试用例,覆盖所有发现功能
  • ✅ 所有 301 个测试通过

[0.1.0] - 2025-10-22

新增 ✨

可插拔日志系统

  • 添加日志适配器接口 LoggerAdapter
  • 内置支持 structlog、loguru、Python 标准库 logging
  • 可以完全自定义日志实现
  • 支持禁用日志输出 (NoOpAdapter)
  • structlog 从核心依赖变为可选依赖

增强的监控功能

  • list_tasks() - 获取所有任务详细信息列表
  • get_task_count() - 获取各状态任务数量统计
  • get_task_by_status() - 按状态筛选任务
  • get_task_by_tag() - 按标签筛选任务
  • pause_task() - 暂停指定任务
  • resume_task() - 恢复指定任务
  • 任务列表包含成功率、平均执行时间等指标

新的便捷装饰器

  • @every() - 更直观的间隔任务 (@every(minutes=30))
  • @hourly() - 每小时执行 (@hourly(minute=30))
  • @daily() - 每天执行 (@daily(hour=9, minute=30))
  • @weekly() - 每周执行 (@weekly(day=1, hour=10))
  • @monthly() - 每月执行 (@monthly(day=1))

Python 版本支持

  • 添加 Python 3.13 官方支持
  • 继续支持 Python 3.11 和 3.12

改进 🔧

  • 依赖优化: structlog 变为可选依赖,减少默认安装体积
  • 类型提示: 所有新功能都有完整的类型提示
  • 文档: 添加详细的新功能文档和示例
  • 日志输出: 优化日志格式,支持结构化日志

示例

  • 添加 examples/advanced_features.py - 高级功能演示
  • 添加 examples/custom_logger.py - 自定义日志演示

技术细节

日志系统架构

LoggerAdapter (抽象基类)
    ├── StructlogAdapter (默认,可选)
    ├── LoguruAdapter (可选)
    ├── StdlibAdapter (内置)
    └── NoOpAdapter (内置)

新的装饰器映射

装饰器 等价 Cron 说明
@hourly() 0 0 * * * * 每小时整点
@daily() 0 0 0 * * * 每天 0:00
@weekly() 0 0 0 * * 0 每周日 0:00
@monthly() 0 0 0 1 * * 每月 1 号 0:00

破坏性变更 ⚠️

无。此版本完全向后兼容。

已知问题

无。

安全性

无安全相关更新。

[0.2.1] - 2025-10-24

修复 🐛

信号处理

  • 修复前台运行时无法响应 Ctrl+C 的问题 (#BUG-001)
  • 在非守护模式下添加信号处理器注册
  • 支持 SIGINT (Ctrl+C) 和 SIGTERM 优雅停止
  • 使用 loop.call_soon_threadsafe() 确保线程安全
  • 文件: chronflow/scheduler.py:709-726

日志系统

  • 修复 LogRecord 'exc_info' 字段覆盖错误 (#BUG-002)
  • 在各日志适配器中从 kwargs 提取 exc_info 参数
  • 避免与 Python 标准库 logging.LogRecord 字段冲突
  • 改用 exception() 方法记录异常,而不是 error(..., exc_info=True)
  • 文件: chronflow/logging.py, chronflow/scheduler.py

任务调度

  • 修复任务重复执行导致连接数过多的问题 (#BUG-003)
  • 在装饰器中添加重复任务检查机制
  • 防止模块重新加载时任务被重复注册
  • 避免 Redis "Too many connections" 错误
  • 文件: chronflow/decorators.py:167-170

守护进程

  • 修复后台运行时输出到终端的问题 (#BUG-004)
  • 在守护进程子进程中重定向标准输入/输出/错误到 /dev/null
  • 防止守护进程日志干扰启动终端
  • 文件: chronflow/daemon.py:131-135

改进 🔧

测试覆盖率

  • 提升测试覆盖率从 87% 到 91% (#IMPROVE-001)
  • 新增 tests/test_coverage_improvement.py 补充测试
  • 新增 tests/test_decorators_advanced.py 装饰器高级测试
  • 优化 .coveragerc 配置,排除可视化相关代码
  • 总计 288+ 个测试用例

文档

  • 新增详细的集成指南 (#IMPROVE-002)
  • 集成指南: 帮助用户正确集成 Chronflow
  • 常见问题解答和最佳实践
  • 完善的使用示例

破坏性变更 ⚠️

无。此版本完全向后兼容 0.2.0。

安全性

  • 改进信号处理的线程安全性
  • 增强守护进程的安全权限设置

升级建议

从 0.2.0 升级到 0.2.1:

  1. 如果遇到任务重复执行问题:
  2. 检查模块是否被多次导入
  3. 确保装饰器在模块级别使用,不在函数/方法中

  4. 参考集成指南了解最佳实践

  5. 如果使用 Loguru 或自定义日志:

  6. 无需修改,已自动兼容 exc_info 参数

  7. 如果使用守护进程模式:

  8. 日志将不再输出到终端,建议配置日志文件

[0.2.0] - 2025-10-23

本次发布包含新特性与改进： - 新增 chronflow/daemon.py，支持守护进程运行调度器 - 增强指标采集与可视化示例（examples/metrics_visualization.py） - 完善装饰器与配置映射，提升测试覆盖率 - 支持 Python 3.13（CI 验证），保持类型安全 - 文档与示例更新

破坏性变更 ⚠️

无。此版本向后兼容。

已知问题

无。

[未发布]

计划中的功能

  • [ ] Web 管理界面
  • [ ] Prometheus 指标导出
  • [ ] 任务依赖关系
  • [ ] 动态添加/删除任务
  • [ ] 分布式锁支持
  • [ ] PostgreSQL 后端支持

版本说明

[0.1.0] - 首个 Beta 版本

这是 chronflow 的首个公开 Beta 版本,包含以下核心功能:

核心特性: - 高性能异步调度器 - 多种队列后端(内存/SQLite/Redis/RabbitMQ) - 智能重试机制 - 秒级 Cron 表达式支持 - 装饰器 API - 完整的类型提示 - 可插拔日志系统 - 丰富的监控功能

队列后端: - MemoryBackend - 内存队列,零依赖 - SQLiteBackend - 本地持久化 - RedisBackend - 分布式队列 - RabbitMQBackend - 高可靠性消息队列

装饰器: - @scheduled - 通用调度器 - @cron - Cron 表达式 - @interval - 固定间隔 - @once - 一次性任务 - @every - 直观间隔 - @hourly - 每小时 - @daily - 每天 - @weekly - 每周 - @monthly - 每月

监控功能: - 任务列表查询 - 状态统计 - 标签筛选 - 任务控制(暂停/恢复) - 详细指标

日志支持: - Structlog - Loguru - Python logging - 自定义适配器 - 禁用日志

测试覆盖: - 60+ 单元测试 - 高测试覆盖率 - 多个实用示例

贡献

发现 Bug 或有新功能建议?欢迎提交 Issue!

许可证

MIT License - 详见 LICENSE