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)

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: Optional[str], context_settings: Optional[Dict[str, Any]] = None, callback: Optional[Callable[[...], Any]] = None, params: Optional[List[Parameter]] = None, help: Optional[str] = None, epilog: Optional[str] = None, short_help: Optional[str] = None, options_metavar: Optional[str] = '[OPTIONS]', add_help_option: bool = True, no_args_is_help: bool = False, hidden: bool = False, deprecated: bool = 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)

Get the default for the parameter. Tries Context.lookup_default() first, then the local default.

Parameters:

• ctx – Current context.

• call – If the default is a callable, call it. Disable to return the callable instead.

Changed in version 8.0.2: Type casting is no longer performed when getting a default.

Changed in version 8.0.1: Type casting can fail in resilient parsing mode. Invalid defaults will not prevent showing help text.

Changed in version 8.0: Looks at ctx.default_map first.

Changed in version 8.0: Added the call parameter.

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.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)

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.

celery.bin.base.handle_preload_options(f)

Extract preload options and return a wrapped callable.