celery の API リファレンス
celery (celery/celery) の公開 API 400 件 —— クラス 171、関数 68、メソッド 161。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: celery/celery
| 種別 | 件数 |
|---|---|
| クラス | 171 |
| 関数 | 68 |
| メソッド | 161 |
API 一覧
func
celery.__main__.main() -> NoneEntrypoint to the ``celery`` umbrella command.
func
celery._state.disable_trace()Disable tracing of app instances.
func
celery._state.enable_trace()Enable tracing of app instances.
func
celery._state.get_current_app()Return the current app.
func
celery._state.get_current_task()Currently executing task.
func
celery._state.set_default_app(app)Set default app.
class
celery.app.amqp.AMQPApp AMQP API: app.amqp.
method
celery.app.amqp.AMQP.Router(queues=None, create_missing=None)Return the current task router.
method
celery.app.amqp.AMQP.queues()Queue name⇒ declaration mapping.
class
celery.app.amqp.QueuesQueue name⇒ declaration mapping.
method
celery.app.amqp.Queues.add(queue, **kwargs)Add new queue.
method
celery.app.amqp.Queues.format(indent=0, indent_first=True)Format routing table into string for log dumps.
class
celery.app.annotations.MapAnnotationAnnotation map: task_name => attributes.
func
celery.app.annotations.resolve_all(anno, task)Resolve all pending annotations.
func
celery.app.backends.by_url(backend=None, loader=None)Get backend class by URL.
class
celery.app.base.CeleryCelery application.
method
celery.app.base.Celery.AsyncResult()Create new result instance.
method
celery.app.base.Celery.GroupResult()Create new group result instance.
method
celery.app.base.Celery.Task()Base task class for this app.
method
celery.app.base.Celery.WorkController(**kwargs)Embeddable worker.
method
celery.app.base.Celery.Worker()Worker application.
method
celery.app.base.Celery.autodiscover_tasks(packages=None, related_name='tasks', force=False)Auto-discover task modules.
method
celery.app.base.Celery.backend()Current backend instance.
method
celery.app.base.Celery.bugreport()Return information useful in bug reports.
method
celery.app.base.Celery.close()Clean up after the application.
method
celery.app.base.Celery.conf()Current configuration.
method
celery.app.base.Celery.control()Remote control: :class:`~@control`.
method
celery.app.base.Celery.create_task_cls()Create a base task class bound to this app.
method
celery.app.base.Celery.finalize(auto=False)Finalize the app.
method
celery.app.base.Celery.loader()Current loader instance.
method
celery.app.base.Celery.log()Logging: :class:`~@log`.
method
celery.app.base.Celery.now()Return the current time and date as a datetime.
method
celery.app.base.Celery.oid()Universally unique identifier for this app.
method
celery.app.base.Celery.on_init()Optional callback called at init.
method
celery.app.base.Celery.pool()Broker connection pool: :class:`~@pool`.
method
celery.app.base.Celery.select_queues(queues=None)Select subset of queues.
method
celery.app.base.Celery.set_current()Make this the current app for this thread.
method
celery.app.base.Celery.set_default()Make this the default app for all threads.
method
celery.app.base.Celery.start(argv=None)Run :program:`celery` using `argv`.
method
celery.app.base.Celery.subclass_with_self(Class, name=None, attribute='app', reverse=None, keep_reduce=False, **kw)Subclass an app-compatible class.
method
celery.app.base.Celery.timezone()Current timezone for this app.
func
celery.app.bugreport(app=None)Return information useful in bug reports.
class
celery.app.control.ControlWorker remote control client.
method
celery.app.control.Control.inspect()Create new :class:`Inspect` instance.
method
celery.app.control.Control.ping(destination=None, timeout=1.0, **kwargs)Ping all (or specific) workers.
method
celery.app.control.Control.purge(connection=None)Discard all waiting tasks.
method
celery.app.control.Control.shutdown(destination=None, **kwargs)Shutdown worker(s).
class
celery.app.control.InspectAPI for inspecting workers.
method
celery.app.control.Inspect.clock()Get the Clock value on workers.
method
celery.app.control.Inspect.conf(with_defaults=False)Return configuration of each worker.
method
celery.app.control.Inspect.memsample()Return sample current RSS memory usage.
method
celery.app.control.Inspect.ping(destination=None)Ping all (or specific) workers.
method
celery.app.control.Inspect.revoked()Return list of revoked tasks.
method
celery.app.control.Inspect.stats()Return statistics of worker.
func
celery.app.control.flatten_reply(reply)Flatten node replies.
class
celery.app.defaults.OptionDescribes a Celery configuration option.
func
celery.app.defaults.find(name, namespace='celery')Find setting by name.
func
celery.app.defaults.flatten(d, root='', keyfilter=_flatten_keys)Flatten settings.
class
celery.app.events.EventsImplements app.events.
class
celery.app.log.LoggingApplication logging setup (app.log).
class
celery.app.log.TaskFormatterFormatter for tasks, adding the task name and id.
class
celery.app.registry.TaskRegistryMap of registered tasks.
method
celery.app.registry.TaskRegistry.register(task)Register a task in the task registry.
method
celery.app.registry.TaskRegistry.unregister(name)Unregister task by name.
class
celery.app.routes.MapRouteCreates a router out of a :class:`dict`.
class
celery.app.routes.RouterRoute tasks based on the :setting:`task_routes` setting.
func
celery.app.routes.prepare(routes)Expand the :setting:`task_routes` setting.
func
celery.app.shared_task(*args, **kwargs)Create shared task (decorator).
class
celery.app.task.ContextTask request variables (Task.request).
class
celery.app.task.TaskTask base class.
method
celery.app.task.Task.delay(*args, **kwargs)Star argument version of :meth:`apply_async`.
method
celery.app.task.Task.on_bound(app)Called when the task is bound to an app.
method
celery.app.task.Task.on_failure(exc, task_id, args, kwargs, einfo)Error handler.
method
celery.app.task.Task.on_replace(sig)Handler called when the task is replaced.
method
celery.app.task.Task.on_retry(exc, task_id, args, kwargs, einfo)Retry handler.
method
celery.app.task.Task.on_success(retval, task_id, args, kwargs)Success handler.
method
celery.app.task.Task.replace(sig)Replace this task, with a new task inheriting the task id.
method
celery.app.task.Task.run(*args, **kwargs)The body of the task executed by workers.
method
celery.app.task.Task.s(*args, **kwargs)Create signature.
method
celery.app.task.Task.send_event(type_, retry=True, retry_policy=None, **fields)Send monitoring event message.
method
celery.app.task.Task.si(*args, **kwargs)Create immutable signature.
method
celery.app.task.Task.signature(args=None, *starargs, **starkwargs)Create signature.
method
celery.app.task.Task.update_state(task_id=None, state=None, meta=None, **kwargs)Update task state.
class
celery.app.trace.TraceInfoInformation about task execution.
method
celery.app.trace.TraceInfo.handle_failure(task, req, store_errors=True, call_errbacks=True)Handle exception.
method
celery.app.trace.TraceInfo.handle_retry(task, req, store_errors=True, **kwargs)Handle retry exception.
func
celery.app.trace.info(fmt, context)Log 'fmt % context' with severity 'INFO'.
func
celery.app.trace.setup_worker_optimizations(app, hostname=None)Setup worker related optimizations.
class
celery.app.utils.AppPicklerOld application pickler/unpickler (< 3.1).
class
celery.app.utils.SettingsCelery settings object.
method
celery.app.utils.Settings.find_option(name, namespace='')Search for option by name.
func
celery.app.utils.filter_hidden_settings(conf)Filter sensitive settings.
func
celery.app.utils.find_app(app, symbol_by_name=symbol_by_name, imp=import_from_cwd)Find app by name.
class
celery.apps.beat.BeatBeat as a service.
method
celery.apps.beat.Beat.install_sync_handler(service:beat.Service) -> NoneInstall a `SIGTERM` + `SIGINT` handler saving the schedule.
class
celery.apps.multi.ClusterRepresent a cluster of workers.
class
celery.apps.multi.NodeRepresents a node in a cluster.
class
celery.apps.worker.WorkerWorker as a program.
func
celery.apps.worker.on_cold_shutdown(worker:Worker)Signal handler for cold shutdown.
func
celery.apps.worker.on_hard_shutdown(worker:Worker)Signal handler for hard shutdown.
class
celery.backends.arangodb.ArangoDbBackendArangoDb backend.
method
celery.backends.arangodb.ArangoDbBackend.connection()Connect to the arangodb server.
method
celery.backends.arangodb.ArangoDbBackend.db()Database Object to the given database.
class
celery.backends.asynchronous.AsyncBackendMixinMixin for backends that enables the async API.
class
celery.backends.asynchronous.BaseResultConsumerManager responsible for consuming result messages.
class
celery.backends.asynchronous.DrainerResult draining service.
class
celery.backends.azureblockblob.AzureBlockBlobBackendAzure Storage Block Blob backend for Celery.
method
celery.backends.azureblockblob.AzureBlockBlobBackend.set(key, value)Store a value for a given key.
method
celery.backends.base.Backend.cleanup()Backend cleanup.
method
celery.backends.base.Backend.get_result(task_id)Get the result of a task.
method
celery.backends.base.Backend.get_state(task_id)Get the state of a task.
method
celery.backends.base.Backend.get_task_meta(task_id, cache=True)Get task meta from backend.
method
celery.backends.base.Backend.get_traceback(task_id)Get the traceback for a failed task.
method
celery.backends.base.Backend.mark_as_started(task_id, **meta)Mark a task as started.
method
celery.backends.base.Backend.prepare_value(result)Prepare value for storage.
method
celery.backends.base.Backend.restore_group(group_id, cache=True)Get the result for a group.
method
celery.backends.base.Backend.store_result(task_id, result, state, traceback=None, request=None, **kwargs)Update task state and result.
class
celery.backends.base.BaseBackendBase (synchronous) result backend.
class
celery.backends.base.DisabledBackendDummy result backend.
class
celery.backends.base.KeyValueStoreBackendResult backend base class for key/value stores.
func
celery.backends.base.unpickle_backend(cls, args, kwargs)Return an unpickled backend.
class
celery.backends.cache.CacheBackendCache result backend.
method
celery.backends.cache.CacheBackend.as_uri(*args, **kwargs)Return the backend as an URI.
class
celery.backends.cassandra.CassandraBackendCassandra/AstraDB backend utilizing DataStax driver.
class
celery.backends.consul.ConsulBackendConsul.io K/V store backend for Celery.
method
celery.backends.consul.ConsulBackend.set(key, value)Set a key in Consul.
class
celery.backends.cosmosdbsql.CosmosDBSQLBackendCosmosDB/SQL backend for Celery.
method
celery.backends.cosmosdbsql.CosmosDBSQLBackend.delete(key)Delete the value at a given key.
method
celery.backends.cosmosdbsql.CosmosDBSQLBackend.set(key, value)Store a value for a given key.
class
celery.backends.couchbase.CouchbaseBackendCouchbase backend.
class
celery.backends.couchdb.CouchBackendCouchDB backend.
class
celery.backends.database.DatabaseBackendThe database result backend.
method
celery.backends.database.DatabaseBackend.cleanup()Delete expired meta-data.
class
celery.backends.database.models.TaskTask result/status.
class
celery.backends.database.models.TaskExtendedFor the extend result.
class
celery.backends.database.models.TaskSetTaskSet result.
class
celery.backends.database.session.SessionManagerManage SQLAlchemy sessions.
class
celery.backends.dynamodb.DynamoDBBackendAWS DynamoDB result backend.
method
celery.backends.dynamodb.DynamoDBBackend.incr(key:bytes) -> intAtomically increase the chord_count and return the new count
class
celery.backends.elasticsearch.ElasticsearchBackendElasticsearch Backend.
class
celery.backends.filesystem.FilesystemBackendFile-system result backend.
method
celery.backends.filesystem.FilesystemBackend.cleanup()Delete expired meta-data.
class
celery.backends.gcs.GCSBackendGoogle Cloud Storage task result backend.
method
celery.backends.gcs.GCSBackend.firestore_client()Returns a firestore client.
method
celery.backends.gcs.GCSBackend.on_chord_part_return(request, state, result, **kwargs)Chord part return callback.
class
celery.backends.gcs.GCSBackendBaseGoogle Cloud Storage task result backend.
method
celery.backends.gcs.GCSBackendBase.client()Returns a storage client.
class
celery.backends.mongodb.MongoBackendMongoDB result backend.
method
celery.backends.mongodb.MongoBackend.as_uri(include_password=False)Return the backend as an URI.
method
celery.backends.mongodb.MongoBackend.cleanup()Delete expired meta-data.
method
celery.backends.mongodb.MongoBackend.collection()Get the meta-data task collection.
method
celery.backends.mongodb.MongoBackend.database()Get database from MongoDB connection.
method
celery.backends.mongodb.MongoBackend.group_collection()Get the meta-data task collection.
class
celery.backends.redis.RedisBackendRedis task result store.
class
celery.backends.redis.SentinelBackendRedis sentinel task result store.
class
celery.backends.redis.SentinelManagedSSLConnectionConnect to a Redis server using Sentinel + TLS.
class
celery.backends.rpc.BacklogLimitExceededToo much state history to fast-forward.
class
celery.backends.rpc.RPCBackendBase class for the RPC result backend.
class
celery.backends.rpc.RPCBackend.ConsumerConsumer that requires manual declaration of queues.
class
celery.backends.rpc.RPCBackend.QueueQueue that never caches declaration.
class
celery.backends.s3.S3BackendAn S3 task result store.
func
celery.beat.EmbeddedService(app, max_interval=None, **kwargs)Return embedded clock service.
class
celery.beat.PersistentSchedulerScheduler backed by :mod:`shelve` database.
class
celery.beat.ScheduleEntryAn entry in the scheduler.
method
celery.beat.ScheduleEntry.update(other)Update values from another entry.
class
celery.beat.SchedulerScheduler for periodic tasks.
class
celery.beat.SchedulingErrorAn error occurred while scheduling a task.
class
celery.beat.ServiceCelery periodic task service.
func
celery.bin.amqp.amqp(ctx)AMQP Administration Shell.
class
celery.bin.base.CLIContextContext Object for the CLI.
class
celery.bin.base.CeleryCommandCustomized command for Celery.
class
celery.bin.base.CeleryDaemonCommandDaemon commands.
class
celery.bin.base.CeleryOptionCustomized option for Celery.
class
celery.bin.base.CommaSeparatedListComma separated list argument.
class
celery.bin.base.DaemonOptionCommon daemonization option
method
celery.bin.base.DaemonOption.daemon_setting(ctx:Context, opt:CeleryOption, value:Any) -> AnyTry to fetch daemonization option from applications settings.
class
celery.bin.base.ISO8601DateTimeISO 8601 Date Time argument.
class
celery.bin.base.ISO8601DateTimeOrFloatISO 8601 Date Time or float argument.
class
celery.bin.base.JsonArrayJSON formatted array argument.
class
celery.bin.base.JsonObjectJSON formatted object argument.
class
celery.bin.base.LogLevelLog level option.
func
celery.bin.call.call(ctx, name, args, kwargs, eta, countdown, expires, serializer, queue, exchange, routing_key)Call a task by name.
func
celery.bin.celery.celery(ctx, app, broker, result_backend, loader, config, workdir, no_color, quiet, version, skip_checks)Celery command entrypoint.
func
celery.bin.celery.main() -> intStart celery umbrella command.
func
celery.bin.events.events(ctx, dump, camera, detach, frequency, maxrate, loglevel, **kwargs)Event-stream utilities.
func
celery.bin.graph.bootsteps(ctx)Display bootsteps graph.
func
celery.bin.graph.graph(ctx)The ``celery graph`` command.
func
celery.bin.graph.workers(ctx)Display workers graph.
func
celery.bin.list.bindings(ctx)Inspect queue bindings.
func
celery.bin.list.list_(ctx)Get info from broker.
func
celery.bin.logtool.logtool(ctx)The ``celery logtool`` command.
class
celery.bin.multi.MultiToolThe ``celery multi`` program.
func
celery.bin.multi.multi(ctx, **kwargs)Start multiple worker instances.
func
celery.bin.upgrade.upgrade(ctx)Perform upgrade between versions.
class
celery.bin.worker.AutoscaleAutoscaling parameter.
class
celery.bin.worker.CeleryBeatCelery Beat flag.
class
celery.bin.worker.HostnameHostname option.
class
celery.bin.worker.WorkersPoolWorkers pool option.
class
celery.bootsteps.BlueprintBlueprint containing bootsteps that can be applied to objects.
class
celery.bootsteps.ConsumerStepBootstep that starts a message consumer.
class
celery.bootsteps.StartStopStepBootstep that must be started and stopped in order.
class
celery.bootsteps.StepA Bootstep.
method
celery.bootsteps.Step.create(parent)Create the step.
method
celery.bootsteps.Step.include_if(parent)Return true if bootstep should be included.
class
celery.bootsteps.StepFormatterGraph formatter for :class:`Blueprint`.
class
celery.bootsteps.StepTypeMeta-class for steps.
class
celery.canvas.SignatureTask Signature.
method
celery.canvas.Signature.apply(args=None, kwargs=None, **options)Call task locally.
method
celery.canvas.Signature.clone(args=None, kwargs=None, **opts)Create a copy of this signature.
method
celery.canvas.Signature.flatten_links()Return a recursive list of dependencies.
method
celery.canvas.Signature.from_dict(d, app=None)Create a new signature from a dict.
method
celery.canvas.Signature.register_type(name=None)Register a new type of signature.
class
celery.canvas.StampingVisitorStamping API.
method
celery.canvas.StampingVisitor.on_callback(callback, **header) -> dictMethod that is called on callback stamping.
method
celery.canvas.StampingVisitor.on_chain_end(chain, **headers) -> NoneMethod that is called on chain stamping end.
method
celery.canvas.StampingVisitor.on_chain_start(chain, **headers) -> dictMethod that is called on chain stamping start.
method
celery.canvas.StampingVisitor.on_chord_body(sig, **header) -> dictMethod that is called on chord body stamping.
method
celery.canvas.StampingVisitor.on_chord_header_end(sig, **header) -> NoneMethod that is called on сhord header stamping end.
method
celery.canvas.StampingVisitor.on_errback(errback, **header) -> dictMethod that is called on errback stamping.
method
celery.canvas.StampingVisitor.on_group_end(group, **headers) -> NoneMethod that is called on group stamping end.
method
celery.canvas.StampingVisitor.on_group_start(group, **headers) -> dictMethod that is called on group stamping start.
method
celery.canvas.StampingVisitor.on_signature(sig, **headers) -> dictMethod that is called on signature stamping.
class
celery.canvas.chainChain tasks together.
class
celery.canvas.chunksPartition of tasks into chunks of size n.
class
celery.canvas.groupCreates a group of tasks to be executed in parallel.
func
celery.canvas.maybe_signature(d, app=None, clone=False)Ensure obj is a signature, or None.
func
celery.canvas.maybe_unroll_group(group)Unroll group with only one member.
func
celery.canvas.signature(varies, *args, **kwargs)Create new signature.
class
celery.canvas.xmapMap operation for tasks.
class
celery.canvas.xstarmapMap operation for tasks, using star arguments.
class
celery.concurrency.asynpool.AsynPoolAsyncIO Pool (no threads).
method
celery.concurrency.asynpool.AsynPool.create_process_queues()Create new in, out, etc.
method
celery.concurrency.asynpool.AsynPool.get_process_queues()Get queues for a new process.
method
celery.concurrency.asynpool.AsynPool.on_grow(n)Grow the pool by ``n`` processes.
func
celery.concurrency.asynpool.AsynPool.on_process_up(proc)Called when a process has started.
method
celery.concurrency.asynpool.AsynPool.on_shrink(n)Shrink the pool by ``n`` processes.
method
celery.concurrency.asynpool.AsynPool.process_flush_queues(proc)Flush all queues.
class
celery.concurrency.asynpool.ResultHandlerHandles messages from the pool processes.
class
celery.concurrency.asynpool.WorkerPool worker process.
class
celery.concurrency.base.BasePoolTask pool.
class
celery.concurrency.eventlet.TaskPoolEventlet Task Pool.
class
celery.concurrency.eventlet.TimerEventlet Timer.
func
celery.concurrency.get_available_pool_names()Return all available pool type names.
func
celery.concurrency.get_implementation(cls)Return pool implementation by name.
class
celery.concurrency.gevent.TaskPoolGEvent Pool.
class
celery.concurrency.prefork.TaskPoolMultiprocessing Pool implementation.
method
celery.concurrency.prefork.TaskPool.on_stop()Gracefully stop the pool.
method
celery.concurrency.prefork.TaskPool.on_terminate()Force terminate the pool.
func
celery.concurrency.prefork.process_destructor(pid, exitcode)Pool child process destructor.
func
celery.concurrency.prefork.process_initializer(app, hostname)Pool child process initializer.
class
celery.concurrency.solo.TaskPoolSolo task pool (blocking, inline, fast).
class
celery.concurrency.thread.TaskPoolThread Task Pool.
class
celery.contrib.abortable.AbortableAsyncResultRepresents an abortable result.
class
celery.contrib.abortable.AbortableTaskTask that can be aborted.
method
celery.contrib.abortable.AbortableTask.is_aborted(**kwargs)Return true if task is aborted.
class
celery.contrib.django.task.DjangoTaskExtend the base :class:`~celery.app.task.Task` for Django.
class
celery.contrib.migrate.StateMigration progress state.
class
celery.contrib.migrate.StopFilteringSemi-predicate used to signal filter stop.
func
celery.contrib.migrate.migrate_task(producer, body_, message, queues=None)Migrate single task message.
func
celery.contrib.migrate.republish(producer, message, exchange=None, routing_key=None, remove_props=None)Republish message.
func
celery.contrib.pytest.depends_on_current_app(celery_app)Fixture that sets app as current.
class
celery.contrib.rdb.RdbRemote debugger.
class
celery.contrib.sphinx.TaskDirectiveSphinx task directive.
class
celery.contrib.sphinx.TaskDocumenterDocument task definitions.
class
celery.events.cursesmon.CursesMonitorA curses based Celery task monitor.
func
celery.events.cursesmon.evtop(app=None)Start curses monitor.
class
celery.events.dispatcher.EventDispatcherDispatches event messages.
method
celery.events.dispatcher.EventDispatcher.close()Close the event dispatcher.
method
celery.events.dispatcher.EventDispatcher.flush(errors=True, groups=True)Flush the outbound buffer.
method
celery.events.dispatcher.EventDispatcher.send(type, blind=False, utcoffset=utcoffset, retry=False, retry_policy=None, Event=Event, **fields)Send event.
class
celery.events.dumper.DumperMonitor events.
func
celery.events.dumper.evdump(app=None, out=sys.stdout)Start event dump.
func
celery.events.event.Event(type, _fields=None, __dict__=dict, __now__=time.time, **fields)Create an event.
func
celery.events.event.group_from(type)Get the group part of an event type name.
class
celery.events.receiver.EventReceiverCapture events.
class
celery.events.snapshot.PolaroidRecord event snapshots.
class
celery.events.state.StateRecords clusters state.
method
celery.events.state.State.get_or_create_task(uuid)Get or create task by uuid.
method
celery.events.state.State.get_or_create_worker(hostname, **kwargs)Get or create worker by hostname.
method
celery.events.state.State.task_event(type_, fields)Deprecated, use :meth:`event`.
method
celery.events.state.State.task_types()Return a list of all seen task types.
method
celery.events.state.State.tasks_by_time(limit=None, reverse:bool=True)Generator yielding tasks ordered by time.
method
celery.events.state.State.worker_event(type_, fields)Deprecated, use :meth:`event`.
class
celery.events.state.TaskTask State.
class
celery.events.state.WorkerWorker State.
class
celery.exceptions.AlreadyRegisteredThe task is already registered.
class
celery.exceptions.AlwaysEagerIgnoredsend_task ignores :setting:`task_always_eager` option.
class
celery.exceptions.BackendErrorAn issue writing or reading to/from the backend.
class
celery.exceptions.BackendGetMetaErrorAn issue reading from the backend.
class
celery.exceptions.BackendStoreErrorAn issue writing to the backend.
class
celery.exceptions.CDeprecationWarningWarning of deprecation.
class
celery.exceptions.CPendingDeprecationWarningWarning of pending deprecation.
class
celery.exceptions.CeleryCommandExceptionA general command exception which stores an exit code.
class
celery.exceptions.CeleryErrorBase class for all Celery errors.
class
celery.exceptions.CeleryWarningBase class for all Celery warnings.
class
celery.exceptions.ChordErrorA task part of the chord raised an exception.
class
celery.exceptions.DuplicateNodenameWarningMultiple workers are using the same nodename.
class
celery.exceptions.FixupWarningFixup related warning.
class
celery.exceptions.IgnoreA task can raise this to ignore doing state updates.
class
celery.exceptions.ImproperlyConfiguredCelery is somehow improperly configured.
class
celery.exceptions.InvalidTaskErrorThe task has invalid data or ain't properly constructed.
class
celery.exceptions.MaxRetriesExceededErrorThe tasks max restart limit has been exceeded.
class
celery.exceptions.NotRegisteredThe task is not registered.
class
celery.exceptions.QueueNotFoundTask routed to a queue not in ``conf.queues``.
class
celery.exceptions.RejectA task can raise this if it wants to reject/re-queue the message.
class
celery.exceptions.RetryThe task is to be retried later.
class
celery.exceptions.SecurityErrorSecurity related exception.
class
celery.exceptions.SecurityWarningPotential security issue found.
class
celery.exceptions.TaskErrorTask related errors.
class
celery.exceptions.TaskPredicateBase class for task-related semi-predicates.
class
celery.exceptions.TaskRevokedErrorThe task has been revoked, so no result available.
class
celery.exceptions.TimeoutErrorThe operation timed out.
class
celery.exceptions.WorkerShutdownSignals that the worker should perform a warm shutdown.
class
celery.exceptions.WorkerTerminateSignals that the worker should terminate immediately.
func
celery.exceptions.reraise(tp, value, tb=None)Reraise exception.
class
celery.fixups.django.DjangoFixupFixup installed when using Django.
func
celery.fixups.django.fixup(app:'Celery', env:str='DJANGO_SETTINGS_MODULE') -> Optional['DjangoFixup']Install Django fixup if settings module environment is set.
class
celery.loaders.app.AppLoaderDefault loader used when an app is specified.
class
celery.loaders.base.BaseLoaderBase class for loaders.
method
celery.loaders.base.BaseLoader.conf()Loader configuration.
method
celery.loaders.base.BaseLoader.on_process_cleanup()Called after a task is executed.
method
celery.loaders.base.BaseLoader.on_task_init(task_id, task)Called before a task is executed.
method
celery.loaders.base.BaseLoader.on_worker_process_init()Called when a child process starts.
func
celery.loaders.base.find_related_module(package, related_name)Find module in package.
class
celery.loaders.default.LoaderThe loader used by the default app.
func
celery.loaders.get_loader_cls(loader)Get loader class by name/alias.
class
celery.local.PromiseProxyProxy that evaluates object once.
class
celery.local.ProxyProxy to another object.
func
celery.local.getappattr(path)Get attribute from current_app recursively.
func
celery.local.try_import(module, default=None)Try to import and return module.
func
celery.maybe_patch_concurrency(argv=None, short_opts=None, long_opts=None, patches=None)Apply eventlet/gevent monkeypatches.
class
celery.platforms.DaemonContextContext manager daemonizing the process.
class
celery.platforms.LockFailedRaised if a PID lock can't be acquired.
class
celery.platforms.PidfilePidfile.
method
celery.platforms.Pidfile.acquire()Acquire lock.
method
celery.platforms.Pidfile.is_locked()Return true if the pid lock exists.
method
celery.platforms.Pidfile.read_pid()Read and return the current pid.
method
celery.platforms.Pidfile.release(*args)Release lock.
method
celery.platforms.Pidfile.remove()Remove the lock.
class
celery.platforms.SignalsConvenience interface to :mod:`signals`.
method
celery.platforms.Signals.ignore(*names)Ignore signal using :const:`SIG_IGN`.
method
celery.platforms.Signals.signum(name)Get signal number by name.
method
celery.platforms.Signals.update(_d_=None, **sigmap)Set signal handlers from a mapping.
func
celery.platforms.create_pidlock(pidfile)Create and verify pidfile.
func
celery.platforms.fd_by_path(paths)Return a list of file descriptors.
func
celery.platforms.get_errno_name(n)Get errno for string (e.g., ``ENOENT``).
func
celery.platforms.initgroups(uid, gid)Init process group permissions.
func
celery.platforms.parse_gid(gid)Parse group id.
func
celery.platforms.parse_uid(uid)Parse user id.
func
celery.platforms.set_mp_process_title(*a, **k)Disabled feature.
func
celery.platforms.setgroups(groups)Set active groups from a list of group ids.
func
celery.platforms.signal_name(signum)Return name of signal from signal number.
class
celery.result.AsyncResultQuery task state.
method
celery.result.AsyncResult.as_list()Return as a list of task IDs.
method
celery.result.AsyncResult.collect(intermediate=False, **kwargs)Collect results as they return.
method
celery.result.AsyncResult.date_done()UTC date and time.
method
celery.result.AsyncResult.failed()Return :const:`True` if the task failed.
method
celery.result.AsyncResult.result()Task return value.
method
celery.result.AsyncResult.state()The tasks current state.
method
celery.result.AsyncResult.task_id()Compat.
method
celery.result.AsyncResult.traceback()Get the traceback of a failed task.
class
celery.result.EagerResultResult that we know has already been executed.
method
celery.result.EagerResult.result()The tasks return value.
method
celery.result.EagerResult.state()The tasks state.
method
celery.result.EagerResult.traceback()The traceback if the task failed.
class
celery.result.GroupResultLike :class:`ResultSet`, but with an associated id.
class
celery.result.ResultBaseBase class for results.
class
celery.result.ResultSetA collection of results.
method
celery.result.ResultSet.clear()Remove all results from this set.
method
celery.result.ResultSet.completed_count()Task completion count.
method
celery.result.ResultSet.failed()Return true if any of the tasks failed.
method
celery.result.ResultSet.ready()Did all of the tasks complete?
method
celery.result.ResultSet.successful()Return true if all tasks successful.
method
celery.result.ResultSet.update(results)Extend from iterable of results.
func
celery.result.result_from_tuple(r, app=None)Deserialize result from tuple.
class
celery.schedules.crontabCrontab schedule.
method
celery.schedules.crontab.from_string(crontab:str) -> crontabCreate a Crontab from a cron expression string.
method
celery.schedules.crontab.is_due(last_run_at:datetime) -> tuple[bool, datetime]Return tuple of ``(is_due, next_time_to_run)``.
method
celery.schedules.crontab.remaining_estimate(last_run_at:datetime, ffwd:type=ffwd) -> timedeltaEstimate of next run time.
class
celery.schedules.crontab_parserParser for Crontab expressions.
class
celery.schedules.scheduleSchedule for periodic task.
method
celery.schedules.schedule.is_due(last_run_at:datetime) -> tuple[bool, datetime]Return tuple of ``(is_due, next_time_to_check)``.
class
celery.schedules.solarSolar event.
method
celery.schedules.solar.is_due(last_run_at:datetime) -> tuple[bool, datetime]Return tuple of ``(is_due, next_time_to_run)``.
method
celery.schedules.solar.remaining_estimate(last_run_at:datetime) -> timedeltaReturn estimate of next time to run.
class
celery.security.certificate.CertStoreBase class for certificate stores.
method
celery.security.certificate.CertStore.itercerts() -> Iterator[Certificate]Return certificate iterator.
class
celery.security.certificate.CertificateX.509 certificate.
method
celery.security.certificate.Certificate.get_issuer() -> strReturn issuer (CA) as a string.
method
celery.security.certificate.Certificate.get_serial_number() -> intReturn the serial number in the certificate.
method
celery.security.certificate.Certificate.has_expired() -> boolCheck if the certificate has expired.
method
celery.security.certificate.Certificate.verify(data:bytes, signature:bytes, digest:HashAlgorithm | Prehashed) -> NoneVerify signature for string containing data.
class
celery.security.certificate.FSCertStoreFile system certificate store.
class
celery.security.key.PrivateKeyRepresents a private key.
method
celery.security.key.PrivateKey.sign(data, digest)Sign string containing data.
class
celery.security.serialization.SecureSerializerSigned serializer.
func
celery.states.precedence(state:str) -> intGet the precedence index for state.
class
celery.states.stateTask state.
class
celery.utils.abstract.CallableSignatureCelery Signature interface.
class
celery.utils.abstract.CallableTaskTask interface.
この情報について
掲載しているシグネチャは celery/celery の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。