This document is for py-amqp's development version, which can be significantly different from previous releases. Get the stable docs here: 5.3.
amqp - Python AMQP low-level client library¶
- Version:
5.3.1
- Web:
- Download:
- Source:
- Keywords:
amqp, rabbitmq
About¶
This is a fork of amqplib which was originally written by Barry Pederson. It is maintained by the Celery project, and used by kombu as a pure python alternative when librabbitmq is not available.
This library should be API compatible with librabbitmq.
Differences from amqplib¶
Supports draining events from multiple channels (
Connection.drain_events
)Support for timeouts
Channels are restored after channel error, instead of having to close the connection.
Support for heartbeats
Connection.heartbeat_tick(rate=2)
must called at regular intervals (half of the heartbeat value if rate is 2).Or some other scheme by using
Connection.send_heartbeat
.
- Supports RabbitMQ extensions:
- Consumer Cancel Notifications
by default a cancel results in
ChannelError
being raisedbut not if a
on_cancel
callback is passed tobasic_consume
.
- Publisher confirms
Channel.confirm_select()
enables publisher confirms.Channel.events['basic_ack'].append(my_callback)
adds a callback to be called when a message is confirmed. This callback is then called with the signature(delivery_tag, multiple)
.
- Exchange-to-exchange bindings:
exchange_bind
/exchange_unbind
. Channel.confirm_select()
enables publisher confirms.Channel.events['basic_ack'].append(my_callback)
adds a callback to be called when a message is confirmed. This callback is then called with the signature(delivery_tag, multiple)
.
- Exchange-to-exchange bindings:
Support for
basic_return
- Uses AMQP 0-9-1 instead of 0-8.
Channel.access_request
andticket
arguments to methods removed.Supports the
arguments
argument tobasic_consume
.internal
argument toexchange_declare
removed.auto_delete
argument toexchange_declare
deprecatedinsist
argument toConnection
removed.Channel.alerts
has been removed.Support for
Channel.basic_recover_async
.Channel.basic_recover
deprecated.
- Exceptions renamed to have idiomatic names:
AMQPException
->AMQPError
AMQPConnectionException
-> ConnectionError``AMQPChannelException
-> ChannelError``Connection.known_hosts
removed.Connection
no longer supports redirects.exchange
argument toqueue_bind
can now be empty to use the “default exchange”.
Adds
Connection.is_alive
that tries to detect whether the connection can still be used.Adds
Connection.connection_errors
and.channel_errors
, a list of recoverable errors.Exposes the underlying socket as
Connection.sock
.Adds
Channel.no_ack_consumers
to keep track of consumer tags that set the no_ack flag.Slightly better at error recovery
Further¶
Differences between AMQP 0.8 and 0.9.1
AMQP 0.9.1 Quick Reference
RabbitMQ Extensions
For more information about AMQP, visit
For other Python client libraries see:
Contents¶
- API Reference
- Changes
- 5.3.1
- 5.3.0
- 5.2.0
- 5.1.1
- 5.1.0
- 5.0.9
- 5.0.8
- 5.0.7
- 5.0.6
- 5.0.5
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 5.0.0b1
- 5.0.0a1
- 2.6.1
- 2.6.0
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.4
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.4.9
- 1.4.8
- 1.4.7
- 1.4.6
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.13
- 1.0.12
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- Version 0.9.4
- Version 0.9.3
- Version 0.9.2
- Version 0.9.1