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

celery.concurrency.base

Base Execution Pool.

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

Task pool.

CLOSE = 2

RUN = 1

TERMINATE = 3

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

Timer thread.

Note

This is only used for transports not supporting AsyncIO.

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

Schedule Entry.

args

cancel()

canceled

property cancelled

fun

kwargs

tref

Schedule

alias of Timer

call_after(*args, **kwargs)

call_at(*args, **kwargs)

call_repeatedly(*args, **kwargs)

cancel(tref)

clear()

empty()

ensure_started()

enter(entry, eta, priority=None)

enter_after(*args, **kwargs)

exit_after(secs, priority=10)

next()

on_tick = None

property queue

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

running = False

stop()

property active

apply_async(target, args=None, kwargs=None, **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.

body_can_be_buffer = False

close()

did_start_ok()

flush()

property info

is_green = False

set to true if pool uses greenlets.

maintain_pool(*args, **kwargs)

property num_processes

on_apply(*args, **kwargs)

on_close()

on_hard_timeout(job)

on_soft_timeout(job)

on_start()

on_stop()

on_terminate()

register_with_event_loop(loop)

restart()

signal_safe = True

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

start()

stop()

task_join_will_block = True

terminate()

terminate_job(pid, signal=None)

uses_semaphore = False

only used by multiprocessing pool

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

Apply function within pool context.