Skip to main content

Pika Python AMQP Client Library

Project description

Pika is a RabbitMQ (AMQP-0-9-1) client library for Python.

Version Python versions Status Coverage License Documentation Status

Introduction

Pika is a pure-Python implementation of the AMQP 0-9-1 protocol including RabbitMQ’s extensions.

  • Python 2.7 and 3.4+ are supported.

  • Since threads aren’t appropriate to every situation, it doesn’t require threads. It takes care not to forbid them, either. The same goes for greenlets, callbacks, continuations and generators. It is not necessarily thread-safe however, and your mileage will vary.

  • People may be using direct sockets, plain old select(), or any of the wide variety of ways of getting network events to and from a python application. Pika tries to stay compatible with all of these, and to make adapting it to a new environment as simple as possible.

Documentation

Pika’s documentation can be found at https://pika.readthedocs.io

Example

Here is the most simple example of use, sending a message with the BlockingConnection adapter:

import pika
connection = pika.BlockingConnection()
channel = connection.channel()
channel.basic_publish(exchange='example',
                      routing_key='test',
                      body='Test Message')
connection.close()

And an example of writing a blocking consumer:

import pika
connection = pika.BlockingConnection()
channel = connection.channel()

for method_frame, properties, body in channel.consume('test'):

    # Display the message parts and ack the message
    print(method_frame, properties, body)
    channel.basic_ack(method_frame.delivery_tag)

    # Escape out of the loop after 10 messages
    if method_frame.delivery_tag == 10:
        break

# Cancel the consumer and return any pending messages
requeued_messages = channel.cancel()
print('Requeued %i messages' % requeued_messages)
connection.close()

Pika provides the following adapters

  • AsyncioConnection - adapter for the Python3 AsyncIO event loop

  • BlockingConnection - enables blocking, synchronous operation on top of library for simple uses

  • SelectConnection - fast asynchronous adapter

  • TornadoConnection - adapter for use with the Tornado IO Loop http://tornadoweb.org

  • TwistedConnection - adapter for use with the Twisted asynchronous package http://twistedmatrix.com/

Contributing

To contribute to pika, please make sure that any new features or changes to existing functionality include test coverage.

Pull requests that add or change code without coverage will most likely be rejected.

Additionally, please format your code using yapf with google style prior to issuing your pull request.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pika-dev-1.0.0b1.dev1.tar.gz (101.5 kB view details)

Uploaded Source

Built Distribution

pika_dev-1.0.0b1.dev1-py2.py3-none-any.whl (111.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pika-dev-1.0.0b1.dev1.tar.gz.

File metadata

File hashes

Hashes for pika-dev-1.0.0b1.dev1.tar.gz
Algorithm Hash digest
SHA256 526de5d34f338deb0d2c71c4ea8a9875c72d598d65a62397f6dc7022f3902bcb
MD5 2d131a12e01f68f649f61a89a97427a2
BLAKE2b-256 2d6861916ac5afb7f21391e66b51337a70dc2f6c1479650710197a07aaafcbe5

See more details on using hashes here.

Provenance

File details

Details for the file pika_dev-1.0.0b1.dev1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pika_dev-1.0.0b1.dev1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 33363fa46a404c47889a463e70b059d5d438588b53ef052ff46a6be59a0d5d6a
MD5 c0672c3d09240f66d5211ca13432b0dc
BLAKE2b-256 028ad38491ddc2ef19358b96d4b301882b1934749de021c2c4f5348de06bf794

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page