前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >django 定时任务 django-crontab 的使用

django 定时任务 django-crontab 的使用

作者头像
KEVINGUO_CN
发布2020-03-17 18:15:22
6.4K0
发布2020-03-17 18:15:22
举报
文章被收录于专栏:全栈全栈

在做 django 开发需求时,多多少少都会遇到需要定时任务的功能,比如定时执行任务,检查订单之类的。可能是一段时间,比如每隔 10分钟执行一次,也可能是定点时间,比如 14:00 执行,也可能是长时间,比如每周几,每个月的哪一天等。查看了一下相关资料, django 定时任务 django-crontab 库比较多教程和资料,虽然 star 数才五百,但是 API 接口比较简单,接入也很方便,功能也很全面,当然,也存在一此无法解决的问题,使用时需要注意的。

2、使用教程

1.安装:

代码语言:javascript
复制
pip install django-crontab

2.添加配置到 settings.py INSTALLED_APPS

代码语言:javascript
复制
INSTALLED_APPS = (
    'django_crontab',
    ...
)

3.编写定时函数:

定时任务可以分成两种,一种是执行自定义的mange.py的命令,另一种是执行自定义函数。

在django的app中新建一个myapp/cron.py文件,把需要定时执行的代码放进去

示例:

代码语言:javascript
复制
def my_scheduled_job():
  pass

4.在 settings.py 中增加CRONJOBS配置

代码语言:javascript
复制
CRONJOBS = [
    ('*/5 * * * *', 'myapp.cron.my_scheduled_job')
]

也可以定义一些关键字参数,有2种格式:

格式1:

  • 要求:cron计时通常格式(有关更多示例,请参阅 Wikipediacrontab.guru
  • 要求:python模块路径下待执行定时任务
  • 可选:特定于定时任务的后缀(例如,将 out/err 重定向到文件,默认值为'')

示例:

代码语言:javascript
复制
CRONJOBS = [
    ('*/1 * * * *', 'appname.test_crontab.test','>>/home/python/test_crontab.log')

]

注意: >> 表示追加写入,> 表示覆盖写入。

格式2:

  • 要求:cron计时通常格式
  • 要求:python模块路径下待执行定时任务
  • 可选:方法的位置参数列表(默认值:[])
  • 可选:方法的关键字参数的dict(默认值:{})
  • 可选:特定于定时任务的后缀(例如,将 out/err 重定向到文件,默认值为'')

示例:

代码语言:javascript
复制
CRONJOBS = [
    ('*/5 * * * *', 'myapp.cron.other_scheduled_job', ['arg1', 'arg2'], {'verbose': 0}),
    ('0   4 * * *', 'django.core.management.call_command', ['clearsessions']),
    
]

对于熟悉 Linux 中定时任务crontab 的同学可能对上面第一个参数的语法很亲切。上面表示每隔1分钟执行一次代码。

Linux 中的定时任务crontab的语法如下:

代码语言:javascript
复制
*  *  *  *  * command
分钟(0-59) 小时(0-23) 每个月的哪一天(1-31) 月份(1-12) 周几(0-6) shell脚本或者命令

有几个特殊的符号:

代码语言:javascript
复制
* 代表所有的取值范围的数字
/ 代表每的意思,*/5就是每5个单位
- 代表从某个数字到某个数字
, 分开几个离散的数字

示例:

代码语言:javascript
复制
每两个小时    0 */2 * * *
晚上11点到早上8点之间每两个小时,早上8点    0 23-7,8 * * *
每个月的4号和每个礼拜的礼拜一到礼拜三的早上11点    0 11 4 * 1-3
1月1日早上4点    0 4 1 1 * 
代码语言:javascript
复制
0 6 * * * commands >> /tmp/test.log # 每天早上6点执行, 并将信息追加到test.log中
0 */2 * * * commands # 每隔2小时执行一次

有兴趣的小伙伴可以深入研究下 Linux 的crontab定时任务。如果不了解和不熟悉可以想看: cron语法格式学习

5.添加并启动定时任务

代码语言:javascript
复制
#添加并启动定时任务
python manage.py crontab add

其它命令:

代码语言:javascript
复制
#显示当前的定时任务
python manage.py crontab show

#删除所有定时任务
python manage.py crontab remove

一些问题

如果配置成这样:

代码语言:javascript
复制
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

CRONJOBS = [
('0 7 * * 1-5', 'api.cron.email_to_late_docs', '>> {}'.format(BASE_DIR + '/logs/log_{:%d_%m_%Y}.log'.format(time.now()))),
('0 7 * * 1-5', 'api.cron.email_ten_days_before', '>> {}'.format(BASE_DIR + 'logs/log_{:%d_%m_%Y}.log'.format(time.now())))
]

上述代码的目的是,希望对任务的输出和错误日志,进行 log_ddmmYY 格式进行文件每天分开保存。

但是这个任务,在第二天时,就不会在执行啦!!

因为,CRONJOBS 生成任务时,会生成对应的哈希值(hashes),标识每个任务。所以,当文件名变更时,CRONJOBS 中的值每天都在变化,导致不同的定时任务哈希值(hashes)。

针对这种情况,解决方法是,日志文件名称固定,然后创建一个任务,用来每天把日志文件重命名(move)成想要的格式名称,这样就可以啦!

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019-12-05,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 2、使用教程
  • 一些问题
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档