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

celery.bin.base

Preload Options

These options are supported by all commands, and usually parsed before command-specific arguments.

-A, --app

app instance to use (e.g. module.attr_name)

-b, --broker

url to broker. default is ‘amqp://guest@localhost//’

--loader

name of custom loader class to use.

--config

Name of the configuration module

Daemon Options

These options are supported by commands that can detach into the background (daemon). They will be present in any command that also has a –detach option.

-f, --logfile

Path to log file. If no logfile is specified, stderr is used.

--pidfile

Optional file used to store the process pid.

The program will not start if this file already exists and the pid is still alive.

--uid

User id, or user name of the user to run as after detaching.

--gid

Group id, or group name of the main group to change to after detaching.

--umask

Effective umask of the process after detaching. Default is 0.

--workdir

Optional directory to change to after detaching.

exception celery.bin.base.Error(reason, status=None)[source]
status = 1
exception celery.bin.base.UsageError(reason, status=None)[source]
status = 64
class celery.bin.base.Extensions(namespace, register)[source]
add(cls, name)[source]
load()[source]
class celery.bin.base.HelpFormatter(indent_increment=2, max_help_position=24, width=None, short_first=1)[source]
format_description(description)[source]
format_epilog(epilog)[source]
class celery.bin.base.Command(app=None, get_app=None, no_color=False, stdout=None, stderr=None, quiet=False, on_error=None, on_usage_error=None)[source]

Base class for command-line applications.

Parameters:
  • app – The current app.
  • get_app – Callable returning the current app if no app provided.
exception Error(reason, status=None)
status = 1
Command.Parser

alias of OptionParser

exception Command.UsageError(reason, status=None)
status = 64
Command.args = u''
Command.ask(q, choices, default=None)[source]

Prompt user to choose from a tuple of string values.

Parameters:
  • q – the question to ask (do not include questionark)
  • choice – tuple of possible choices, must be lowercase.
  • default – Default value if any.

If a default is not specified the question will be repeated until the user gives a valid choice.

Matching is done case insensitively.

Command.check_args(args)[source]
Command.colored[source]
Command.create_parser(prog_name, command=None)[source]
Command.description = u''
Command.die(msg, status=1)[source]
Command.doc = None
Command.early_version(argv)[source]
Command.enable_config_from_cmdline = False
Command.epilog = None
Command.error(s)[source]
Command.execute_from_commandline(argv=None)[source]

Execute application from command-line.

Parameters:argv – The list of command-line arguments. Defaults to sys.argv.
Command.expanduser(value)[source]
Command.find_app(app)[source]
Command.get_cls_by_name(name, imp=<function import_from_cwd at 0xf6677d4c>)
Command.get_options()[source]

Get supported command-line options.

Command.handle_argv(prog_name, argv, command=None)[source]

Parse command-line arguments from argv and dispatch to run().

Parameters:
  • prog_name – The program name (argv[0]).
  • argv – Command arguments.

Exits with an error message if supports_args is disabled and argv contains positional arguments.

Command.host_format(s, **extra)[source]
Command.leaf = True
Command.maybe_patch_concurrency(argv=None)[source]
Command.namespace = u'celery'
Command.no_color[source]
Command.node_format(s, nodename, **extra)[source]
Command.on_concurrency_setup()[source]
Command.on_error(exc)[source]
Command.on_usage_error(exc)[source]
Command.option_list = ()
Command.out(s, fh=None)[source]
Command.parse_doc(doc)[source]
Command.parse_options(prog_name, arguments, command=None)[source]

Parse the available options.

Command.parse_preload_options(args)[source]
Command.preload_options = (<Option at 0xf481432c: -A/--app>, <Option at 0xf50333ac: -b/--broker>, <Option at 0xf462352c: --loader>, <Option at 0xf4623dcc: --config>, <Option at 0xf462366c: --workdir>, <Option at 0xf462378c: -C/--no-color>, <Option at 0xf4f2c9cc: -q/--quiet>)
Command.prepare_args(options, args)[source]
Command.prepare_parser(parser)[source]
Command.preparse_options(args, options)[source]
Command.pretty(n)[source]
Command.pretty_dict_ok_error(n)[source]
Command.pretty_list(n)[source]
Command.process_cmdline_config(argv)[source]
Command.prog_name = u'celery'
Command.respects_app_option = True
Command.run(*args, **options)[source]

This is the body of the command called by handle_argv().

Command.run_from_argv(prog_name, argv=None, command=None)[source]
Command.say_chat(direction, title, body=u'')[source]
Command.say_remote_command_reply(replies)[source]
Command.setup_app_from_commandline(argv)[source]
Command.show_body = True
Command.show_reply = True
Command.supports_args = True
Command.symbol_by_name(name, imp=<function import_from_cwd at 0xf6677d4c>)[source]
Command.usage(command)[source]
Command.verify_args(given, _index=0)[source]
Command.version = '3.1.12 (Cipater)'
Command.with_pool_option(argv)[source]

Return tuple of (short_opts, long_opts) if the command supports a pool argument, and used to monkey patch eventlet/gevent environments as early as possible.

E.g::
has_pool_option = ([‘-P’], [‘–pool’])
class celery.bin.base.Option(*opts, **attrs)
Instance attributes:

_short_opts : [string] _long_opts : [string]

action : string type : string dest : string default : any nargs : int const : any choices : [string] callback : function callback_args : (any*) callback_kwargs : { string : any } help : string metavar : string

ACTIONS = ('store', 'store_const', 'store_true', 'store_false', 'append', 'append_const', 'count', 'callback', 'help', 'version')
ALWAYS_TYPED_ACTIONS = ('store', 'append')
ATTRS = ['action', 'type', 'dest', 'default', 'nargs', 'const', 'choices', 'callback', 'callback_args', 'callback_kwargs', 'help', 'metavar']
CHECK_METHODS = [<function _check_action at 0xf6fb2d84>, <function _check_type at 0xf6fb2dbc>, <function _check_choice at 0xf6fb2df4>, <function _check_dest at 0xf6fb2e2c>, <function _check_const at 0xf6fb2e64>, <function _check_nargs at 0xf6fb2e9c>, <function _check_callback at 0xf6fb2ed4>]
CONST_ACTIONS = ('store_const', 'append_const')
STORE_ACTIONS = ('store', 'store_const', 'store_true', 'store_false', 'append', 'append_const', 'count')
TYPED_ACTIONS = ('store', 'append', 'callback')
TYPES = ('string', 'int', 'long', 'float', 'complex', 'choice')
TYPE_CHECKER = {'int': <function check_builtin at 0xf6fb2bfc>, 'float': <function check_builtin at 0xf6fb2bfc>, 'complex': <function check_builtin at 0xf6fb2bfc>, 'long': <function check_builtin at 0xf6fb2bfc>, 'choice': <function check_choice at 0xf6fb2c34>}
check_value(opt, value)
convert_value(opt, value)
get_opt_string()
process(opt, value, values, parser)
take_action(action, dest, opt, value, values, parser)
takes_value()
celery.bin.base.daemon_options(default_pidfile=None, default_logfile=None)[source]

Previous topic

celery.worker.strategy

Next topic

celery.bin.celery

This Page