python解析cron表达式_sche一种人类能够看懂的cron语法

在 Linux 系统上&＃xff0c;我们一般使用 cron 来设置定时任务&＃xff0c;然而 cron 的语法还是有些佶屈聱牙的&＃xff0c;几乎每次要修改的时候都需要查一下文档才知道什么意思&＃xff0c;以至于有 crontab.guru 这种网站专门来解释 cron 的语法。

想象一下&＃xff0c;能不能有一种让人一眼就能看懂的语法来表达周期性的调度操作呢&＃xff1f;比如说这样&＃xff1a;

every 10 minutes         , curl apple.com
every hour               , echo &＃39;time to take some coffee&＃39;
every day at 10:30       , eat
every 5 to 10 minutes    , firefox http://news.ycombinator.com
every monday             , say &＃39;Good week&＃39;
every wednesday at 13:15 , rm -rf /
every minute at :17      , ping apple.com
every 90 minutes         , echo &＃39;time to stand up&＃39;


这样的配置文件是不是很容易懂呢&＃xff1f;如果要写成 crontab 的格式大概是这样的&＃xff1a;

*/10 * * * *    curl apple.com
0 * * * *       echo &＃39;time to take some coffee&＃39;
30 10 * * *     eat
*/7 * * * *     firefox http://news.ycombinator.com  # 实际上是不对的&＃xff0c;因为 cron 没法随机
0 0 * * MON     say &＃39;Good week&＃39;
15 13 * * WED   rm -rf /
# every minute at :17  无法实现&＃xff0c;因为 cron 中没有秒
0 0-21/3 * * *  echo &＃39;time to stand up&＃39;  # 需要两条命令来完成每隔 90 分钟的操作
30 1-22/3 * * * echo &＃39;time to stand up&＃39;


可以很明显看出&＃xff0c;cron 的语法可读性还是差一些的&＃xff0c;关键是维护起来更是像读天书一样。幸运的是&＃xff0c;我在周末刚刚做了一个小工具&＃xff0c;虽然还比较粗糙&＃xff0c;但是也已经可以解析上面这种可读性比较好的语法。下面简单介绍一下如何使用&＃xff1a;

介绍 sche

sche 是一个 Python 程序&＃xff0c;所以可以使用 pip 直接安装&＃xff1a;

pip install sche


安装之后&＃xff0c;就会得到一个 sche 命令&＃xff0c;帮助文件如下&＃xff1a;

-> % sche -h
usage: sche [-h] [-f FILE] [-t]

A simple command like &＃96;cron&＃96;, but more human friendly.

The default configuration file is /etc/schetab, syntax goes like:

    # (optional) set time zone first
    timezone &＃61; &＃43;0800

    # line starts with # is a comment
    every 60 minutes, echo "wubba lubba dub dub"

    # backup database every day at midnight
    every day at 00:00, mysqldump -u backup

    # redirect logs so you can see them
    every minute, do_some_magic >> /some/output/file 2>&1

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  configuration file to use
  -t, --test            test configuration and exit


我们只需要把需要执行的命令放到 /etc/schetab 文件下就好了&＃xff0c;这里显然是在致敬 /etc/crontab。比如说&＃xff1a;

-> % cat /etc/schetab
timzone &＃61; &＃43;0800
every 5 seconds, echo "wubba lubba dub dub"
every 10 seconds, date

-> % sche
wubba lubba dub dub
Tue Sep  1 22:15:01 CST 2020
wubba lubba dub dub
wubba lubba dub dub
Tue Sep  1 22:15:11 CST 2020
wubba lubba dub dub
wubba lubba dub dub
Tue Sep  1 22:15:21 CST 2020
wubba lubba dub dub


如何让 sche 像 cron 一样作为一个守护进程呢&＃xff1f;秉承 Unix 一个命令只做一件事的哲学&＃xff0c;sche 本身显然是不提供这个功能的&＃xff0c;可以使用 systemd 实现&＃xff0c;几行配置写个 unit 文件就搞定了。

sche 的来源

sche 是 schedule -- 另一个 Python 库的一个 fork, schedule 支持这样的 Python 语句&＃xff1a;

schedule.every(10).minutes.do(job)
schedule.every().hour.do(job)
schedule.every().day.at("10:30").do(job)
schedule.every().monday.do(job)
schedule.every().wednesday.at("13:15").do(job)
schedule.every().minute.at(":17").do(job)


然而我的需求是把时间配置独立出来&＃xff0c;能够像 cron 一样存到一个文本文件里&＃xff0c;而不是写成 Python 代码&＃xff0c;于是提了一个 PR&＃xff0c;增加了 when 这个方法来解析表达式。同时我还强烈需求时区支持&＃xff0c;然而原版的 schedule 也不支持。所以就创建了一个 fork.

sche.when("every wednesday at 13:15").do(job)
sche.timezone("&＃43;0800").every().day.at("00:00").do(job)


最后&＃xff0c;原生的 cron 命令实际上(至少我)已经极少用了&＃xff0c;然而 crontab 的语法流传还是非常广的&＃xff0c;在所有需要定时任务的地方&＃xff0c;几乎都能看到 cron 的身影&＃xff0c;比如说 Kubernetes job 等等&＃xff0c;如果能够使用一种让正常人能随时看懂的语法&＃xff0c;感觉还是很有意义的。

参考

1. https://schedule.readthedocs.io/en/stable/
2. https://crontab.guru/
3. https://stackoverflow.com/q/247626/1061155