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.2.tar.gz (97.4 kB view details)

Uploaded Source

Built Distribution

pika-0.11.2-py2.py3-none-any.whl (107.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for pika-0.11.2.tar.gz
Algorithm Hash digest
SHA256 ded1cf12810f909099a3a698cc5adf495b73fd2da1d8f669f8b267664653122d
MD5 2cd012637a43e927f8ae2d86e1e1efd5
BLAKE2b-256 d94de29eed9904ce16787a1e869fd93c733f0b053c6b6e7a22741be83f93e69a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pika-0.11.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 15f485eb68ec56b5a2673c01d518d16f7c371809ca42c72a2da42d4d8190fa4f
MD5 58dd98612613e3e8e3b6f54b613b4041
BLAKE2b-256 76b40ada6918ac79ce4d8d45d0ba436ee21a1ef685047fb1dde4d2de0178b327

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