Pika

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

Pika是 RabbitMQ (AMQP-0-9-1)服务器客户端程序的Python实现.

Introduction

简介

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

Pika 使用Python实现了AMQP 0-9-1协议并且包含针对RabbitMQ服务器的扩展。

• Python 2.6+ and 3.3+ are supported.
• 支持Python 2.6及以上和3.6及以上版本
• 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.
• 每个解决方案引入线程的方式并不一定合适，因此Pika不要求线程，也不禁止使用线程。同时，其它的方法包括并发, 回调,长连接和协程.它不保证线程安全，因此需要选择适合自己的。
• 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.
• 对于在老版本的Python应用程序中使用的sockets，select或者各种各样的网络事件，Pika尽可能的兼容他们，并且在新的环境中使用尽量简单。

Documentation

文档

Pika's documentation can be found at https://pika.readthedocs.org

Pika 官方文档地址 https://pika.readthedocs.org

Example

Here is the most simple example of use, sending a message with the BlockingConnection adapter: 这里是一个非常简单的例子，使用BlockingConnection适配器发送了一个消息(生产者)：

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
    # 接收10条消息后跳出循环
    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

Pika提供了一下适配器

• BlockingConnection - enables blocking, synchronous operation on top of library for simple uses
• BlockingConnection - 会造成阻塞 最简单的一种同步操作应用库的方式
• LibevConnection - adapter for use with the libev event loop http://libev.schmorp.de
• LibevConnection - 适配器使用了libev的事件循环
• SelectConnection - fast asynchronous adapterlibev loop http://libev.schmorp.de
• SelectConnection - 快速异步适配libev循环 http://libev.schmorp.de
• TornadoConnection - adapter for use with the Tornado IO Loop http://tornadoweb.org
• TornadoConnection - 适配器使用了Tornado的IO循环
• TwistedConnection - adapter for use with the Twisted asynchronous package http://twistedmatrix.com/
• TwistedConnection - 适配器使用了Twisted的异步

Contributing

公约

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

为了保证Pika，请确保任何新功能添加或改变现有功能包括单元测试。

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.

此外，在推送之前请用 yapf 格式化你的代码，生成满足``google``风格的代码。