This document describes an older version of Celery (2.5). For the latest stable version please go here.

celeryctl - celery.bin.celeryctl

class celery.bin.celeryctl.Command(app=None, no_color=False)

args = ''

create_parser(prog_name, command)

error(s)

help = ''

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>)

out(s, fh=<open file '<stdout>', mode 'w' at 0x7f636d1a1150>)

prettify(n)

prettify_dict_ok_error(n)

prettify_list(n)

run(*args, **kwargs)

run_from_argv(prog_name, argv)

show_help(command)

usage(command)

version = '2.5.5'

exception celery.bin.celeryctl.Error(reason, status=1)

class celery.bin.celeryctl.apply(app=None, no_color=False)

args = '<task_name>'

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>, <Option at 0x53c63b0: -a/--args>, <Option at 0x53c6b48: -k/--kwargs>, <Option at 0x53c6d40: --eta>, <Option at 0x7256e60: --countdown>, <Option at 0x7256518: --expires>, <Option at 0x5ba5dd0: --serializer>, <Option at 0x5bad7a0: --queue>, <Option at 0x70cbb90: --exchange>, <Option at 0x70cbd88: --routing-key>)

run(name, *_, **kw)

class celery.bin.celeryctl.celeryctl(app=None, get_app=None)

commands = {'status': <class 'celery.bin.celeryctl.status'>, 'shell': <class 'celery.bin.celeryctl.shell'>, 'help': <class 'celery.bin.celeryctl.help'>, 'migrate': <class 'celery.bin.celeryctl.migrate'>, 'inspect': <class 'celery.bin.celeryctl.inspect'>, 'list': <class 'celery.bin.celeryctl.list_'>, 'purge': <class 'celery.bin.celeryctl.purge'>, 'result': <class 'celery.bin.celeryctl.result'>, 'apply': <class 'celery.bin.celeryctl.apply'>}

enable_config_from_cmdline = True

execute(command, argv=None)

handle_argv(prog_name, argv)

remove_options_at_beginning(argv, index=0)

celery.bin.celeryctl.command(fun, name=None)

celery.bin.celeryctl.determine_exit_status(ret)

class celery.bin.celeryctl.help(app=None, no_color=False)

run(*args, **kwargs)

usage(command)

celery.bin.celeryctl.indent(s, n=4)

class celery.bin.celeryctl.inspect(app=None, no_color=False)

choices = {'scheduled': 1.0, 'reserved': 1.0, 'registered': 1.0, 'active': 1.0, 'cancel_consumer': 1.0, 'active_queues': 1.0, 'add_consumer': 1.0, 'stats': 1.0, 'revoked': 1.0, 'enable_events': 1.0, 'ping': 0.2, 'disable_events': 1.0, 'registered_tasks': 1.0}

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>, <Option at 0x70cbab8: -t/--timeout>, <Option at 0x708bea8: -d/--destination>)

run(*args, **kwargs)

say(direction, title, body='')

show_body = True

usage(command)

class celery.bin.celeryctl.list_(app=None, no_color=False)

args = '<bindings>'

list_bindings(channel)

run(what=None, *_, **kw)

celery.bin.celeryctl.main()

class celery.bin.celeryctl.migrate(app=None, no_color=False)

on_migrate_task(state, body, message)

run(*args, **kwargs)

usage(command)

class celery.bin.celeryctl.purge(app=None, no_color=False)

run(*args, **kwargs)

class celery.bin.celeryctl.result(app=None, no_color=False)

args = '<task_id>'

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>, <Option at 0x70cbb00: -t/--task>)

run(task_id, *args, **kwargs)

class celery.bin.celeryctl.shell(app=None, no_color=False)

invoke_bpython_shell()

invoke_default_shell()

invoke_fallback_shell()

invoke_ipython_shell()

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>, <Option at 0x708bf38: -I/--ipython>, <Option at 0x722a5f0: -B/--bpython>, <Option at 0x722a2d8: -P/--python>, <Option at 0x722a368: -T/--without-tasks>, <Option at 0x722a290: --eventlet>, <Option at 0x7228e60: --gevent>)

run(force_ipython=False, force_bpython=False, force_python=False, without_tasks=False, eventlet=False, gevent=False, **kwargs)

class celery.bin.celeryctl.status(app=None, no_color=False)

option_list = (<Option at 0x73feb90: --app>, <Option at 0x73fe998: -b/--broker>, <Option at 0x73fea28: --loader>, <Option at 0x73fefc8: --config>, <Option at 0x705e050: -q/--quiet>, <Option at 0x7255098: -C/--no-color>, <Option at 0x70cbab8: -t/--timeout>, <Option at 0x708bea8: -d/--destination>)

run(*args, **kwargs)