Parsely/pykafka

Documentation regarding Message

Open

#917 创建于 2019年2月13日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (1,114 star) (231 fork)batch import
documentationhelp wanted

描述

The docs mention that a Message contains a response_code, topic, payload, key (optional) and offset. However, it seems that in practice, response_code, topic and payload are not present.

In addition, in my first exploration of this library, I assumed the consumers to produce messages of type pykafka.common.Message instead of pykafka.protocol.Message, which are better documented. (pykafka.protocol.Message inherits from pykafka.common.Message, so the missing variables listed above apply here as well.) I would suggest also documenting the type of messages returned by the consumers.

PyKafka version: 2.8.0

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Examine the source code of pykafka.common.Message and pykafka.protocol.Message in the repository's common.py and protocol.py files to verify which attributes are actually present. Update the documentation (likely in the docs directory or readthedocs configuration) to accurately list the fields and clarify that consumers return pykafka.protocol.Message instances. Also check if any attributes like response code, topic, and payload have been removed or renamed.