sendPoll updated fully

Author: coder2020official

telebot/__init__.py

@@ -6089,7 +6089,6 @@ def create_invoice_link(self,
             send_email_to_provider=send_email_to_provider, is_flexible=is_flexible ,subscription_period=subscription_period,
             business_connection_id=business_connection_id)
 
-
     # noinspection PyShadowingBuiltins
     def send_poll(
             self, chat_id: Union[int, str], question: str, options: List[Union[str, types.InputPollOption]],
@@ -6114,7 +6113,15 @@ def send_poll(
             question_parse_mode: Optional[str] = None,
             question_entities: Optional[List[types.MessageEntity]] = None,
             message_effect_id: Optional[str]=None,
-            allow_paid_broadcast: Optional[bool]=None) -> types.Message:
+            allow_paid_broadcast: Optional[bool]=None,
+            allows_revoting: Optional[bool]=None,
+            shuffle_options: Optional[bool]=None,
+            allow_adding_options: Optional[bool]=None,
+            hide_results_until_closes: Optional[bool]=None,
+            correct_option_ids: Optional[List[int]]=None,
+            description: Optional[str]=None,
+            description_parse_mode: Optional[str]=None,
+            description_entities: Optional[List[types.MessageEntity]]=None) -> types.Message:
         """
         Use this method to send a native poll.
         On success, the sent Message is returned.
@@ -6136,10 +6143,10 @@ def send_poll(
         :param type: Poll type, “quiz” or “regular”, defaults to “regular”
         :type type: :obj:`str`
 
-        :param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
+        :param allows_multiple_answers: True, if the poll allows multiple answers, defaults to False
         :type allows_multiple_answers: :obj:`bool`
 
-        :param correct_option_id: 0-based identifier of the correct answer option. Available only for polls in quiz mode, defaults to None
+        :param correct_option_id: Deprecated, use correct_option_ids instead. 
         :type correct_option_id: :obj:`int`
 
         :param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
@@ -6200,6 +6207,30 @@ def send_poll(
             of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance
         :type allow_paid_broadcast: :obj:`bool`
 
+        :param allows_revoting: Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
+        :type allows_revoting: :obj:`bool`
+
+        :param shuffle_options: Pass True, if the poll options must be shown in random order
+        :type shuffle_options: :obj:`bool`
+
+        :param allow_adding_options: Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
+        :type allow_adding_options: :obj:`bool`
+
+        :param hide_results_until_closes: Pass True, if poll results must be shown only after the poll closes
+        :type hide_results_until_closes: :obj:`bool`
+
+        :param correct_option_ids: A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
+        :type correct_option_ids: :obj:`list` of :obj:`int`
+
+        :param description: Description of the poll to be sent, 0-1024 characters after entities parsing
+        :type description: :obj:`str`
+
+        :param description_parse_mode: Mode for parsing entities in the poll description. See formatting options for more details.
+        :type description_parse_mode: :obj:`str`
+
+        :param description_entities: A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
+        :type description_entities: :obj:`list` of :obj:`MessageEntity`
+
         :return: On success, the sent Message is returned.
         :rtype: :obj:`types.Message`
         """
@@ -6232,6 +6263,7 @@ def send_poll(
 
         explanation_parse_mode = self.parse_mode if (explanation_parse_mode is None) else explanation_parse_mode
         question_parse_mode = self.parse_mode if (question_parse_mode is None) else question_parse_mode
+        description_parse_mode = self.parse_mode if (description_parse_mode is None) else description_parse_mode
 
         if options and (not isinstance(options[0], types.InputPollOption)):
             # show a deprecation warning
@@ -6243,19 +6275,33 @@ def send_poll(
                 options = [types.InputPollOption(option.text, text_entities=option.text_entities) for option in options]
             else:
                 raise RuntimeError("Type of 'options' items is unknown. Options should be List[types.InputPollOption], other types are deprecated.")
+            
+        # handle deprecated correct_option_id parameter
+        if correct_option_id is not None and type=="quiz":
+            if correct_option_ids is not None:
+                # show a conflict warning
+                logger.warning("Both 'correct_option_id' and 'correct_option_ids' parameters are set: use 'correct_option_ids' instead.")
+            else:
+                # convert correct_option_id to correct_option_ids
+                correct_option_ids = [correct_option_id]
+                logger.warning("The parameter 'correct_option_id' is deprecated, use 'correct_option_ids' instead.")
+
 
         return types.Message.de_json(
             apihelper.send_poll(
                 self.token, chat_id, question, options,
                 is_anonymous=is_anonymous, type=type, allows_multiple_answers=allows_multiple_answers,
-                correct_option_id=correct_option_id, explanation=explanation,
+                explanation=explanation,
                 explanation_parse_mode=explanation_parse_mode, open_period=open_period,
                 close_date=close_date, is_closed=is_closed, disable_notification=disable_notification,
                 reply_markup=reply_markup, timeout=timeout, explanation_entities=explanation_entities,
                 protect_content=protect_content, message_thread_id=message_thread_id,
                 reply_parameters=reply_parameters, business_connection_id=business_connection_id,
                 question_parse_mode=question_parse_mode, question_entities=question_entities,
-                message_effect_id=message_effect_id, allow_paid_broadcast=allow_paid_broadcast)
+                message_effect_id=message_effect_id, allow_paid_broadcast=allow_paid_broadcast,
+                allows_revoting=allows_revoting, shuffle_options=shuffle_options,
+                allow_adding_options=allow_adding_options, hide_results_until_closes=hide_results_until_closes, correct_option_ids=correct_option_ids,
+                description=description, description_parse_mode=description_parse_mode, description_entities=description_entities)
             )
 
 

telebot/apihelper.py

@@ -2550,11 +2550,12 @@ def create_invoice_link(token, title, description, payload, provider_token,
 # noinspection PyShadowingBuiltins
 def send_poll(
         token, chat_id, question, options,
-        is_anonymous = None, type = None, allows_multiple_answers = None, correct_option_id = None, explanation = None,
+        is_anonymous = None, type = None, allows_multiple_answers = None, explanation = None,
         explanation_parse_mode=None, open_period = None, close_date = None, is_closed = None, disable_notification=False,
         reply_markup=None, timeout=None, explanation_entities=None, protect_content=None, message_thread_id=None,
         reply_parameters=None, business_connection_id=None, question_parse_mode=None, question_entities=None, message_effect_id=None,
-        allow_paid_broadcast=None):
+        allow_paid_broadcast=None, allows_revoting=None, shuffle_options=None, allow_adding_options=None, hide_results_until_closes=None,
+        correct_option_ids=None, description=None, description_parse_mode=None, description_entities=None):
     method_url = r'sendPoll'
     payload = {
         'chat_id': str(chat_id),
@@ -2568,8 +2569,6 @@ def send_poll(
         payload['type'] = type
     if allows_multiple_answers is not None:
         payload['allows_multiple_answers'] = allows_multiple_answers
-    if correct_option_id is not None:
-        payload['correct_option_id'] = correct_option_id
     if explanation:
         payload['explanation'] = explanation
     if explanation_parse_mode:
@@ -2607,6 +2606,22 @@ def send_poll(
         payload['message_effect_id'] = message_effect_id
     if allow_paid_broadcast is not None:
         payload['allow_paid_broadcast'] = allow_paid_broadcast
+    if allows_revoting is not None:
+        payload['allows_revoting'] = allows_revoting
+    if shuffle_options is not None:
+        payload['shuffle_options'] = shuffle_options
+    if allow_adding_options is not None:
+        payload['allow_adding_options'] = allow_adding_options
+    if hide_results_until_closes is not None:
+        payload['hide_results_until_closes'] = hide_results_until_closes
+    if correct_option_ids is not None:
+        payload['correct_option_ids'] = json.dumps(correct_option_ids)
+    if description is not None:
+        payload['description'] = description
+    if description_parse_mode is not None:
+        payload['description_parse_mode'] = description_parse_mode
+    if description_entities is not None:
+        payload['description_entities'] = json.dumps(types.MessageEntity.to_list_of_dicts(description_entities))
     return _make_request(token, method_url, params=payload)
 
 def create_forum_topic(token, chat_id, name, icon_color=None, icon_custom_emoji_id=None):

telebot/async_telebot.py

@@ -7606,6 +7606,7 @@ async def create_invoice_link(self,
             send_email_to_provider, is_flexible, subscription_period=subscription_period, business_connection_id=business_connection_id)
         return result
 
+
     # noinspection PyShadowingBuiltins
     async def send_poll(
             self, chat_id: Union[int, str], question: str, options: List[Union[str, types.InputPollOption]],
@@ -7630,7 +7631,15 @@ async def send_poll(
             question_parse_mode: Optional[str] = None,
             question_entities: Optional[List[types.MessageEntity]] = None,
             message_effect_id: Optional[str]=None,
-            allow_paid_broadcast: Optional[bool]=None) -> types.Message:
+            allow_paid_broadcast: Optional[bool]=None,
+            allows_revoting: Optional[bool]=None,
+            shuffle_options: Optional[bool]=None,
+            allow_adding_options: Optional[bool]=None,
+            hide_results_until_closes: Optional[bool]=None,
+            correct_option_ids: Optional[List[int]]=None,
+            description: Optional[str]=None,
+            description_parse_mode: Optional[str]=None,
+            description_entities: Optional[List[types.MessageEntity]]=None) -> types.Message:
         """
         Use this method to send a native poll.
         On success, the sent Message is returned.
@@ -7652,10 +7661,10 @@ async def send_poll(
         :param type: Poll type, “quiz” or “regular”, defaults to “regular”
         :type type: :obj:`str`
 
-        :param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
+        :param allows_multiple_answers: True, if the poll allows multiple answers, defaults to False
         :type allows_multiple_answers: :obj:`bool`
 
-        :param correct_option_id: 0-based identifier of the correct answer option. Available only for polls in quiz mode,
+        :param correct_option_id: Deprecated, use correct_option_ids instead. 
             defaults to None
         :type correct_option_id: :obj:`int`
 
@@ -7720,6 +7729,30 @@ async def send_poll(
             of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance
         :type allow_paid_broadcast: :obj:`bool`
 
+        :param allows_revoting: Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
+        :type allows_revoting: :obj:`bool`
+
+        :param shuffle_options: Pass True, if the poll options must be shown in random order
+        :type shuffle_options: :obj:`bool`
+
+        :param allow_adding_options: Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
+        :type allow_adding_options: :obj:`bool`
+
+        :param hide_results_until_closes: Pass True, if poll results must be shown only after the poll closes
+        :type hide_results_until_closes: :obj:`bool`
+
+        :param correct_option_ids: A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
+        :type correct_option_ids: :obj:`list` of :obj:`int`
+
+        :param description: Description of the poll to be sent, 0-1024 characters after entities parsing
+        :type description: :obj:`str`
+
+        :param description_parse_mode: Mode for parsing entities in the poll description. See formatting options for more details.
+        :type description_parse_mode: :obj:`str`
+
+        :param description_entities: A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
+        :type description_entities: :obj:`list` of :obj:`MessageEntity`
+
         :return: On success, the sent Message is returned.
         :rtype: :obj:`types.Message`
         """
@@ -7728,6 +7761,7 @@ async def send_poll(
 
         explanation_parse_mode = self.parse_mode if (explanation_parse_mode is None) else explanation_parse_mode
         question_parse_mode = self.parse_mode if (question_parse_mode is None) else question_parse_mode
+        description_parse_mode = self.parse_mode if (description_parse_mode is None) else description_parse_mode
 
         if allow_sending_without_reply is not None:
             logger.warning("The parameter 'allow_sending_without_reply' is deprecated. Use 'reply_parameters' instead.")
@@ -7762,17 +7796,32 @@ async def send_poll(
                 options = [types.InputPollOption(option.text, text_entities=option.text_entities) for option in options]
             else:
                 raise RuntimeError("Type of 'options' items is unknown. Options should be List[types.InputPollOption], other types are deprecated.")
+            
+        # handle deprecated correct_option_id parameter
+        if correct_option_id is not None and type=="quiz":
+            if correct_option_ids is not None:
+                # show a conflict warning
+                logger.warning("Both 'correct_option_id' and 'correct_option_ids' parameters are set: use 'correct_option_ids' instead.")
+            else:
+                # convert correct_option_id to correct_option_ids
+                correct_option_ids = [correct_option_id]
+                logger.warning("The parameter 'correct_option_id' is deprecated, use 'correct_option_ids' instead.")
 
         return types.Message.de_json(
             await asyncio_helper.send_poll(
                 self.token, chat_id,
                 question, options,
-                is_anonymous, type, allows_multiple_answers, correct_option_id,
+                is_anonymous, type, allows_multiple_answers,
                 explanation, explanation_parse_mode, open_period, close_date, is_closed,
                 disable_notification,
                 reply_markup, timeout, explanation_entities, protect_content, message_thread_id, reply_parameters,
                 business_connection_id, question_parse_mode=question_parse_mode, question_entities=question_entities,
-                message_effect_id=message_effect_id, allow_paid_broadcast=allow_paid_broadcast))
+                message_effect_id=message_effect_id, allow_paid_broadcast=allow_paid_broadcast,
+                allows_revoting=allows_revoting, shuffle_options=shuffle_options, allow_adding_options=allow_adding_options,
+                hide_results_until_closes=hide_results_until_closes, correct_option_ids=correct_option_ids, description=description,
+                description_parse_mode=description_parse_mode, description_entities=description_entities
+            )
+        )
 
     async def stop_poll(
             self, chat_id: Union[int, str], message_id: int,

telebot/asyncio_helper.py

@@ -2523,16 +2523,16 @@ async def create_invoice_link(token, title, description, payload, provider_token
     return await _process_request(token, method_url, params=payload, method='post')
 
 
-
 # noinspection PyShadowingBuiltins
 async def send_poll(
         token, chat_id, question, options,
-        is_anonymous = None, type = None, allows_multiple_answers = None, correct_option_id = None,
+        is_anonymous = None, type = None, allows_multiple_answers = None,
         explanation = None, explanation_parse_mode=None, open_period = None, close_date = None, is_closed = None,
         disable_notification=False,  
         reply_markup=None, timeout=None, explanation_entities=None, protect_content=None, message_thread_id=None,
         reply_parameters=None,business_connection_id=None, question_parse_mode=None, question_entities=None, message_effect_id=None,
-        allow_paid_broadcast=None):
+        allow_paid_broadcast=None, allows_revoting=None, shuffle_options=None, allow_adding_options=None, hide_results_until_closes=None,
+        correct_option_ids=None, description=None, description_parse_mode=None, description_entities=None):
     method_url = r'sendPoll'
     payload = {
         'chat_id': str(chat_id),
@@ -2546,8 +2546,6 @@ async def send_poll(
         payload['type'] = type
     if allows_multiple_answers is not None:
         payload['allows_multiple_answers'] = allows_multiple_answers
-    if correct_option_id is not None:
-        payload['correct_option_id'] = correct_option_id
     if explanation is not None:
         payload['explanation'] = explanation
     if explanation_parse_mode is not None:
@@ -2586,6 +2584,22 @@ async def send_poll(
         payload['message_effect_id'] = message_effect_id
     if allow_paid_broadcast is not None:
         payload['allow_paid_broadcast'] = allow_paid_broadcast
+    if allows_revoting is not None:
+        payload['allows_revoting'] = allows_revoting
+    if shuffle_options is not None:
+        payload['shuffle_options'] = shuffle_options
+    if allow_adding_options is not None:
+        payload['allow_adding_options'] = allow_adding_options
+    if hide_results_until_closes is not None:
+        payload['hide_results_until_closes'] = hide_results_until_closes
+    if correct_option_ids is not None:
+        payload['correct_option_ids'] = correct_option_ids
+    if description is not None:
+        payload['description'] = description
+    if description_parse_mode is not None:
+        payload['description_parse_mode'] = description_parse_mode
+    if description_entities is not None:
+        payload['description_entities'] = json.dumps(types.MessageEntity.to_list_of_dicts(description_entities))
     return await _process_request(token, method_url, params=payload)