mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-25 08:37:07 +01:00
bd24da29cd
Co-authored-by: Aditya <clot27@apx_managed.vanilla> Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com>
346 lines
12 KiB
Python
346 lines
12 KiB
Python
#!/usr/bin/env python
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2023
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program 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 Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
from datetime import datetime, timedelta, timezone
|
|
|
|
import pytest
|
|
|
|
from telegram import Chat, MessageEntity, Poll, PollAnswer, PollOption, User
|
|
from telegram._utils.datetime import UTC, to_timestamp
|
|
from telegram.constants import PollType
|
|
from telegram.warnings import PTBDeprecationWarning
|
|
from tests.auxil.slots import mro_slots
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def poll_option():
|
|
out = PollOption(text=TestPollOptionBase.text, voter_count=TestPollOptionBase.voter_count)
|
|
out._unfreeze()
|
|
return out
|
|
|
|
|
|
class TestPollOptionBase:
|
|
text = "test option"
|
|
voter_count = 3
|
|
|
|
|
|
class TestPollOptionWithoutRequest(TestPollOptionBase):
|
|
def test_slot_behaviour(self, poll_option):
|
|
for attr in poll_option.__slots__:
|
|
assert getattr(poll_option, attr, "err") != "err", f"got extra slot '{attr}'"
|
|
assert len(mro_slots(poll_option)) == len(set(mro_slots(poll_option))), "duplicate slot"
|
|
|
|
def test_de_json(self):
|
|
json_dict = {"text": self.text, "voter_count": self.voter_count}
|
|
poll_option = PollOption.de_json(json_dict, None)
|
|
assert poll_option.api_kwargs == {}
|
|
|
|
assert poll_option.text == self.text
|
|
assert poll_option.voter_count == self.voter_count
|
|
|
|
def test_to_dict(self, poll_option):
|
|
poll_option_dict = poll_option.to_dict()
|
|
|
|
assert isinstance(poll_option_dict, dict)
|
|
assert poll_option_dict["text"] == poll_option.text
|
|
assert poll_option_dict["voter_count"] == poll_option.voter_count
|
|
|
|
def test_equality(self):
|
|
a = PollOption("text", 1)
|
|
b = PollOption("text", 1)
|
|
c = PollOption("text_1", 1)
|
|
d = PollOption("text", 2)
|
|
e = Poll(123, "question", ["O1", "O2"], 1, False, True, Poll.REGULAR, True)
|
|
|
|
assert a == b
|
|
assert hash(a) == hash(b)
|
|
|
|
assert a != c
|
|
assert hash(a) != hash(c)
|
|
|
|
assert a != d
|
|
assert hash(a) != hash(d)
|
|
|
|
assert a != e
|
|
assert hash(a) != hash(e)
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def poll_answer():
|
|
return PollAnswer(
|
|
TestPollAnswerBase.poll_id,
|
|
TestPollAnswerBase.option_ids,
|
|
TestPollAnswerBase.user,
|
|
TestPollAnswerBase.voter_chat,
|
|
)
|
|
|
|
|
|
class TestPollAnswerBase:
|
|
poll_id = "id"
|
|
option_ids = [2]
|
|
user = User(1, "", False)
|
|
voter_chat = Chat(1, "")
|
|
|
|
|
|
class TestPollAnswerWithoutRequest(TestPollAnswerBase):
|
|
def test_de_json(self):
|
|
json_dict = {
|
|
"poll_id": self.poll_id,
|
|
"option_ids": self.option_ids,
|
|
"user": self.user.to_dict(),
|
|
"voter_chat": self.voter_chat.to_dict(),
|
|
}
|
|
poll_answer = PollAnswer.de_json(json_dict, None)
|
|
assert poll_answer.api_kwargs == {}
|
|
|
|
assert poll_answer.poll_id == self.poll_id
|
|
assert poll_answer.option_ids == tuple(self.option_ids)
|
|
assert poll_answer.user == self.user
|
|
assert poll_answer.voter_chat == self.voter_chat
|
|
|
|
def test_to_dict(self, poll_answer):
|
|
poll_answer_dict = poll_answer.to_dict()
|
|
|
|
assert isinstance(poll_answer_dict, dict)
|
|
assert poll_answer_dict["poll_id"] == poll_answer.poll_id
|
|
assert poll_answer_dict["option_ids"] == list(poll_answer.option_ids)
|
|
assert poll_answer_dict["user"] == poll_answer.user.to_dict()
|
|
assert poll_answer_dict["voter_chat"] == poll_answer.voter_chat.to_dict()
|
|
|
|
def test_equality(self):
|
|
a = PollAnswer(123, [2], self.user, self.voter_chat)
|
|
b = PollAnswer(123, [2], self.user, Chat(1, ""))
|
|
c = PollAnswer(123, [2], User(1, "first", False), self.voter_chat)
|
|
d = PollAnswer(123, [1, 2], self.user, self.voter_chat)
|
|
e = PollAnswer(456, [2], self.user, self.voter_chat)
|
|
f = PollOption("Text", 1)
|
|
|
|
assert a == b
|
|
assert hash(a) == hash(b)
|
|
|
|
assert a == c
|
|
assert hash(a) == hash(c)
|
|
|
|
assert a != d
|
|
assert hash(a) != hash(d)
|
|
|
|
assert a != e
|
|
assert hash(a) != hash(e)
|
|
|
|
assert a != f
|
|
assert hash(a) != hash(f)
|
|
|
|
def test_order_warning(self, recwarn):
|
|
expected_warning = (
|
|
"From v20.5 the order of `option_ids` and `user` is changed as the latter one"
|
|
" became optional. Please update your code to use the new order."
|
|
)
|
|
PollAnswer(123, [2], self.user, self.voter_chat)
|
|
assert len(recwarn) == 0
|
|
PollAnswer(123, self.user, [2], self.voter_chat)
|
|
assert len(recwarn) == 1
|
|
assert str(recwarn[0].message) == expected_warning
|
|
assert recwarn[0].category is PTBDeprecationWarning
|
|
assert recwarn[0].filename == __file__, "wrong stacklevel"
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def poll():
|
|
poll = Poll(
|
|
TestPollBase.id_,
|
|
TestPollBase.question,
|
|
TestPollBase.options,
|
|
TestPollBase.total_voter_count,
|
|
TestPollBase.is_closed,
|
|
TestPollBase.is_anonymous,
|
|
TestPollBase.type,
|
|
TestPollBase.allows_multiple_answers,
|
|
explanation=TestPollBase.explanation,
|
|
explanation_entities=TestPollBase.explanation_entities,
|
|
open_period=TestPollBase.open_period,
|
|
close_date=TestPollBase.close_date,
|
|
)
|
|
poll._unfreeze()
|
|
return poll
|
|
|
|
|
|
class TestPollBase:
|
|
id_ = "id"
|
|
question = "Test?"
|
|
options = [PollOption("test", 10), PollOption("test2", 11)]
|
|
total_voter_count = 0
|
|
is_closed = True
|
|
is_anonymous = False
|
|
type = Poll.REGULAR
|
|
allows_multiple_answers = True
|
|
explanation = (
|
|
b"\\U0001f469\\u200d\\U0001f469\\u200d\\U0001f467"
|
|
b"\\u200d\\U0001f467\\U0001f431http://google.com"
|
|
).decode("unicode-escape")
|
|
explanation_entities = [MessageEntity(13, 17, MessageEntity.URL)]
|
|
open_period = 42
|
|
close_date = datetime.now(timezone.utc)
|
|
|
|
|
|
class TestPollWithoutRequest(TestPollBase):
|
|
def test_de_json(self, bot):
|
|
json_dict = {
|
|
"id": self.id_,
|
|
"question": self.question,
|
|
"options": [o.to_dict() for o in self.options],
|
|
"total_voter_count": self.total_voter_count,
|
|
"is_closed": self.is_closed,
|
|
"is_anonymous": self.is_anonymous,
|
|
"type": self.type,
|
|
"allows_multiple_answers": self.allows_multiple_answers,
|
|
"explanation": self.explanation,
|
|
"explanation_entities": [self.explanation_entities[0].to_dict()],
|
|
"open_period": self.open_period,
|
|
"close_date": to_timestamp(self.close_date),
|
|
}
|
|
poll = Poll.de_json(json_dict, bot)
|
|
assert poll.api_kwargs == {}
|
|
|
|
assert poll.id == self.id_
|
|
assert poll.question == self.question
|
|
assert poll.options == tuple(self.options)
|
|
assert poll.options[0].text == self.options[0].text
|
|
assert poll.options[0].voter_count == self.options[0].voter_count
|
|
assert poll.options[1].text == self.options[1].text
|
|
assert poll.options[1].voter_count == self.options[1].voter_count
|
|
assert poll.total_voter_count == self.total_voter_count
|
|
assert poll.is_closed == self.is_closed
|
|
assert poll.is_anonymous == self.is_anonymous
|
|
assert poll.type == self.type
|
|
assert poll.allows_multiple_answers == self.allows_multiple_answers
|
|
assert poll.explanation == self.explanation
|
|
assert poll.explanation_entities == tuple(self.explanation_entities)
|
|
assert poll.open_period == self.open_period
|
|
assert abs(poll.close_date - self.close_date) < timedelta(seconds=1)
|
|
assert to_timestamp(poll.close_date) == to_timestamp(self.close_date)
|
|
|
|
def test_de_json_localization(self, tz_bot, bot, raw_bot):
|
|
json_dict = {
|
|
"id": self.id_,
|
|
"question": self.question,
|
|
"options": [o.to_dict() for o in self.options],
|
|
"total_voter_count": self.total_voter_count,
|
|
"is_closed": self.is_closed,
|
|
"is_anonymous": self.is_anonymous,
|
|
"type": self.type,
|
|
"allows_multiple_answers": self.allows_multiple_answers,
|
|
"explanation": self.explanation,
|
|
"explanation_entities": [self.explanation_entities[0].to_dict()],
|
|
"open_period": self.open_period,
|
|
"close_date": to_timestamp(self.close_date),
|
|
}
|
|
|
|
poll_raw = Poll.de_json(json_dict, raw_bot)
|
|
poll_bot = Poll.de_json(json_dict, bot)
|
|
poll_bot_tz = Poll.de_json(json_dict, tz_bot)
|
|
|
|
# comparing utcoffsets because comparing timezones is unpredicatable
|
|
poll_bot_tz_offset = poll_bot_tz.close_date.utcoffset()
|
|
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(
|
|
poll_bot_tz.close_date.replace(tzinfo=None)
|
|
)
|
|
|
|
assert poll_raw.close_date.tzinfo == UTC
|
|
assert poll_bot.close_date.tzinfo == UTC
|
|
assert poll_bot_tz_offset == tz_bot_offset
|
|
|
|
def test_to_dict(self, poll):
|
|
poll_dict = poll.to_dict()
|
|
|
|
assert isinstance(poll_dict, dict)
|
|
assert poll_dict["id"] == poll.id
|
|
assert poll_dict["question"] == poll.question
|
|
assert poll_dict["options"] == [o.to_dict() for o in poll.options]
|
|
assert poll_dict["total_voter_count"] == poll.total_voter_count
|
|
assert poll_dict["is_closed"] == poll.is_closed
|
|
assert poll_dict["is_anonymous"] == poll.is_anonymous
|
|
assert poll_dict["type"] == poll.type
|
|
assert poll_dict["allows_multiple_answers"] == poll.allows_multiple_answers
|
|
assert poll_dict["explanation"] == poll.explanation
|
|
assert poll_dict["explanation_entities"] == [poll.explanation_entities[0].to_dict()]
|
|
assert poll_dict["open_period"] == poll.open_period
|
|
assert poll_dict["close_date"] == to_timestamp(poll.close_date)
|
|
|
|
def test_equality(self):
|
|
a = Poll(123, "question", ["O1", "O2"], 1, False, True, Poll.REGULAR, True)
|
|
b = Poll(123, "question", ["o1", "o2"], 1, True, False, Poll.REGULAR, True)
|
|
c = Poll(456, "question", ["o1", "o2"], 1, True, False, Poll.REGULAR, True)
|
|
d = PollOption("Text", 1)
|
|
|
|
assert a == b
|
|
assert hash(a) == hash(b)
|
|
|
|
assert a != c
|
|
assert hash(a) != hash(c)
|
|
|
|
assert a != d
|
|
assert hash(a) != hash(d)
|
|
|
|
def test_enum_init(self):
|
|
poll = Poll(
|
|
type="foo",
|
|
id="id",
|
|
question="question",
|
|
options=[],
|
|
total_voter_count=0,
|
|
is_closed=False,
|
|
is_anonymous=False,
|
|
allows_multiple_answers=False,
|
|
)
|
|
assert poll.type == "foo"
|
|
poll = Poll(
|
|
type=PollType.QUIZ,
|
|
id="id",
|
|
question="question",
|
|
options=[],
|
|
total_voter_count=0,
|
|
is_closed=False,
|
|
is_anonymous=False,
|
|
allows_multiple_answers=False,
|
|
)
|
|
assert poll.type is PollType.QUIZ
|
|
|
|
def test_parse_entity(self, poll):
|
|
entity = MessageEntity(type=MessageEntity.URL, offset=13, length=17)
|
|
poll.explanation_entities = [entity]
|
|
|
|
assert poll.parse_explanation_entity(entity) == "http://google.com"
|
|
|
|
with pytest.raises(RuntimeError, match="Poll has no"):
|
|
Poll(
|
|
"id",
|
|
"question",
|
|
[PollOption("text", voter_count=0)],
|
|
total_voter_count=0,
|
|
is_closed=False,
|
|
is_anonymous=False,
|
|
type=Poll.QUIZ,
|
|
allows_multiple_answers=False,
|
|
).parse_explanation_entity(entity)
|
|
|
|
def test_parse_entities(self, poll):
|
|
entity = MessageEntity(type=MessageEntity.URL, offset=13, length=17)
|
|
entity_2 = MessageEntity(type=MessageEntity.BOLD, offset=13, length=1)
|
|
poll.explanation_entities = [entity_2, entity]
|
|
|
|
assert poll.parse_explanation_entities(MessageEntity.URL) == {entity: "http://google.com"}
|
|
assert poll.parse_explanation_entities() == {entity: "http://google.com", entity_2: "h"}
|