-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathsend_poll.py
More file actions
239 lines (202 loc) · 10.1 KB
/
send_poll.py
File metadata and controls
239 lines (202 loc) · 10.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hydrogram is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import TYPE_CHECKING
import hydrogram
from hydrogram import enums, raw, types, utils
if TYPE_CHECKING:
from datetime import datetime
class SendPoll:
async def send_poll(
self: hydrogram.Client,
chat_id: int | str,
question: str,
options: list[types.InputPollOption],
*,
question_parse_mode: enums.ParseMode = None,
question_entities: list[types.MessageEntity] | None = None,
message_thread_id: int | None = None,
is_anonymous: bool = True,
type: enums.PollType = enums.PollType.REGULAR,
allows_multiple_answers: bool | None = None,
correct_option_id: int | None = None,
explanation: str | None = None,
explanation_parse_mode: enums.ParseMode = None,
explanation_entities: list[types.MessageEntity] | None = None,
open_period: int | None = None,
close_date: datetime | None = None,
is_closed: bool | None = None,
disable_notification: bool | None = None,
protect_content: bool | None = None,
reply_to_message_id: int | None = None,
schedule_date: datetime | None = None,
reply_markup: types.InlineKeyboardMarkup
| types.ReplyKeyboardMarkup
| types.ReplyKeyboardRemove
| types.ForceReply = None,
) -> types.Message:
"""Send a new poll.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
question (``str``):
Poll question, 1-255 characters.
options (List of :obj:`~hydrogram.types.InputPollOption`):
List of answer options, 2-10 answer options, 1-100 characters for each option.
question_parse_mode (:obj:`~hydrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
question_entities (List of :obj:`~hydrogram.types.MessageEntity`):
List of special entities that appear in the poll question, which can be specified instead of *question_parse_mode*.
message_thread_id (``int``, *optional*):
Unique identifier for the target message thread (topic) of the forum.
for forum supergroups only.
is_anonymous (``bool``, *optional*):
True, if the poll needs to be anonymous.
Defaults to True.
type (:obj`~hydrogram.enums.PollType`, *optional*):
Poll type, :obj:`~hydrogram.enums.PollType.QUIZ` or :obj:`~hydrogram.enums.PollType.REGULAR`.
Defaults to :obj:`~hydrogram.enums.PollType.REGULAR`.
allows_multiple_answers (``bool``, *optional*):
True, if the poll allows multiple answers, ignored for polls in quiz mode.
Defaults to False.
correct_option_id (``int``, *optional*):
0-based identifier of the correct answer option, required for polls in quiz mode.
explanation (``str``, *optional*):
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.
explanation_parse_mode (:obj:`~hydrogram.enums.ParseMode`, *optional*):
By default, texts are parsed using both Markdown and HTML styles.
You can combine both syntaxes together.
explanation_entities (List of :obj:`~hydrogram.types.MessageEntity`):
List of special entities that appear in the poll explanation, which can be specified instead of
*parse_mode*.
open_period (``int``, *optional*):
Amount of time in seconds the poll will be active after creation, 5-600.
Can't be used together with *close_date*.
close_date (:py:obj:`~datetime.datetime`, *optional*):
Point in time when the poll will be automatically closed.
Must be at least 5 and no more than 600 seconds in the future.
Can't be used together with *open_period*.
is_closed (``bool``, *optional*):
Pass True, if the poll needs to be immediately closed.
This can be useful for poll preview.
disable_notification (``bool``, *optional*):
Sends the message silently.
Users will receive a notification with no sound.
protect_content (``bool``, *optional*):
Protects the contents of the sent message from forwarding and saving.
reply_to_message_id (``int``, *optional*):
If the message is a reply, ID of the original message.
schedule_date (:py:obj:`~datetime.datetime`, *optional*):
Date when the message will be automatically sent.
reply_markup (:obj:`~hydrogram.types.InlineKeyboardMarkup` | :obj:`~hydrogram.types.ReplyKeyboardMarkup` | :obj:`~hydrogram.types.ReplyKeyboardRemove` | :obj:`~hydrogram.types.ForceReply`, *optional*):
Additional interface options. An object for an inline keyboard, custom reply keyboard,
instructions to remove reply keyboard or to force a reply from the user.
Returns:
:obj:`~hydrogram.types.Message`: On success, the sent poll message is returned.
Example:
.. code-block:: python
await app.send_poll(chat_id, "Is this a poll question?", ["Yes", "No", "Maybe"])
"""
solution, solution_entities = (
(
await utils.parse_text_entities(
self, explanation, explanation_parse_mode, explanation_entities
)
).values()
if explanation
else (None, None)
)
reply_to = utils.get_reply_head_fm(message_thread_id, reply_to_message_id)
question, question_entities = (
await utils.parse_text_entities(self, question, question_parse_mode, question_entities)
).values()
if not question_entities:
question_entities = []
answers = []
for i, answer_ in enumerate(options):
if isinstance(answer_, str):
answer, answer_entities = answer_, []
else:
answer, answer_entities = (
await utils.parse_text_entities(
self, answer_.text, answer_.text_parse_mode, answer_.text_entities
)
).values()
if not answer_entities:
answer_entities = []
answers.append(
raw.types.PollAnswer(
text=raw.types.TextWithEntities(text=answer, entities=answer_entities),
option=bytes([i]),
)
)
r = await self.invoke(
raw.functions.messages.SendMedia(
peer=await self.resolve_peer(chat_id),
media=raw.types.InputMediaPoll(
poll=raw.types.Poll(
id=self.rnd_id(),
question=raw.types.TextWithEntities(
text=question, entities=question_entities
),
answers=answers,
closed=is_closed,
public_voters=not is_anonymous,
multiple_choice=allows_multiple_answers,
quiz=type == enums.PollType.QUIZ or False,
close_period=open_period,
close_date=utils.datetime_to_timestamp(close_date),
),
correct_answers=[bytes([correct_option_id])]
if correct_option_id is not None
else None,
solution=solution,
solution_entities=None if solution is None else (solution_entities or []),
),
message="",
silent=disable_notification,
reply_to=reply_to,
random_id=self.rnd_id(),
schedule_date=utils.datetime_to_timestamp(schedule_date),
noforwards=protect_content,
reply_markup=await reply_markup.write(self) if reply_markup else None,
)
)
for i in r.updates:
if isinstance(
i,
(
raw.types.UpdateNewMessage,
raw.types.UpdateNewChannelMessage,
raw.types.UpdateNewScheduledMessage,
),
):
return await types.Message._parse(
client=self,
message=i.message,
users={i.id: i for i in r.users},
chats={i.id: i for i in r.chats},
is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage),
)
return None