芹菜任务计划(确保一次只执行一个任务)

Question

我有一个任务，有点像这样：

@task()
def async_work(info):
    ...

在任何时候，我都可能打电话给async_work提供一些信息。出于某种原因，我需要确保一次只有一个async_work在运行，其他调用请求必须等待。

所以我想出了以下代码：

is_locked = False    
@task()
def async_work(info):
    while is_locked:
        pass
    is_locked = True
    ...
    is_locked = False

但它说访问局部变量是无效的......如何解决？

Answer 1

访问局部变量是无效的，因为您可以让多个芹菜工人运行任务。这些工人甚至可能在不同的主机上。因此，基本上，is_locked变量实例的数量与许多 Celery 工作线程正在运行的实例一样多 您的async_work任务。因此，即使您的代码不会引发任何错误，您也不会得到预期的效果。

要实现您的目标，您需要将 Celery 配置为仅运行一个工作线程。由于任何工作人员都可以在任何给定时间处理单个任务，因此您可以获得所需的内容。

编辑：

根据 Worker> 并发指南：

默认情况下，多处理用于执行 任务，但您也可以使用事件。工人数量 可以使用 --concurrency 参数更改进程/线程 并默认为计算机上可用的 CPU 数。

因此，您需要像这样运行工作线程：

$ celery worker --concurrency=1

编辑2：

令人惊讶的是，还有另一种解决方案，而且它甚至在官方文档中，请参阅确保一次只执行一个任务文章。

Answer 2

您可能

不想将concurrency=1用于芹菜工人 - 您希望并发处理任务。相反，您可以使用某种锁定机制。只需确保缓存超时大于完成任务的时间即可。

雷迪斯

import redis
from contextlib import contextmanager
redis_client = redis.Redis(host='localhost', port=6378)

@contextmanager
def redis_lock(lock_name):
    """Yield 1 if specified lock_name is not already set in redis. Otherwise returns 0.
    Enables sort of lock functionality.
    """
    status = redis_client.set(lock_name, 'lock', nx=True)
    try:
        yield status
    finally:
        redis_client.delete(lock_name)

@task()
def async_work(info):
    with redis_lock('my_lock_name') as acquired:
        do_some_work()

内存缓存

受芹菜文档启发的示例

from contextlib import contextmanager
from django.core.cache import cache
@contextmanager
def memcache_lock(lock_name):
    status = cache.add(lock_name, 'lock')
    try:
        yield status
    finally:
        cache.delete(lock_name)

@task()
def async_work(info):
    with memcache_lock('my_lock_name') as acquired:
        do_some_work() 

Answer 3

我已经实现了一个装饰器来处理这个问题。它基于确保一次只从官方 Celery 文档中执行一个任务。

它使用函数的名称及其参数和 kwarg 来创建lock_id，该在 Django 的缓存层中设置/获取（我只用 Memcached 测试过，但它也应该适用于 Redis）。如果lock_id已在缓存中设置，它将把任务放回队列并退出。

CACHE_LOCK_EXPIRE = 30

def no_simultaneous_execution(f):
    """
    Decorator that prevents a task form being executed with the
    same *args and **kwargs more than one at a time.
    """
    @functools.wraps(f)
    def wrapper(self, *args, **kwargs):
        # Create lock_id used as cache key
        lock_id = '{}-{}-{}'.format(self.name, args, kwargs)
        # Timeout with a small diff, so we'll leave the lock delete
        # to the cache if it's close to being auto-removed/expired
        timeout_at = monotonic() + CACHE_LOCK_EXPIRE - 3
        # Try to acquire a lock, or put task back on queue
        lock_acquired = cache.add(lock_id, True, CACHE_LOCK_EXPIRE)
        if not lock_acquired:
            self.apply_async(args=args, kwargs=kwargs, countdown=3)
            return
        try:
            f(self, *args, **kwargs)
        finally:
            # Release the lock
            if monotonic() < timeout_at:
                cache.delete(lock_id)
    return wrapper

然后，您将它作为第一个装饰器应用于任何任务：

@shared_task(bind=True, base=MyTask)
@no_simultaneous_execution
def sometask(self, some_arg):
  ...