使用docstrings计划
DocCron的Python项目详细描述
doccron
使用docstrings计划
License | Version | ||
Travis CI | Coverage | ||
AppVeyor | Supported versions | ||
Wheel | Implementation | ||
Status | Downloads | ||
Show your support |
安装
pip install DocCron
说明
基于cron的调度器灵感来自doctest
示例
cron作业可以通过使用literal block(::
)嵌入到docstring中。文本块应该以/etc/crontab
开头。
标准/扩展格式
每隔2分钟和3分钟运行hello()
:
importtimedefhello():""" Print "hello world" at every 2nd minute and 3rd minute: /etc/crontab:: */2 * * * * */3 * * * * """print(time.strftime('%Y-%m-%d %H:%M:%S'),"hello world")if__name__=='__main__':importdoccrondoccron.run_jobs()
石英格式
每隔2秒和3秒运行hello()
:
importtimedefhello():""" Print "hello world" every 2nd second and 3rd second: /etc/crontab:: */2 * * * * * */3 * * * * * """print(time.strftime('%Y-%m-%d %H:%M:%S'),"hello world")if__name__=='__main__':importdoccrondoccron.run_jobs(quartz=True)
时区感知(cron_tz)
doccron现在支持CRON_TZ
。CRON_TZ
的值仅适用于后续的cron作业。
doccron支持cron表中的多个CRON_TZ
。如果未指定,则默认时区值为本地/系统时区。
importtimedefhello():""" Print "hello world" at every 2nd minute and 3rd minute: /etc/crontab:: CRON_TZ=UTC */2 * * * * */3 * * * * """print(time.strftime('%Y-%m-%d %H:%M:%S%z'),"hello world")if__name__=='__main__':importdoccrondoccron.run_jobs()
功能
- 标准和扩展cron格式(请参见CRON Expression)
- Nonstandard predefined scheduling definitions
- Non-standard characters
- Quartz format
- 使用文档工具,如Sphinx
- 时区感知(cron_tz)
待办事项
- 可读日期/时间字符串