Skip to content

Update Documentation for Message Object Instantiation #2135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 20, 2025
+28 −0
Merged

Update Documentation for Message Object Instantiation #2135

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c1c28a8
update documentation for msg object instantiation with warning
ojasvajain Nov 19, 2025
6ccac01
add warning block as suggested
ojasvajain Nov 19, 2025
0a1cce9
fix whitespace
ojasvajain Nov 20, 2025
443de0c
fix merge conflicts
ojasvajain Nov 20, 2025
83bd7a9
fix code formatting
ojasvajain Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/confluent_kafka/src/confluent_kafka.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,34 @@ PyTypeObject MessageType = {
"object is a proper message (error() returns None) or an "
"error/event.\n"
"\n"
".. py:function:: Message([topic], [partition], [offset], [key], [value], "
"[headers], [error], [timestamp], [latency], [leader_epoch])\n"
"\n"
" Instantiate a Message object.\n"
"\n"
" .. warning::"
" This constructor is intended **only for testing and mock scenarios**."
" Do **not** use user instantiated Message object in mainstream APIs or "
"in production."
" Using this constructor outside of test environments may result in"
" unexpected behavior, security issues, or inconsistent application "
"state.\n"
"\n"
" All parameters are optional.\n"
"\n"
" :param string topic: Topic name\n"
" :param int partition: Partition number\n"
" :param int offset: Message offset\n"
" :param bytes key: Message key\n"
" :param bytes value: Message value\n"
" :param list headers: Message headers\n"
" :param KafkaError error: KafkaError object\n"
" :param tuple timestamp: (Timestamp type (int), Message epoch timestamp "
"in seconds (int))\n"
" :param float latency: Message latency in seconds\n"
" :param int leader_epoch: Message leader epoch in seconds\n"
" :rtype: Message\n"
"\n"
".. py:function:: len()\n"
"\n"
" :returns: Message value (payload) size in bytes\n"
Expand Down