Django Q Documentation Release 0.7.11

• 语言: 英语
• 格式: .pdf
• 来源: django-q.readthedocs.io

摘要

Django Q is a native Django task queue, scheduler and worker application that leverages Python multiprocessing. It supports asynchronous tasks, scheduled and repeated tasks, and integrates with various message brokers such as Redis, Amazon SQS, and MongoDB. The application offers features like task encryption, result caching, and failure handling. It also provides admin pages for monitoring successful, failed, and scheduled tasks. Django Q is compatible with multiple Django versions and offers configuration options to customize worker settings, timeouts, and task limits. The document outlines installation steps, configuration options, and advanced features like task chaining and result hooks.

AI总结

以下是对《Django Q Documentation Release 0.7.11》的中文总结：

---

### 《Django Q 文档，版本 0.7.11》

#### 1. 简介
Django Q 是一个原生于 Django 的任务队列、调度和工作应用，支持 Python 多处理。它支持异步任务、定时任务、任务链和钩子，并与 Django 管理界面集成。Django Q兼容多种消息传输代理，包括 Redis、Disque、IronMQ、SQS 和 MongoDB。

---

#### 2. 主要功能
- **核心功能**：
- 多处理worker池。
- 异步任务和定时任务。
- 加密和压缩任务包。
- 支持数据库或缓存存储任务结果。
- 提供任务钩子、组和链。
- Django Admin集成。
- 支持多集群监控。
- 兼容 Redis、Disque、IronMQ、SQS 和 MongoDB。
- **环境支持**：
- 测试通过 Python 2.7 & 3.5，Django 1.7.10 & 1.8.5。

---

#### 3. 安装
1. 使用 pip 安装：`pip install django-q`。
2. 在 `settings.py` 中添加 `django_q` 到 `INSTALLED_APPS`。
3. 运行数据库迁移：`python manage.py migrate`。
4. 配置消息传输代理并安装对应客户端库。

---

#### 4. 配置选项
通过 `Q_CLUSTER` 字典在 `settings.py` 中配置：
- `name`：用于区分项目的名称，默认为 `'default'`。
- `workers`：工人数量， 默认为 CPU 核心数，可手动设置。
- `recycle`：工人处理任务数量后重启， 默认为 500。
- `timeout`：工人处理任务超时时间， 默认无限。
- `compress`：压缩任务包， 默认为 `False`。
- `save_limit`：限制成功任务存储数量， 默认为 250。
- `queue_limit`：单个集群内存中保留的任务数量， 默认为 `workers**2`。
- `label`：Django Admin页面标签， 默认为 `'Django Q'`。
- `catch_up`：集群恢复后是否补偿未执行的计划任务， 默认为 `True`。

---

#### 5. 消息传输代理
支持以下代理：
1. **Redis**：
- 需要 `redis` 客户端库。
2. **Disque**：
- 支持批量取队列，需配置 `disque_nodes`。
3. **IronMQ**：
- HTTP队列服务，可作为Heroku插件使用。
4. **SQS**：
- 亚马逊简单队列服务，稳定且经济实惠。
5. **MongoDB**：
- 高扩展性NoSQL数据库，支持高吞吐量。

---

#### 6. 管理界面功能
在 Django Admin 中提供以下功能：
1. **成功任务**：
- 显示所有成功执行的任务。
- 提供按名称、函数或组筛选功能。
- 结果可通过 `save_limit` 限制存储数量。
2. **失败任务**：
- 显示因错误未完成的任务。
- 支持从管理界面重提交失败任务。
3. **定时任务**：
- 查看、创建、编辑或删除定时任务。

---

#### 7. 任务选项
- **同步执行**：通过 `sync=True` 模拟同步任务，适合测试。
- **缓存结果**：将结果存储在缓存后端，减少数据库压力。
- **任务组**：通过 `group` 实现任务分组，便于管理和过滤。

---

### 总结
Django Q 是一个功能强大的异步任务和调度工具，支持多种消息传输代理和灵活的配置选项。它通过 Django Admin 提供便捷的任务管理功能，并支持高扩展性和高性能的任务处理。