This document describes Celery 2.5. For development docs,
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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>)
-
out(s, fh=<open file '<stdout>', mode 'w' at 0x557d9078>)
-
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.3'
-
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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>, <Option at 0xbceef8c: -a/--args>, <Option at 0xbceea8c: -k/--kwargs>, <Option at 0xbf3ef4c: --eta>, <Option at 0xbe11bec: --countdown>, <Option at 0xbe11b8c: --expires>, <Option at 0xbe11c2c: --serializer>, <Option at 0xbe11ecc: --queue>, <Option at 0xbe11fac: --exchange>, <Option at 0xbe112cc: --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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>, <Option at 0xbe1128c: -t/--timeout>, <Option at 0xbe1112c: -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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>, <Option at 0xbe11f4c: -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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>, <Option at 0xbe1150c: -I/--ipython>, <Option at 0xbe1168c: -B/--bpython>, <Option at 0xbe117cc: -P/--python>, <Option at 0xbe1166c: -T/--without-tasks>, <Option at 0xbe118ac: --eventlet>, <Option at 0xbe11f2c: --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 0xbc980ec: --app>, <Option at 0xbc98b4c: -b/--broker>, <Option at 0xbc98ecc: --loader>, <Option at 0xbc9858c: --config>, <Option at 0xbcee0cc: -q/--quiet>, <Option at 0xbceedac: -C/--no-color>, <Option at 0xbe1128c: -t/--timeout>, <Option at 0xbe1112c: -d/--destination>)
-
run(*args, **kwargs)