django 定时任务 django-crontab 的使用

简介: 1、前言在做 django 开发需求时,多多少少都会遇到需要定时任务的功能,比如定时执行任务,检查订单之类的。可能是一段时间,比如每隔 10分钟执行一次,也可能是定点时间,比如 14:00 执行,也可能是长时间,比如每周几,每个月的哪一天等。

1、前言

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

2、使用教程

1.安装:

pip install django-crontab

2.添加配置到 settings.py INSTALLED_APPS

INSTALLED_APPS = (
    'django_crontab',
    ...
)

3.编写定时函数:

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

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

示例:

def my_scheduled_job():
  pass

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

CRONJOBS = [
    ('*/5 * * * *', 'myapp.cron.my_scheduled_job')
]

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

格式1:

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

示例:

CRONJOBS = [
    ('*/1 * * * *', 'appname.test_crontab.test','>>/home/python/test_crontab.log')

]

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

格式2:

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

示例:

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

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

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

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

有几个特殊的符号:

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

示例:

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

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

5.添加并启动定时任务

#添加并启动定时任务
python manage.py crontab add

其它命令:

#显示当前的定时任务
python manage.py crontab show

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

一些问题

如果配置成这样:

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)成想要的格式名称,这样就可以啦!

总结

通过这个需求,可以看到很多知识点其实是串联起来的,从pythondjangoLinuxcrontab,所以,学习无止境,知识学习只会越来越多,如果你提前掌握了某些知识,那么学习新(旧)知识的成本就会降低很多,或者理解成本,比如你学习了 Linux, 了解过 cron ,那么对于学习这个 django 的定时任务会轻松很多!永远不要认为有些知识你永远用不上,所以现在就不学,可能现在的永远距离已经很短啦!加油~

参考


  • 如有疑问,欢迎在评论区一起讨论!
  • 如有不正确的地方,欢迎指导!


注:本文首发于 iHTCboy's blog,如若转载,请注来源

目录
相关文章
|
4月前
|
调度 Python
在 Django 上实现定时任务的指南
在 Django 中实现定时任务有多种方法,包括使用 Celery 和 Celery Beat、django-background-tasks、以及 APScheduler。根据您的需求和应用场景,可以选择最适合的方案。每种方法都有其优缺点,选择时应考虑任务复杂性、系统资源、以及维护成本。通过这些工具,您可以有效地管理和调度后台任务,提高应用程序的自动化水平和运行效率。
|
6月前
|
存储 监控 调度
Django中的定时任务与后台任务队列的实践
【6月更文挑战第10天】在Django中实现定时任务和后台任务队列,可以使用Celery+Beat进行定时任务,Django Q处理后台任务。Celery配置包括设置Broker和Result Backend,创建Celery实例及任务。Django Q则涉及安装、配置ORM和创建任务。通过`async_task`将任务放入队列。注意性能、资源、安全和错误处理。使用时需考虑认证、输入验证、日志监控、部署策略和测试质量保障。
70 3
Django中的定时任务与后台任务队列的实践
|
5月前
|
Linux 调度 数据库
Django使用django-apscheduler实现定时任务
【7月更文挑战第8天】定时任务可以在后台定时执行指定的代码,避免了很多人为操作。下面是在Django项目中如何使用定时任务的具体操作流程
481 1
|
调度 数据库 Python
Django实现定时任务
Django实现定时任务
168 0
|
JSON NoSQL Redis
Win11系统下使用Django+Celery实现异步任务队列以及定时(周期)任务(2020年最新攻略)
首先明确一点,celery4.1+的官方文档已经详细说明,该版本之后不需要引入依赖 django-celery 这个库了,直接用 celery 本身就可以了,就在去年年初的一篇文章[python3.7.2+Django2.0.4 使用django-celery遇到的那些坑](https://v3u.cn/a_id_54),中提到的一些bug,在今年早已不复存在,所以技术更新频率越来越快,本文详细阐述用新版Celery(4.4.2)来实现。
Win11系统下使用Django+Celery实现异步任务队列以及定时(周期)任务(2020年最新攻略)
|
Linux 测试技术 Python
|
监控 Python
Python编程:Django中使用Celery执行异步任务和定时任务
Python编程:Django中使用Celery执行异步任务和定时任务
228 0
|
Python NoSQL Redis
Django配置celery定时任务
安装celery 使用redis+celery的方式(使用的是阿里源,也可以选择不用) pip install -i https://mirrors.aliyun.com/pypi/simple/ -U "celery[redis]" 修改Django的settings配置文件 添加celery文件在app同级目录下添加一个文件夹,例:service_celery 在文件夹中添加celery.
|
存储 消息中间件 NoSQL
Django配置celery(非djcelery)执行异步任务和定时任务
所有演示均基于Django2.0 celery是一个基于python开发的简单、灵活且可靠的分布式任务队列框架,支持使用任务队列的方式在分布式的机器/进程/线程上执行任务调度。采用典型的生产者-消费者模型,主要由三部分组成: 消息队列broker:broker实际上就是一个MQ队列服务,可以使...
2487 0