From d3c63797b052060b994b6be16d47c8d4503e1bbf Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Sat, 27 Jan 2024 18:04:05 +0200 Subject: [PATCH] Add KeyboardButtonPollTypeType enum (#1398) * Add KeyboardButtonPollTypeType enum A new enum, KeyboardButtonPollType, has been added and documented. This enum holds types of polls that can be created and sent when the corresponding button is pressed. It is now imported and included in the aiogram enums documentation. * Added changelog --- .butcher/enums/KeyboardButtonPollTypeType.yml | 8 ++++++++ CHANGES/1398.feature.rst | 1 + aiogram/enums/__init__.py | 2 ++ aiogram/enums/keyboard_button_poll_type_type.py | 12 ++++++++++++ docs/api/enums/index.rst | 1 + docs/api/enums/keyboard_button_poll_type_type.rst | 9 +++++++++ 6 files changed, 33 insertions(+) create mode 100644 .butcher/enums/KeyboardButtonPollTypeType.yml create mode 100644 CHANGES/1398.feature.rst create mode 100644 aiogram/enums/keyboard_button_poll_type_type.py create mode 100644 docs/api/enums/keyboard_button_poll_type_type.rst diff --git a/.butcher/enums/KeyboardButtonPollTypeType.yml b/.butcher/enums/KeyboardButtonPollTypeType.yml new file mode 100644 index 00000000..ee7cb122 --- /dev/null +++ b/.butcher/enums/KeyboardButtonPollTypeType.yml @@ -0,0 +1,8 @@ +name: KeyboardButtonPollTypeType +description: | + This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. + + Source: https://core.telegram.org/bots/api#keyboardbuttonpolltype +static: + QUIZ: "quiz" + REGULAR: "regular" diff --git a/CHANGES/1398.feature.rst b/CHANGES/1398.feature.rst new file mode 100644 index 00000000..02845055 --- /dev/null +++ b/CHANGES/1398.feature.rst @@ -0,0 +1 @@ +A new enum :code:`KeyboardButtonPollTypeType` for :code:`KeyboardButtonPollTypeType.type` field has bed added. diff --git a/aiogram/enums/__init__.py b/aiogram/enums/__init__.py index 079fdc0f..c3d8d587 100644 --- a/aiogram/enums/__init__.py +++ b/aiogram/enums/__init__.py @@ -9,6 +9,7 @@ from .dice_emoji import DiceEmoji from .encrypted_passport_element import EncryptedPassportElement from .inline_query_result_type import InlineQueryResultType from .input_media_type import InputMediaType +from .keyboard_button_poll_type_type import KeyboardButtonPollTypeType from .mask_position_point import MaskPositionPoint from .menu_button_type import MenuButtonType from .message_entity_type import MessageEntityType @@ -34,6 +35,7 @@ __all__ = ( "EncryptedPassportElement", "InlineQueryResultType", "InputMediaType", + "KeyboardButtonPollTypeType", "MaskPositionPoint", "MenuButtonType", "MessageEntityType", diff --git a/aiogram/enums/keyboard_button_poll_type_type.py b/aiogram/enums/keyboard_button_poll_type_type.py new file mode 100644 index 00000000..b6b692fb --- /dev/null +++ b/aiogram/enums/keyboard_button_poll_type_type.py @@ -0,0 +1,12 @@ +from enum import Enum + + +class KeyboardButtonPollTypeType(str, Enum): + """ + This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. + + Source: https://core.telegram.org/bots/api#keyboardbuttonpolltype + """ + + QUIZ = "quiz" + REGULAR = "regular" diff --git a/docs/api/enums/index.rst b/docs/api/enums/index.rst index a1e72320..756a04b5 100644 --- a/docs/api/enums/index.rst +++ b/docs/api/enums/index.rst @@ -21,6 +21,7 @@ Here is list of all available enums: encrypted_passport_element inline_query_result_type input_media_type + keyboard_button_poll_type_type mask_position_point menu_button_type message_entity_type diff --git a/docs/api/enums/keyboard_button_poll_type_type.rst b/docs/api/enums/keyboard_button_poll_type_type.rst new file mode 100644 index 00000000..028b2637 --- /dev/null +++ b/docs/api/enums/keyboard_button_poll_type_type.rst @@ -0,0 +1,9 @@ +########################## +KeyboardButtonPollTypeType +########################## + + +.. automodule:: aiogram.enums.keyboard_button_poll_type_type + :members: + :member-order: bysource + :undoc-members: True