autotask 0.5.4

@delayed_task

@delayed_task(delay=0, retries=0, ttl=300)
def some_function(*args, **kwargs):
    ...

对由@delayed_task()装饰的函数的调用将立即返回。该函数本身将在另一个进程中稍后执行。装饰器接受以下可选参数

delay:

在函数执行之前至少等待的秒数。默认为0（尽可能快）。

retries:

在函数执行失败时重试执行的次数。默认为0（不重试）。

ttl:

生存时间。在运行函数后，结果至少会保存这个时间。默认为300秒。

装饰的函数返回一个具有以下属性的对象

ready:

如果任务已执行则为True，如果任务仍在等待执行则为False。

status:

可以有以下值（可以从中导入autotask.task）

from autotask.task import (
    WAITING,
    RUNNING,
    DONE,
    ERROR
)

- WAITING: task waits for execution
- RUNNING: task gets executed right now
- DONE: task has been executed
- ERROR: an error has occured during the execution

result:

执行任务的结果。

error_message:

如果发生错误，将保存错误信息字符串。

一个典型用例是发送由请求触发的电子邮件

from autotask.tasks import delayed_task

@delayed_task()
def send_mail(receivers, message):
    # your implementation here ...

并在你的代码的其他地方

def handle_request(request):
    ...
    send_mail(receivers, message)
    ...
    return response

sendmail()的调用立即发送响应，而不等待邮件服务器完成工作。邮件本身由在另一个进程中运行的worker发送。其他示例包括图像处理或可能需要一些时间并且可以单独处理的其他任务。

@periodic_task

@periodic_task(seconds=3600, start_now=False)
def some_function(*args, **kwargs):
    ...

通过@periodic_task()装饰的函数不应被调用，而必须在启动时导入以执行装饰器的模块中定义。这将注册函数以定期执行。装饰器接受以下可选参数

seconds:

等待再次执行函数的秒数。默认为3600（一小时）。

start_now:

一个布尔值。True：尽可能快地执行，然后定期执行。False：等待给定的时间数秒后定期运行。默认为False。

这里的一个用例可能是运行一些周期性清理

from autotask.tasks import periodic_task

@periodic_task(seconds=600)
def clean_up():
    queryset = MyModel.objects.filter(obsolete=True)
    queryset.delete()

clean_up()函数不应从你的程序中调用。相反，必须在启动Django时导入定义函数的模块。这是因为装饰器在模块导入时执行，这样clean_up函数就由autotask注册，每十分钟调用一次。

@cron_task

@cron_task(minutes=None, hours=None, dow=None,
           months=None, dom=None, crontab=None)
def some_function(*args, **kwargs):
    ...

通过@cron_task()装饰的函数不应被调用，而必须在启动Django时导入以执行装饰器的模块中定义。这将注册函数根据crontab参数执行。这些参数可以作为关键字参数或作为crontab字符串的Python序列提供。

minutes:

任务应在小时内的分钟列表运行。有效的条目是0-59范围内的整数。默认为None，与crontab中的‘*’相同，表示任务每分钟执行一次。

hours:

任务应在一天内的小时列表运行。有效的条目是0-23范围内的整数。默认为None，与crontab中的‘*’相同，表示任务每小时执行一次。

dow:

星期几。一个从0到6的整数列表，星期一为0。任务只在指定的星期几运行。默认为None，与crontab中的‘*’相同，表示任务在一周中的每天执行。

months:

任务应在一年中的月份列表运行。有效的条目是1-12范围内的整数。默认为None，与crontab中的‘*’相同，表示任务每月执行一次。

dom:

任务应在一个月中的天列表运行。有效的条目是1-31范围内的整数。默认为None，与crontab中的‘*’相同，表示任务每天执行一次。

如果既没有提供 dom 也没有提供 dow，则任务将在一个月中的每一天运行。如果两者之一被设置，则应用给定的限制。如果两者都设置了，则允许的日期相互补充。

crontab:

表示有效 crontab 的字符串。请参阅：[CRON 表达式](https://en.wikipedia.org/wiki/Cron#CRON_expression)（限制为只允许整数和特殊符号(*)、(-)），以下是一些示例

The order of arguments is:
'minutes hours dow months dom'

'* * * * *':       runs every minute
                   (same as @periodic_task(seconds=60))
'15,30 7 * * *':   runs every day at 7:15 and 7:30
'* 9 0 4,7 10-15': runs at 9:00 every monday and
                   from the 10th to the 15th of a month
                   but only in April and July.

如果提供了 crontab 参数，则忽略其他所有参数。在启用 @cron_task 时，建议也安装 [pytz](http://pytz.sourceforge.net/)。

例如，使用 @cron_task 可能是发送时事通讯

from autotask.tasks import cron_task

@cron_task(crontab="30 7 0 * *")
def send_newsletter():
    # your implementation here

与 @periodic_task 装饰器类似，此函数不是从程序中调用，而必须在启动 django 时导入。函数 send_newsletter 将在每个周一早上 7:30 执行。

除了使用 crontab 参数作为字符串外，还可以使用关键字参数将调度信息提供给装饰器

@cron_task(minutes=[30], hours=[7], dow=[0])
def send_newsletter():
    # your implementation here