Parsely/pykafka

Documentation regarding Message

Open

#917 opened on Feb 13, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1,114 stars) (231 forks)batch import
documentationhelp wanted

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.