|build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
:Version: 5.2.0 :Web: https://amqp.readthedocs.io/ :Download: https://pypi.org/project/amqp/ :Source: http://github.com/celery/py-amqp/ :Keywords: amqp, rabbitmq
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
_.
.. _amqplib: https://pypi.org/project/amqplib/ .. _Celery: http://celeryproject.org/ .. _kombu: https://kombu.readthedocs.io/ .. _librabbitmq: https://pypi.org/project/librabbitmq/
amqplib
_Connection.drain_events
)Support for heartbeats
Connection.heartbeat_tick(rate=2)
must called at regular intervals
(half of the heartbeat value if rate is 2).Connection.send_heartbeat
.ChannelError
being raisedon_cancel
callback is passed to basic_consume
.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_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)
.AccessRefused
error
when connected to rabbitmq-server 3.2.0 or greater.basic_return
Channel.access_request
and ticket
arguments to methods
removed.arguments
argument to basic_consume
.internal
argument to exchange_declare
removed.auto_delete
argument to exchange_declare
deprecatedinsist
argument to Connection
removed.Channel.alerts
has been removed.Channel.basic_recover_async
.Channel.basic_recover
deprecated.AMQPException
-> AMQPError
AMQPConnectionException
-> ConnectionError``AMQPChannelException
-> ChannelError``Connection.known_hosts
removed.Connection
no longer supports redirects.exchange
argument to queue_bind
can now be empty
to use the "default exchange".Connection.is_alive
that tries to detect
whether the connection can still be used.Connection.connection_errors
and .channel_errors
,
a list of recoverable errors.Connection.sock
.Channel.no_ack_consumers
to keep track of consumer tags
that set the no_ack flag.Simple producer publishing messages to test
queue using default exchange:
.. code:: python
import amqp
with amqp.Connection('broker.example.com') as c:
ch = c.channel()
ch.basic_publish(amqp.Message('Hello World'), routing_key='test')
Producer publishing to test_exchange
exchange with publisher confirms enabled and using virtual_host test_vhost
:
.. code:: python
import amqp
with amqp.Connection(
'broker.example.com', exchange='test_exchange',
confirm_publish=True, virtual_host='test_vhost'
) as c:
ch = c.channel()
ch.basic_publish(amqp.Message('Hello World'), routing_key='test')
Consumer with acknowledgments enabled:
.. code:: python
import amqp
with amqp.Connection('broker.example.com') as c:
ch = c.channel()
def on_message(message):
print('Received message (delivery tag: {}): {}'.format(message.delivery_tag, message.body))
ch.basic_ack(message.delivery_tag)
ch.basic_consume(queue='test', callback=on_message)
while True:
c.drain_events()
Consumer with acknowledgments disabled:
.. code:: python
import amqp
with amqp.Connection('broker.example.com') as c:
ch = c.channel()
def on_message(message):
print('Received message (delivery tag: {}): {}'.format(message.delivery_tag, message.body))
ch.basic_consume(queue='test', callback=on_message, no_ack=True)
while True:
c.drain_events()
This library has experimental support of speedups. Speedups are implemented using Cython. To enable speedups, CELERY_ENABLE_SPEEDUPS
environment variable must be set during building/installation.
Currently speedups can be installed:
--no-binary
switch):.. code:: shell
CELERY_ENABLE_SPEEDUPS=true pip install --no-binary :all: amqp
.. code:: shell
CELERY_ENABLE_SPEEDUPS=true python setup.py install
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:
.. |build-status| image:: https://github.com/celery/py-amqp/actions/workflows/ci.yaml/badge.svg :alt: Build status :target: https://github.com/celery/py-amqp/actions/workflows/ci.yaml
.. |coverage| image:: https://codecov.io/github/celery/py-amqp/coverage.svg?branch=main :target: https://codecov.io/github/celery/py-amqp?branch=main
.. |license| image:: https://img.shields.io/pypi/l/amqp.svg :alt: BSD License :target: https://opensource.org/licenses/BSD-3-Clause
.. |wheel| image:: https://img.shields.io/pypi/wheel/amqp.svg :alt: Python AMQP can be installed via wheel :target: https://pypi.org/project/amqp/
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/amqp.svg :alt: Supported Python versions. :target: https://pypi.org/project/amqp/
.. |pyimp| image:: https://img.shields.io/pypi/implementation/amqp.svg :alt: Support Python implementations. :target: https://pypi.org/project/amqp/
The maintainers of py-amqp and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.