This document describes the current stable version of py-amqp (2.0). For development docs, go here.

Changes

py-amqp is fork of amqplib used by Kombu containing additional features and improvements. The previous amqplib changelog is here: http://code.google.com/p/py-amqplib/source/browse/CHANGES

2.0.2

release-date:2016-06-10 5:40 PM PDT
release-by:Ask Solem
  • Python 3: Installation requirements ended up being a generator and crashed setup.py.

    Fix contributed by ChangBo Guo(gcb).

  • Python <= 2.7.7: struct.pack arguments cannot be unicode

    Fix contributed by Alan Justino and Xin Li.

  • Python 3.4: Fixed use of bytes % int.

    Fix contributed by Alan Justino.

  • Connection/Transport: Fixed handling of default port.

    Fix contributed by Quentin Pradet.

2.0.1

release-date:2016-05-31 6:20 PM PDT
release-by:Ask Solem
  • Adds backward compatibility layer for the 1.4 API.

    Using the connection without calling .connect() first will now work, but a warning is emitted and the behavior is deprecated and will be removed in version 2.2.

  • Fixes kombu 3.0/celery 3.1 compatibility (Issue #88).

    Fix contributed by Bas ten Berge.

  • Fixed compatibility with Python 2.7.3 (Issue #85)

    Fix contributed by Bas ten Berge.

  • Fixed bug where calling drain_events() with a timeout of 0 would actually block until a frame is received.

  • Documentation moved to http://amqp.readthedocs.io (Issue #89).

    See https://blog.readthedocs.com/securing-subdomains/ for the reasoning behind this change.

    Fix contributed by Adam Chainz.

2.0.0

release-date:2016-05-26 1:44 PM PDT
release-by:Ask Solem
  • No longer supports Python 2.6

  • You must now call Connection.connect() to establish the connection.

    The Connection constructor no longer has side effects, so you have to explicitly call connect first.

  • Library rewritten to anticipate async changes.

  • Connection now exposes underlying socket options.

    This change allows to set arbitrary TCP socket options during the creation of the transport.

    Those values can be set passing a dictionray where the key is the name of the parameter we want to set. The names of the keys are the ones reported above.

    Contributed by Andrea Rosa, Dallas Marlow and Rongze Zhu.

  • Additional logging for heartbeats.

    Contributed by Davanum Srinivas, and Dmitry Mescheryakov.

  • SSL: Fixes issue with remote connection hanging

    Fix contributed by Adrien Guinet.

  • SSL: ssl dict argument now supports the check_hostname key

    (Issue #63).

    Contributed by Vic Kumar.

  • Contributions by:

    Adrien Guinet Andrea Rosa Artyom Koval Corey Farwell Craig Jellick Dallas Marlow Davanum Srinivas Federico Ficarelli Jared Lewis Rémy Greinhofer Rongze Zhu Yury Selivanov Vic Kumar Vladimir Bolshakov @lezeroq

1.4.9

release-date:2016-01-08 5:50 PM PST
release-by:Ask Solem
  • Fixes compatibility with Linux/OS X instances where the ctypes module does not exist.

    Fix contributed by Jared Lewis.

1.4.8

release-date:2015-12-07 12:25 AM
release-by:Ask Solem
  • abstract_channel.wait now accepts a float timeout parameter expressed

    in seconds

    Contributed by Goir.

1.4.7

release-date:2015-10-02 05:30 P.M PDT
release-by:Ask Solem
  • Fixed libSystem error on OS X 10.11 (El Capitan)

    Fix contributed by Eric Wang.

  • channel.basic_publish now raises amqp.exceptions.NotConfirmed on

    basic.nack.

  • AMQP timestamps received are now converted from GMT instead of local time

    (Issue #67).

  • Wheel package installation now supported by both Python 2 and Python3.

    Fix contributed by Rémy Greinhofer.

1.4.6

release-date:2014-08-11 06:00 P.M UTC
release-by:Ask Solem
  • Now keeps buffer when socket times out.

    Fix contributed by Artyom Koval.

  • Adds Connection.Transport attribute that can be used to specify a different transport implementation.

    Contributed by Yury Selivanov.

1.4.5

release-date:2014-04-15 09:00 P.M UTC
release-by:Ask Solem
  • Can now deserialize more AMQP types.

    Now handles types short string, short short int, short short unsigned int, short int, short unsigned int, long unsigned int, long long int, long long unsigned int and float which for some reason was missing, even in the original amqplib module.

  • SSL: Workaround for Python SSL bug.

    A bug in the python socket library causes ssl.read/write() on a closed socket to raise AttributeError instead of IOError.

    Fix contributed by Craig Jellick.

  • Transport.__del_ now handles errors occurring at late interpreter shutdown (Issue #36).

1.4.4

release-date:2014-03-03 04:00 P.M UTC
release-by:Ask Solem
  • SSL transport accidentally disconnected after read timeout.

    Fix contributed by Craig Jellick.

1.4.3

release-date:2014-02-09 03:00 P.M UTC
release-by:Ask Solem
  • Fixed bug where more data was requested from the socket than was actually needed.

    Contributed by Ionel Cristian Mărieș.

1.4.2

release-date:2014-01-23 05:00 P.M UTC
  • Heartbeat negotiation would use heartbeat value from server even if heartbeat disabled (Issue #31).

1.4.1

release-date:2014-01-14 09:30 P.M UTC
release-by:Ask Solem
  • Fixed error occurring when heartbeats disabled.

1.4.0

release-date:2014-01-13 03:00 P.M UTC
release-by:Ask Solem
  • Heartbeat implementation improved (Issue #6).

    The new heartbeat behavior is the same approach as taken by the RabbitMQ java library.

    This also means that clients should preferably call the heartbeat_tick method more frequently (like every second) instead of using the old rate argument (which is now ignored).

    • Heartbeat interval is negotiated with the server.
    • Some delay is allowed if the heartbeat is late.
    • Monotonic time is used to keep track of the heartbeat instead of relying on the caller to call the checking function at the right time.

    Contributed by Dustin J. Mitchell.

  • NoneType is now supported in tables and arrays.

    Contributed by Dominik Fässler.

  • SSLTransport: Now handles ENOENT.

    Fix contributed by Adrien Guinet.

1.3.3

release-date:2013-11-11 03:30 P.M UTC
release-by:Ask Solem
  • SSLTransport: Now keeps read buffer if an exception is raised (Issue #26).

    Fix contributed by Tommie Gannert.

1.3.2

release-date:2013-10-29 02:00 P.M UTC
release-by:Ask Solem
  • Message.channel is now a channel object (not the channel id).
  • Bug in previous version caused the socket to be flagged as disconnected at EAGAIN/EINTR.

1.3.1

release-date:2013-10-24 04:00 P.M UTC
release-by:Ask Solem
  • Now implements Connection.connected (Issue #22).
  • Fixed bug where str(AMQPError) did not return string.

1.3.0

release-date:2013-09-04 02:39 P.M UTC
release-by:Ask Solem
  • Now sets Message.channel on delivery (Issue #12)

    amqplib used to make the channel object available as Message.delivery_info['channel'], but this was removed in py-amqp. librabbitmq sets Message.channel, which is a more reasonable solution in our opinion as that keeps the delivery info intact.

  • New option to wait for publish confirmations (Issue #3)

    There is now a new Connection confirm_publish that will force any basic_publish call to wait for confirmation.

    Enabling publisher confirms like this degrades performance considerably, but can be suitable for some applications and now it’s possible by configuration.

  • queue_declare now returns named tuple of type basic_declare_ok_t.

    Supporting fields: queue, message_count, and consumer_count.

  • Contents of Channel.returned_messages is now named tuples.

    Supporting fields: reply_code, reply_text, exchange, routing_key, and message.

  • Sockets now set to close on exec using the FD_CLOEXEC flag.

    Currently only supported on platforms supporting this flag, which does not include Windows.

    Contributed by Tommie Gannert.

1.2.1

release-date:2013-08-16 05:30 P.M UTC
release-by:Ask Solem
  • Adds promise type: amqp.utils.promise()
  • Merges fixes from 1.0.x

1.2.0

release-date:2012-11-12 04:00 P.M UTC
release-by:Ask Solem
  • New exception hierarchy:

    • AMQPError
      • ConnectionError
        • RecoverableConnectionError
          • ConsumerCancelled
          • ConnectionForced
          • ResourceError
        • IrrecoverableConnectionError
          • ChannelNotOpen
          • FrameError
          • FrameSyntaxError
          • InvalidCommand
          • InvalidPath
          • NotAllowed
          • UnexpectedFrame
          • AMQPNotImplementedError
          • InternalError
      • ChannelError
        • RecoverableChannelError
          • ContentTooLarge
          • NoConsumers
          • ResourceLocked
        • IrrecoverableChannelError
          • AccessRefused
          • NotFound
          • PreconditionFailed

1.1.0

release-date:2013-11-08 10:36 P.M UTC
release-by:Ask Solem
  • No longer supports Python 2.5
  • Fixed receiving of float table values.
  • Now Supports Python 3 and Python 2.6+ in the same source code.
  • Python 3 related fixes.

1.0.13

release-date:2013-07-31 04:00 P.M BST
release-by:Ask Solem
  • Fixed problems with the SSL transport (Issue #15).

    Fix contributed by Adrien Guinet.

  • Small optimizations

1.0.12

release-date:2013-06-25 02:00 P.M BST
release-by:Ask Solem
  • Fixed another Python 3 compatibility problem.

1.0.11

release-date:2013-04-11 06:00 P.M BST
release-by:Ask Solem
  • Fixed Python 3 incompatibility in amqp/transport.py.

1.0.10

release-date:2013-03-21 03:30 P.M UTC
release-by:Ask Solem
  • Fixed Python 3 incompatibility in amqp/serialization.py. (Issue #11).

1.0.9

release-date:2013-03-08 10:40 A.M UTC
release-by:Ask Solem
  • Publisher ack callbacks should now work after typo fix (Issue #9).
  • channel(explicit_id) will now claim that id from the array of unused channel ids.
  • Fixes Jython compatibility.

1.0.8

release-date:2013-02-08 01:00 P.M UTC
release-by:Ask Solem
  • Fixed SyntaxError on Python 2.5

1.0.7

release-date:2013-02-08 01:00 P.M UTC
release-by:Ask Solem
  • Workaround for bug on some Python 2.5 installations where (2**32) is 0.

  • Can now serialize the ARRAY type.

    Contributed by Adam Wentz.

  • Fixed tuple format bug in exception (Issue #4).

1.0.6

release-date:2012-11-29 01:14 P.M UTC
release-by:Ask Solem
  • Channel.close is now ignored if the connection attribute is None.

1.0.5

release-date:2012-11-21 04:00 P.M UTC
release-by:Ask Solem
  • Channel.basic_cancel is now ignored if the channel was already closed.

  • Channel.events is now a dict of sets:

    >>> channel.events['basic_return'].add(on_basic_return)
    >>> channel.events['basic_return'].discard(on_basic_return)
    

1.0.4

release-date:2012-11-13 04:00 P.M UTC
release-by:Ask Solem
  • Fixes Python 2.5 support

1.0.3

release-date:2012-11-12 04:00 P.M UTC
release-by:Ask Solem
  • Now can also handle float in headers/tables when receiving messages.
  • Now uses array.array to keep track of unused channel ids.
  • The METHOD_NAME_MAP has been updated for amqp/0.9.1 and Rabbit extensions.
  • Removed a bunch of accidentally included images.

1.0.2

release-date:2012-11-06 05:00 P.M UTC
release-by:Ask Solem
  • Now supports float values in headers/tables.

1.0.1

release-date:2012-11-05 01:00 P.M UTC
release-by:Ask Solem
  • Connection errors no longer includes AttributeError.

  • Fixed problem with using the SSL transport in a non-blocking context.

    Fix contributed by Mher Movsisyan.

1.0.0

release-date:2012-11-05 01:00 P.M UTC
release-by:Ask Solem
  • Channels are now restored on channel error, so that the connection does not have to closed.

Version 0.9.4

  • Adds support for exchange_bind and exchange_unbind.

    Contributed by Rumyana Neykova

  • Fixed bugs in funtests and demo scripts.

    Contributed by Rumyana Neykova

Version 0.9.3

  • Fixed bug that could cause the consumer to crash when reading large message payloads asynchronously.
  • Serialization error messages now include the invalid value.

Version 0.9.2

  • Consumer cancel notification support was broken (Issue #1)

    Fix contributed by Andrew Grangaard

Version 0.9.1

  • Supports draining events from multiple channels (Connection.drain_events)

  • Support for timeouts

  • 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 raised
      • but not if a on_cancel callback is passed to basic_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).
  • Support for basic_return

  • Uses AMQP 0-9-1 instead of 0-8.
    • Channel.access_request and ticket arguments to methods removed.
    • Supports the arguments argument to basic_consume.
    • internal argument to exchange_declare removed.
    • auto_delete argument to exchange_declare deprecated
    • insist argument to Connection 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 to queue_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