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

celery.bin.base

Click customizations for Celery.

class celery.bin.base.CLIContext(app, no_color, workdir, quiet=False)[source]

Context Object for the CLI.

ERROR
OK
echo(message=None, **kwargs)[source]
error(message=None, **kwargs)[source]
pretty(n)[source]
pretty_dict_ok_error(n)[source]
pretty_list(n)[source]
say_chat(direction, title, body='', show_body=False)[source]
secho(message=None, **kwargs)[source]
style(message=None, **kwargs)[source]
class celery.bin.base.CeleryCommand(name, context_settings=None, callback=None, params=None, help=None, epilog=None, short_help=None, options_metavar='[OPTIONS]', add_help_option=True, no_args_is_help=False, hidden=False, deprecated=False)[source]

Customized command for Celery.

format_options(ctx, formatter)[source]

Write all the options into the formatter if they exist.

class celery.bin.base.CeleryDaemonCommand(*args, **kwargs)[source]

Daemon commands.

class celery.bin.base.CeleryOption(*args, **kwargs)[source]

Customized option for Celery.

get_default(ctx, *args, **kwargs)[source]

Given a context variable this calculates the default value.

class celery.bin.base.CommaSeparatedList[source]

Comma separated list argument.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

name = 'comma separated list'

the descriptive name of this type

class celery.bin.base.ISO8601DateTime[source]

ISO 8601 Date Time argument.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

name = 'iso-86091'

the descriptive name of this type

class celery.bin.base.ISO8601DateTimeOrFloat[source]

ISO 8601 Date Time or float argument.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

name = 'iso-86091 or float'

the descriptive name of this type

class celery.bin.base.JsonArray[source]

JSON formatted array argument.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

name = 'json array'

the descriptive name of this type

class celery.bin.base.JsonObject[source]

JSON formatted object argument.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

name = 'json object'

the descriptive name of this type

class celery.bin.base.LogLevel[source]

Log level option.

convert(value, param, ctx)[source]

Converts the value. This is not invoked for values that are None (the missing value).

celery.bin.base.handle_preload_options(f)[source]

Extract preload options and return a wrapped callable.