Skip to content

Commit ece423f

Browse files
authored
Update Documentation for Message Object Instantiation (#2135)
* update documentation for msg object instantiation with warning * add warning block as suggested * fix whitespace * fix code formatting
1 parent 921eb15 commit ece423f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/confluent_kafka/src/confluent_kafka.c

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,34 @@ PyTypeObject MessageType = {
815815
"object is a proper message (error() returns None) or an "
816816
"error/event.\n"
817817
"\n"
818+
".. py:function:: Message([topic], [partition], [offset], [key], [value], "
819+
"[headers], [error], [timestamp], [latency], [leader_epoch])\n"
820+
"\n"
821+
" Instantiate a Message object.\n"
822+
"\n"
823+
" .. warning::"
824+
" This constructor is intended **only for testing and mock scenarios**."
825+
" Do **not** use user instantiated Message object in mainstream APIs or "
826+
"in production."
827+
" Using this constructor outside of test environments may result in"
828+
" unexpected behavior, security issues, or inconsistent application "
829+
"state.\n"
830+
"\n"
831+
" All parameters are optional.\n"
832+
"\n"
833+
" :param string topic: Topic name\n"
834+
" :param int partition: Partition number\n"
835+
" :param int offset: Message offset\n"
836+
" :param bytes key: Message key\n"
837+
" :param bytes value: Message value\n"
838+
" :param list headers: Message headers\n"
839+
" :param KafkaError error: KafkaError object\n"
840+
" :param tuple timestamp: (Timestamp type (int), Message epoch timestamp "
841+
"in seconds (int))\n"
842+
" :param float latency: Message latency in seconds\n"
843+
" :param int leader_epoch: Message leader epoch in seconds\n"
844+
" :rtype: Message\n"
845+
"\n"
818846
".. py:function:: len()\n"
819847
"\n"
820848
" :returns: Message value (payload) size in bytes\n"

0 commit comments

Comments
 (0)