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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
|
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2025
# 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/].
import datetime as dtm
import pytest
from telegram import (
BotCommand,
Chat,
Giveaway,
GiveawayCompleted,
GiveawayCreated,
GiveawayWinners,
Message,
User,
)
from telegram._utils.datetime import UTC, to_timestamp
from tests.auxil.slots import mro_slots
@pytest.fixture(scope="module")
def giveaway():
return Giveaway(
chats=[Chat(1, Chat.CHANNEL), Chat(2, Chat.SUPERGROUP)],
winners_selection_date=TestGiveawayWithoutRequest.winners_selection_date,
winner_count=TestGiveawayWithoutRequest.winner_count,
only_new_members=TestGiveawayWithoutRequest.only_new_members,
has_public_winners=TestGiveawayWithoutRequest.has_public_winners,
prize_description=TestGiveawayWithoutRequest.prize_description,
country_codes=TestGiveawayWithoutRequest.country_codes,
premium_subscription_month_count=(
TestGiveawayWithoutRequest.premium_subscription_month_count
),
prize_star_count=TestGiveawayWithoutRequest.prize_star_count,
)
class TestGiveawayWithoutRequest:
chats = [Chat(1, Chat.CHANNEL), Chat(2, Chat.SUPERGROUP)]
winners_selection_date = dtm.datetime.now(dtm.timezone.utc).replace(microsecond=0)
winner_count = 42
only_new_members = True
has_public_winners = True
prize_description = "prize_description"
country_codes = ["DE", "US"]
premium_subscription_month_count = 3
prize_star_count = 99
def test_slot_behaviour(self, giveaway):
for attr in giveaway.__slots__:
assert getattr(giveaway, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(giveaway)) == len(set(mro_slots(giveaway))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"chats": [chat.to_dict() for chat in self.chats],
"winners_selection_date": to_timestamp(self.winners_selection_date),
"winner_count": self.winner_count,
"only_new_members": self.only_new_members,
"has_public_winners": self.has_public_winners,
"prize_description": self.prize_description,
"country_codes": self.country_codes,
"premium_subscription_month_count": self.premium_subscription_month_count,
"prize_star_count": self.prize_star_count,
}
giveaway = Giveaway.de_json(json_dict, offline_bot)
assert giveaway.api_kwargs == {}
assert giveaway.chats == tuple(self.chats)
assert giveaway.winners_selection_date == self.winners_selection_date
assert giveaway.winner_count == self.winner_count
assert giveaway.only_new_members == self.only_new_members
assert giveaway.has_public_winners == self.has_public_winners
assert giveaway.prize_description == self.prize_description
assert giveaway.country_codes == tuple(self.country_codes)
assert giveaway.premium_subscription_month_count == self.premium_subscription_month_count
assert giveaway.prize_star_count == self.prize_star_count
def test_de_json_localization(self, tz_bot, offline_bot, raw_bot):
json_dict = {
"chats": [chat.to_dict() for chat in self.chats],
"winners_selection_date": to_timestamp(self.winners_selection_date),
"winner_count": self.winner_count,
"only_new_members": self.only_new_members,
"has_public_winners": self.has_public_winners,
"prize_description": self.prize_description,
"country_codes": self.country_codes,
"premium_subscription_month_count": self.premium_subscription_month_count,
"prize_star_count": self.prize_star_count,
}
giveaway_raw = Giveaway.de_json(json_dict, raw_bot)
giveaway_bot = Giveaway.de_json(json_dict, offline_bot)
giveaway_bot_tz = Giveaway.de_json(json_dict, tz_bot)
# comparing utcoffsets because comparing timezones is unpredicatable
giveaway_bot_tz_offset = giveaway_bot_tz.winners_selection_date.utcoffset()
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(
giveaway_bot_tz.winners_selection_date.replace(tzinfo=None)
)
assert giveaway_raw.winners_selection_date.tzinfo == UTC
assert giveaway_bot.winners_selection_date.tzinfo == UTC
assert giveaway_bot_tz_offset == tz_bot_offset
def test_to_dict(self, giveaway):
giveaway_dict = giveaway.to_dict()
assert isinstance(giveaway_dict, dict)
assert giveaway_dict["chats"] == [chat.to_dict() for chat in self.chats]
assert giveaway_dict["winners_selection_date"] == to_timestamp(self.winners_selection_date)
assert giveaway_dict["winner_count"] == self.winner_count
assert giveaway_dict["only_new_members"] == self.only_new_members
assert giveaway_dict["has_public_winners"] == self.has_public_winners
assert giveaway_dict["prize_description"] == self.prize_description
assert giveaway_dict["country_codes"] == self.country_codes
assert (
giveaway_dict["premium_subscription_month_count"]
== self.premium_subscription_month_count
)
assert giveaway_dict["prize_star_count"] == self.prize_star_count
def test_equality(self, giveaway):
a = giveaway
b = Giveaway(
chats=self.chats,
winners_selection_date=self.winners_selection_date,
winner_count=self.winner_count,
)
c = Giveaway(
chats=self.chats,
winners_selection_date=self.winners_selection_date + dtm.timedelta(seconds=100),
winner_count=self.winner_count,
)
d = Giveaway(
chats=self.chats, winners_selection_date=self.winners_selection_date, winner_count=17
)
e = BotCommand("start", "description")
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 giveaway_created():
return GiveawayCreated(
prize_star_count=TestGiveawayCreatedWithoutRequest.prize_star_count,
)
class TestGiveawayCreatedWithoutRequest:
prize_star_count = 99
def test_slot_behaviour(self, giveaway_created):
for attr in giveaway_created.__slots__:
assert getattr(giveaway_created, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(giveaway_created)) == len(
set(mro_slots(giveaway_created))
), "duplicate slot"
def test_de_json(self, bot):
json_dict = {
"prize_star_count": self.prize_star_count,
}
gac = GiveawayCreated.de_json(json_dict, bot)
assert gac.api_kwargs == {}
assert gac.prize_star_count == self.prize_star_count
def test_to_dict(self, giveaway_created):
gac_dict = giveaway_created.to_dict()
assert isinstance(gac_dict, dict)
assert gac_dict["prize_star_count"] == self.prize_star_count
@pytest.fixture(scope="module")
def giveaway_winners():
return GiveawayWinners(
chat=TestGiveawayWinnersWithoutRequest.chat,
giveaway_message_id=TestGiveawayWinnersWithoutRequest.giveaway_message_id,
winners_selection_date=TestGiveawayWinnersWithoutRequest.winners_selection_date,
winner_count=TestGiveawayWinnersWithoutRequest.winner_count,
winners=TestGiveawayWinnersWithoutRequest.winners,
only_new_members=TestGiveawayWinnersWithoutRequest.only_new_members,
prize_description=TestGiveawayWinnersWithoutRequest.prize_description,
premium_subscription_month_count=(
TestGiveawayWinnersWithoutRequest.premium_subscription_month_count
),
additional_chat_count=TestGiveawayWinnersWithoutRequest.additional_chat_count,
unclaimed_prize_count=TestGiveawayWinnersWithoutRequest.unclaimed_prize_count,
was_refunded=TestGiveawayWinnersWithoutRequest.was_refunded,
prize_star_count=TestGiveawayWinnersWithoutRequest.prize_star_count,
)
class TestGiveawayWinnersWithoutRequest:
chat = Chat(1, Chat.CHANNEL)
giveaway_message_id = 123456789
winners_selection_date = dtm.datetime.now(dtm.timezone.utc).replace(microsecond=0)
winner_count = 42
winners = [User(1, "user1", False), User(2, "user2", False)]
additional_chat_count = 2
premium_subscription_month_count = 3
unclaimed_prize_count = 4
only_new_members = True
was_refunded = True
prize_description = "prize_description"
prize_star_count = 99
def test_slot_behaviour(self, giveaway_winners):
for attr in giveaway_winners.__slots__:
assert getattr(giveaway_winners, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(giveaway_winners)) == len(
set(mro_slots(giveaway_winners))
), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"chat": self.chat.to_dict(),
"giveaway_message_id": self.giveaway_message_id,
"winners_selection_date": to_timestamp(self.winners_selection_date),
"winner_count": self.winner_count,
"winners": [winner.to_dict() for winner in self.winners],
"additional_chat_count": self.additional_chat_count,
"premium_subscription_month_count": self.premium_subscription_month_count,
"unclaimed_prize_count": self.unclaimed_prize_count,
"only_new_members": self.only_new_members,
"was_refunded": self.was_refunded,
"prize_description": self.prize_description,
"prize_star_count": self.prize_star_count,
}
giveaway_winners = GiveawayWinners.de_json(json_dict, offline_bot)
assert giveaway_winners.api_kwargs == {}
assert giveaway_winners.chat == self.chat
assert giveaway_winners.giveaway_message_id == self.giveaway_message_id
assert giveaway_winners.winners_selection_date == self.winners_selection_date
assert giveaway_winners.winner_count == self.winner_count
assert giveaway_winners.winners == tuple(self.winners)
assert giveaway_winners.additional_chat_count == self.additional_chat_count
assert (
giveaway_winners.premium_subscription_month_count
== self.premium_subscription_month_count
)
assert giveaway_winners.unclaimed_prize_count == self.unclaimed_prize_count
assert giveaway_winners.only_new_members == self.only_new_members
assert giveaway_winners.was_refunded == self.was_refunded
assert giveaway_winners.prize_description == self.prize_description
assert giveaway_winners.prize_star_count == self.prize_star_count
def test_de_json_localization(self, tz_bot, offline_bot, raw_bot):
json_dict = {
"chat": self.chat.to_dict(),
"giveaway_message_id": self.giveaway_message_id,
"winners_selection_date": to_timestamp(self.winners_selection_date),
"winner_count": self.winner_count,
"winners": [winner.to_dict() for winner in self.winners],
}
giveaway_winners_raw = GiveawayWinners.de_json(json_dict, raw_bot)
giveaway_winners_bot = GiveawayWinners.de_json(json_dict, offline_bot)
giveaway_winners_bot_tz = GiveawayWinners.de_json(json_dict, tz_bot)
# comparing utcoffsets because comparing timezones is unpredicatable
giveaway_winners_bot_tz_offset = giveaway_winners_bot_tz.winners_selection_date.utcoffset()
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(
giveaway_winners_bot_tz.winners_selection_date.replace(tzinfo=None)
)
assert giveaway_winners_raw.winners_selection_date.tzinfo == UTC
assert giveaway_winners_bot.winners_selection_date.tzinfo == UTC
assert giveaway_winners_bot_tz_offset == tz_bot_offset
def test_to_dict(self, giveaway_winners):
giveaway_winners_dict = giveaway_winners.to_dict()
assert isinstance(giveaway_winners_dict, dict)
assert giveaway_winners_dict["chat"] == self.chat.to_dict()
assert giveaway_winners_dict["giveaway_message_id"] == self.giveaway_message_id
assert giveaway_winners_dict["winners_selection_date"] == to_timestamp(
self.winners_selection_date
)
assert giveaway_winners_dict["winner_count"] == self.winner_count
assert giveaway_winners_dict["winners"] == [winner.to_dict() for winner in self.winners]
assert giveaway_winners_dict["additional_chat_count"] == self.additional_chat_count
assert (
giveaway_winners_dict["premium_subscription_month_count"]
== self.premium_subscription_month_count
)
assert giveaway_winners_dict["unclaimed_prize_count"] == self.unclaimed_prize_count
assert giveaway_winners_dict["only_new_members"] == self.only_new_members
assert giveaway_winners_dict["was_refunded"] == self.was_refunded
assert giveaway_winners_dict["prize_description"] == self.prize_description
assert giveaway_winners_dict["prize_star_count"] == self.prize_star_count
def test_equality(self, giveaway_winners):
a = giveaway_winners
b = GiveawayWinners(
chat=self.chat,
giveaway_message_id=self.giveaway_message_id,
winners_selection_date=self.winners_selection_date,
winner_count=self.winner_count,
winners=self.winners,
)
c = GiveawayWinners(
chat=self.chat,
giveaway_message_id=self.giveaway_message_id,
winners_selection_date=self.winners_selection_date + dtm.timedelta(seconds=100),
winner_count=self.winner_count,
winners=self.winners,
)
d = GiveawayWinners(
chat=self.chat,
giveaway_message_id=self.giveaway_message_id,
winners_selection_date=self.winners_selection_date,
winner_count=17,
winners=self.winners,
)
e = BotCommand("start", "description")
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 giveaway_completed():
return GiveawayCompleted(
winner_count=TestGiveawayCompletedWithoutRequest.winner_count,
unclaimed_prize_count=TestGiveawayCompletedWithoutRequest.unclaimed_prize_count,
giveaway_message=TestGiveawayCompletedWithoutRequest.giveaway_message,
is_star_giveaway=TestGiveawayCompletedWithoutRequest.is_star_giveaway,
)
class TestGiveawayCompletedWithoutRequest:
winner_count = 42
unclaimed_prize_count = 4
is_star_giveaway = True
giveaway_message = Message(
message_id=1,
date=dtm.datetime.now(dtm.timezone.utc),
text="giveaway_message",
chat=Chat(1, Chat.CHANNEL),
from_user=User(1, "user1", False),
)
def test_slot_behaviour(self, giveaway_completed):
for attr in giveaway_completed.__slots__:
assert getattr(giveaway_completed, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(giveaway_completed)) == len(
set(mro_slots(giveaway_completed))
), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"winner_count": self.winner_count,
"unclaimed_prize_count": self.unclaimed_prize_count,
"giveaway_message": self.giveaway_message.to_dict(),
"is_star_giveaway": self.is_star_giveaway,
}
giveaway_completed = GiveawayCompleted.de_json(json_dict, offline_bot)
assert giveaway_completed.api_kwargs == {}
assert giveaway_completed.winner_count == self.winner_count
assert giveaway_completed.unclaimed_prize_count == self.unclaimed_prize_count
assert giveaway_completed.giveaway_message == self.giveaway_message
assert giveaway_completed.is_star_giveaway == self.is_star_giveaway
def test_to_dict(self, giveaway_completed):
giveaway_completed_dict = giveaway_completed.to_dict()
assert isinstance(giveaway_completed_dict, dict)
assert giveaway_completed_dict["winner_count"] == self.winner_count
assert giveaway_completed_dict["unclaimed_prize_count"] == self.unclaimed_prize_count
assert giveaway_completed_dict["giveaway_message"] == self.giveaway_message.to_dict()
assert giveaway_completed_dict["is_star_giveaway"] == self.is_star_giveaway
def test_equality(self, giveaway_completed):
a = giveaway_completed
b = GiveawayCompleted(
winner_count=self.winner_count,
unclaimed_prize_count=self.unclaimed_prize_count,
giveaway_message=self.giveaway_message,
is_star_giveaway=self.is_star_giveaway,
)
c = GiveawayCompleted(
winner_count=self.winner_count + 30,
unclaimed_prize_count=self.unclaimed_prize_count,
)
d = GiveawayCompleted(
winner_count=self.winner_count,
unclaimed_prize_count=17,
giveaway_message=self.giveaway_message,
)
e = GiveawayCompleted(
winner_count=self.winner_count + 1,
unclaimed_prize_count=self.unclaimed_prize_count,
)
f = BotCommand("start", "description")
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)
|