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

celery.bin.amqp

The celery amqp command.

class celery.bin.amqp.AMQPAdmin(*args, **kwargs)

The celery celery amqp utility.

Shell

alias of AMQShell

connect(conn=None)

note(m)

run()

class celery.bin.amqp.AMQShell(*args, **kwargs)

AMQP API Shell.

Parameters:

• connect – Function used to connect to the server, must return connection object.
• silent – If True, the commands won’t have annoying output not relevant when running in non-shell mode.

amqp

Mapping of AMQP API commands and their Spec.

amqp = {u'queue.declare': <celery.bin.amqp.Spec object at 0x7feb214b7210>, u'queue.purge': <celery.bin.amqp.Spec object at 0x7feb214b7fd0>, u'exchange.delete': <celery.bin.amqp.Spec object at 0x7feb214b7a50>, u'basic.publish': <celery.bin.amqp.Spec object at 0x7feb214b7ed0>, u'basic.ack': <celery.bin.amqp.Spec object at 0x7feb214b7390>, u'exchange.declare': <celery.bin.amqp.Spec object at 0x7feb214b71d0>, u'queue.delete': <celery.bin.amqp.Spec object at 0x7feb214b7dd0>, u'queue.bind': <celery.bin.amqp.Spec object at 0x7feb214b7110>, u'basic.get': <celery.bin.amqp.Spec object at 0x7feb214b73d0>}

builtins = {u'exit': u'do_exit', u'EOF': u'do_exit', u'help': u'do_help'}

chan = None

completenames(text, *ignored)

Return all commands starting with text, for tab-completion.

conn = None

counter = 1

default(line)

dispatch(cmd, argline)

Dispatch and execute the command.

Lookup order is: builtins -> amqp.

display_command_help(cmd, short=False)

do_exit(*args)

The ‘exit’ command.

do_help(*args)

get_amqp_api_command(cmd, arglist)

With a command name and a list of arguments, convert the arguments to Python values and find the corresponding method on the AMQP channel object.

Returns:tuple of (method, processed_args).

get_names()

identchars = u'.'

inc_counter = count(2)

needs_reconnect = False

note(m)

Say something to the user. Disabled if silent.

onecmd(line)

Parse line and execute command.

parseline(line)

Parse input line.

Returns:tuple of three items: (command_name, arglist, original_line)

prompt

prompt_fmt = u'{self.counter}> '

respond(retval)

What to do with the return value of a command.

say(m)

class celery.bin.amqp.Spec(*args, **kwargs)

AMQP Command specification.

Used to convert arguments to Python values and display various help and tooltips.

Parameters:

• args – see args.
• returns – see returns.

coerce(index, value)

Coerce value for argument at index.

format_arg(name, type, default_value=None)

format_response(response)

Format the return value of this command in a human-friendly way.

format_signature()

str_args_to_python(arglist)

Process list of string arguments to values according to spec.

e.g:

>>> spec = Spec([('queue', str), ('if_unused', bool)])
>>> spec.str_args_to_python('pobox', 'true')
('pobox', True)

class celery.bin.amqp.amqp(app=None, get_app=None, no_color=False, stdout=None, stderr=None, quiet=False, on_error=None, on_usage_error=None)

AMQP Administration Shell.

Also works for non-amqp transports (but not ones that store declarations in memory).

Examples:

celery amqp
    start shell mode
celery amqp help
    show list of commands

celery amqp exchange.delete name
celery amqp queue.delete queue
celery amqp queue.delete queue yes yes

run(*args, **options)