作者博客公众号 dabaispace
欢迎关注微信公众号:
白程序员的自习室

python模块:django-crontab实现服务端的定时任务

公司 Django 应用中需要添加定时任务来定时执行一些数据清洗的功能,因此想到了使用 django-crontab 插件可以满足我的需求,下面就是这个插件的使用方法。

安装

pip install django-crontab

在Django项目中使用

1
2
3
4
5
6
7
8
9
10
11
settings.py

INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'django_crontab'
)

配置任务

1
2
3
4
5
6
7
8
CRONJOBS=(
# 每一分钟执行一次你的定时函数
('*/ * * * *', 'appname.cron.test'),
# 定时函数输出的内容到指定文件(如果该路径或文件不存在将会自动创建)
('0 0 1 * *', 'app名.定时函数所在文件名.定时函数名', '>输出文件路径和名称'),
# 在12点10分执行命令
('10 12 * * *', 'django.core.management.call_command', ['要执行的命令']),
)

官方demo

1
2
3
4
5
6
7
8
9
10
CRONJOBS = [
('*/5 * * * *', 'myapp.cron.my_scheduled_job'),

# format 1
('0 0 1 * *', 'myapp.cron.my_scheduled_job', '>> /tmp/scheduled_job.log'),

# format 2
('0 0 1 * *', 'myapp.cron.other_scheduled_job', ['myapp']),
('0 0 * * 0', 'django.core.management.call_command', ['dumpdata', 'auth'], {'indent': 4}, '> /home/john/backups/last_sunday_auth_backup.json'),
]

上述demo参数说明

  • 参数1:定时 例如47 11 * * * 表示每天的11时47分执行
  • 参数2:方法的python模块路径,如果执行django-admin命令,则写django.core.management.call_command
  • 参数3:方法的位置参数列表(默认值:[]),如果执行django-admin命令,则填写所需执行的命令,例如我们在polls中已经定义过的closepoll
  • 参数4:方法的关键字参数的dict(默认值:{})
  • 参数5:执行log存放位置(即重定向到文件,默认:’’)

其余参数说明

  • CRONTAB_LOCK_JOBS
  • CRONTAB_EXECUTABLE
  • CRONTAB_DJANGO_PROJECT_NAME
  • CRONTAB_DJANGO_MANAGE_PATH
  • CRONTAB_DJANGO_SETTINGS_MODULE
  • CRONTAB_PYTHON_EXECUTABLE
  • CRONTAB_COMMAND_PREFIX
  • CRONTAB_COMMAND_SUFFIX
  • CRONTAB_COMMENT

具体使用方法参考官方使用文档 ,有很详细的说明。

在app中(与views.py同级)新建cron.py文件(文件名不限定)

1
2
def test():
print('django_crontab test')

使用操作

1
2
3
python manage.py crontab add  添加定时任务
python manage.py crontab remove 清除定时任务
python manage.py crontab show 显示定时任务

扩展知识

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
前5个(*)星号

M(分钟0-59)
H(小时0-23)
D(天1-31)
m(月1-12)
d(一星期0-6,0为星期天)

特殊符号

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

eg:
0 14 * * 1-5 周一到周五每天下午两点触发任务
0 10 * * 0,6 周六、周天早上十点触发任务
*/5 9-10 * * 1-5 周一到周五九点到十点每五分钟触发任务

日志打印

1
('*/ * * * *', 'appname.cron.test','> appname.txt'),

参考文档

django-crontab github地址

评论