Skip to main content

Pika Python AMQP Client Library

Project description

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

Version 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.6+ and 3.3+ 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

  • LibevConnection - adapter for use with the libev event loop http://libev.schmorp.de

  • 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-0.11.0.tar.gz (96.4 kB view details)

Uploaded Source

Built Distribution

pika-0.11.0-py2.py3-none-any.whl (106.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pika-0.11.0.tar.gz.

File metadata

  • Download URL: pika-0.11.0.tar.gz
  • Upload date:
  • Size: 96.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pika-0.11.0.tar.gz
Algorithm Hash digest
SHA256 b87fd6b339450f531b8cba3bc02d8448cab15798032c02b7601367d09abc3818
MD5 5127731ff530c46bc9a34eff1cfc64ef
BLAKE2b-256 26100493cb0579b34e453fcd9c56fbf4504a5e4a9d9c8db80cece3fbc92e06d2

See more details on using hashes here.

File details

Details for the file pika-0.11.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pika-0.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4bff8f1b8f0db97a021c0df97afa093e8d291bd0ae1f75cd55961614619b6382
MD5 458f64c9b714bcfcf20eb49c32d8f1e3
BLAKE2b-256 e1f7badaf1e25b4b8ad905b4cf08b2e4df431393aa7580563caf02f74b5aa186

See more details on using hashes here.

Supported by

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