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-0.12.0b4.tar.gz (98.8 kB view details)

Uploaded Source

Built Distribution

pika-0.12.0b4-py2.py3-none-any.whl (107.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pika-0.12.0b4.tar.gz.

File metadata

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

File hashes

Hashes for pika-0.12.0b4.tar.gz
Algorithm Hash digest
SHA256 c228154b1357a898eb7079f15a3979a60cb015b4c8e357a35d0e58084f1c50b8
MD5 e64ab8d6d959c8a9227f6af2dbb296df
BLAKE2b-256 2069341b06d9b1187af9d875f6cb7450c75a4c9a1175fbd5428ed7a896a3f292

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pika-0.12.0b4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a412c3a2a3504a49159ca14c1485e50e7fb20e52d047b8b7cc1ff00aaee48706
MD5 2cd78da5d0fd985cbbf1c5c4d0b1cd44
BLAKE2b-256 40a44fce7a286bff8a7fdad524c6ed1551bcb6af0ae1eef57627c9d85ea27b3f

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