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

celery.bin.base

Click customizations for Celery.

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

Context Object for the CLI.

property ERROR

property OK

echo(message=None, **kwargs)

error(message=None, **kwargs)

pretty(n)

pretty_dict_ok_error(n)

pretty_list(n)

say_chat(direction, title, body='', show_body=False)

secho(message=None, **kwargs)

style(message=None, **kwargs)

class celery.bin.base.CeleryCommand(name: str | None, context_settings: MutableMapping[str, Any] | None = None, callback: Callable[[...], Any] | None = None, params: list[Parameter] | None = None, help: str | None = None, epilog: str | None = None, short_help: str | None = None, options_metavar: str | None = '[OPTIONS]', add_help_option: bool = True, no_args_is_help: bool = False, hidden: bool = False, deprecated: bool | str = False)

Customized command for Celery.

format_options(ctx, formatter)

Write all the options into the formatter if they exist.

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

Daemon commands.

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

Customized option for Celery.

get_default(ctx, *args, **kwargs)

Return the default value for this option.

For non-boolean flag options, default=True is treated as a sentinel meaning “activate this flag by default” and is resolved to flag_value. For example, with --upper/--lower feature switches where flag_value="upper" and default=True, the default resolves to "upper".

Caution

This substitution only applies to non-boolean flags (is_bool_flag is False). For boolean flags, True is a legitimate Python value and default=True is returned as-is.

Changed in version 8.3.3: default=True is no longer substituted with flag_value for boolean flags, fixing negative boolean flags like flag_value=False, default=True.

class celery.bin.base.CommaSeparatedList

Comma separated list argument.

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'comma separated list'

the descriptive name of this type

class celery.bin.base.DaemonOption(*args, **kwargs)

Common daemonization option

daemon_setting(ctx: Context, opt: CeleryOption, value: Any) → Any

Try to fetch daemonization option from applications settings. Use the daemon command name as prefix (eg. worker -> worker_pidfile)

class celery.bin.base.ISO8601DateTime

ISO 8601 Date Time argument.

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'iso-86091'

the descriptive name of this type

class celery.bin.base.ISO8601DateTimeOrFloat

ISO 8601 Date Time or float argument.

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'iso-86091 or float'

the descriptive name of this type

class celery.bin.base.JsonArray

JSON formatted array argument.

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'json array'

the descriptive name of this type

class celery.bin.base.JsonObject

JSON formatted object argument.

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'json object'

the descriptive name of this type

class celery.bin.base.LogLevel

Log level option.

convert(value, param, ctx)

For a given value from the parser, normalize it and find its matching normalized value in the list of choices. Then return the matched “original” choice.

celery.bin.base.handle_preload_options(f)

Extract preload options and return a wrapped callable.

celery.bin.base.handle_remote_command_error(command: str, exc: Exception) → None