This document describes the current stable version of Celery (3.1). For development docs, go here.

celery.concurrency.base

celery.concurrency.base

TaskPool interface.

class celery.concurrency.base.BasePool(limit=None, putlocks=True, forking_enable=True, callbacks_propagate=(), **options)

CLOSE = 2

RUN = 1

TERMINATE = 3

class Timer(schedule=None, on_error=None, on_tick=None, on_start=None, max_interval=None, **kwargs)

class Entry(fun, args=None, kwargs=None)

args

cancel()

cancelled

fun

kwargs

tref

BasePool.Timer.Schedule

alias of Timer

BasePool.Timer.call_after(*args, **kwargs)

BasePool.Timer.call_at(*args, **kwargs)

BasePool.Timer.call_repeatedly(*args, **kwargs)

BasePool.Timer.cancel(tref)

BasePool.Timer.clear()

BasePool.Timer.empty()

BasePool.Timer.ensure_started()

BasePool.Timer.enter(entry, eta, priority=None)

BasePool.Timer.enter_after(*args, **kwargs)

BasePool.Timer.exit_after(secs, priority=10)

BasePool.Timer.next()

BasePool.Timer.on_tick = None

BasePool.Timer.queue

BasePool.Timer.run()

BasePool.Timer.running = False

BasePool.Timer.stop()

BasePool.active

BasePool.apply_async(target, args=[], kwargs={}, **options)

Equivalent of the apply() built-in function.

Callbacks should optimally return as soon as possible since otherwise the thread which handles the result will get blocked.

BasePool.close()

BasePool.did_start_ok()

BasePool.flush()

BasePool.info

BasePool.is_green = False

set to true if pool uses greenlets.

BasePool.maintain_pool(*args, **kwargs)

BasePool.num_processes

BasePool.on_apply(*args, **kwargs)

BasePool.on_close()

BasePool.on_hard_timeout(job)

BasePool.on_soft_timeout(job)

BasePool.on_start()

BasePool.on_stop()

BasePool.on_terminate()

BasePool.register_with_event_loop(loop)

BasePool.restart()

BasePool.signal_safe = True

set to true if the pool can be shutdown from within a signal handler.

BasePool.start()

BasePool.stop()

BasePool.task_join_will_block = True

BasePool.terminate()

BasePool.terminate_job(pid, signal=None)

BasePool.uses_semaphore = False

only used by multiprocessing pool

celery.concurrency.base.apply_target(target, args=(), kwargs={}, callback=None, accept_callback=None, pid=None, getpid=<built-in function getpid>, propagate=(), monotonic=<function _monotonic>, **_)