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 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
|
#!/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 (
AffiliateInfo,
Chat,
Gift,
PaidMediaVideo,
RevenueWithdrawalStatePending,
Sticker,
TransactionPartner,
TransactionPartnerAffiliateProgram,
TransactionPartnerChat,
TransactionPartnerFragment,
TransactionPartnerOther,
TransactionPartnerTelegramAds,
TransactionPartnerTelegramApi,
TransactionPartnerUser,
User,
Video,
)
from telegram.constants import TransactionPartnerType
from tests.auxil.slots import mro_slots
@pytest.fixture
def transaction_partner():
return TransactionPartner(TransactionPartnerTestBase.type)
class TransactionPartnerTestBase:
type = TransactionPartnerType.AFFILIATE_PROGRAM
commission_per_mille = 42
sponsor_user = User(
id=1,
is_bot=False,
first_name="sponsor",
last_name="user",
)
withdrawal_state = RevenueWithdrawalStatePending()
user = User(
id=2,
is_bot=False,
first_name="user",
last_name="user",
)
transaction_type = "premium_purchase"
invoice_payload = "invoice_payload"
paid_media = (
PaidMediaVideo(
video=Video(
file_id="file_id",
file_unique_id="file_unique_id",
width=10,
height=10,
duration=10,
)
),
)
paid_media_payload = "paid_media_payload"
subscription_period = dtm.timedelta(days=1)
gift = Gift(
id="gift_id",
sticker=Sticker(
file_id="file_id",
file_unique_id="file_unique_id",
width=10,
height=10,
is_animated=False,
is_video=False,
type="type",
),
total_count=42,
remaining_count=42,
star_count=42,
)
affiliate = AffiliateInfo(
commission_per_mille=42,
amount=42,
)
request_count = 42
chat = Chat(
id=3,
type=Chat.CHANNEL,
)
premium_subscription_duration = 3
class TestTransactionPartnerWithoutRequest(TransactionPartnerTestBase):
def test_slot_behaviour(self, transaction_partner):
inst = transaction_partner
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_type_enum_conversion(self, transaction_partner):
assert type(TransactionPartner("affiliate_program").type) is TransactionPartnerType
assert TransactionPartner("unknown").type == "unknown"
def test_de_json(self, offline_bot):
data = {"type": "unknown"}
transaction_partner = TransactionPartner.de_json(data, offline_bot)
assert transaction_partner.api_kwargs == {}
assert transaction_partner.type == "unknown"
@pytest.mark.parametrize(
("tp_type", "subclass"),
[
("affiliate_program", TransactionPartnerAffiliateProgram),
("fragment", TransactionPartnerFragment),
("user", TransactionPartnerUser),
("telegram_ads", TransactionPartnerTelegramAds),
("telegram_api", TransactionPartnerTelegramApi),
("other", TransactionPartnerOther),
("chat", TransactionPartnerChat),
],
)
def test_subclass(self, offline_bot, tp_type, subclass):
json_dict = {
"type": tp_type,
"commission_per_mille": self.commission_per_mille,
"user": self.user.to_dict(),
"transaction_type": self.transaction_type,
"request_count": self.request_count,
}
tp = TransactionPartner.de_json(json_dict, offline_bot)
assert type(tp) is subclass
assert set(tp.api_kwargs.keys()) == set(json_dict.keys()) - set(subclass.__slots__) - {
"type"
}
assert tp.type == tp_type
def test_to_dict(self, transaction_partner):
data = transaction_partner.to_dict()
assert data == {"type": self.type}
def test_equality(self, transaction_partner):
a = transaction_partner
b = TransactionPartner(self.type)
c = TransactionPartner("unknown")
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a != c
assert hash(a) != hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_affiliate_program():
return TransactionPartnerAffiliateProgram(
commission_per_mille=TransactionPartnerTestBase.commission_per_mille,
sponsor_user=TransactionPartnerTestBase.sponsor_user,
)
class TestTransactionPartnerAffiliateProgramWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.AFFILIATE_PROGRAM
def test_slot_behaviour(self, transaction_partner_affiliate_program):
inst = transaction_partner_affiliate_program
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"commission_per_mille": self.commission_per_mille,
"sponsor_user": self.sponsor_user.to_dict(),
}
tp = TransactionPartnerAffiliateProgram.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "affiliate_program"
assert tp.commission_per_mille == self.commission_per_mille
assert tp.sponsor_user == self.sponsor_user
def test_to_dict(self, transaction_partner_affiliate_program):
json_dict = transaction_partner_affiliate_program.to_dict()
assert json_dict["type"] == self.type
assert json_dict["commission_per_mille"] == self.commission_per_mille
assert json_dict["sponsor_user"] == self.sponsor_user.to_dict()
def test_equality(self, transaction_partner_affiliate_program):
a = transaction_partner_affiliate_program
b = TransactionPartnerAffiliateProgram(
commission_per_mille=self.commission_per_mille,
)
c = TransactionPartnerAffiliateProgram(
commission_per_mille=0,
)
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a != c
assert hash(a) != hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_fragment():
return TransactionPartnerFragment(
withdrawal_state=TransactionPartnerTestBase.withdrawal_state,
)
class TestTransactionPartnerFragmentWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.FRAGMENT
def test_slot_behaviour(self, transaction_partner_fragment):
inst = transaction_partner_fragment
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {"withdrawal_state": self.withdrawal_state.to_dict()}
tp = TransactionPartnerFragment.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "fragment"
assert tp.withdrawal_state == self.withdrawal_state
def test_to_dict(self, transaction_partner_fragment):
json_dict = transaction_partner_fragment.to_dict()
assert json_dict["type"] == self.type
assert json_dict["withdrawal_state"] == self.withdrawal_state.to_dict()
def test_equality(self, transaction_partner_fragment):
a = transaction_partner_fragment
b = TransactionPartnerFragment(withdrawal_state=self.withdrawal_state)
c = TransactionPartnerFragment(withdrawal_state=None)
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a == c
assert hash(a) == hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_user():
return TransactionPartnerUser(
transaction_type=TransactionPartnerTestBase.transaction_type,
user=TransactionPartnerTestBase.user,
invoice_payload=TransactionPartnerTestBase.invoice_payload,
paid_media=TransactionPartnerTestBase.paid_media,
paid_media_payload=TransactionPartnerTestBase.paid_media_payload,
subscription_period=TransactionPartnerTestBase.subscription_period,
premium_subscription_duration=TransactionPartnerTestBase.premium_subscription_duration,
)
class TestTransactionPartnerUserWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.USER
def test_slot_behaviour(self, transaction_partner_user):
inst = transaction_partner_user
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"user": self.user.to_dict(),
"transaction_type": self.transaction_type,
"invoice_payload": self.invoice_payload,
"paid_media": [pm.to_dict() for pm in self.paid_media],
"paid_media_payload": self.paid_media_payload,
"subscription_period": self.subscription_period.total_seconds(),
"premium_subscription_duration": self.premium_subscription_duration,
}
tp = TransactionPartnerUser.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "user"
assert tp.user == self.user
assert tp.transaction_type == self.transaction_type
assert tp.invoice_payload == self.invoice_payload
assert tp.paid_media == self.paid_media
assert tp.paid_media_payload == self.paid_media_payload
assert tp.subscription_period == self.subscription_period
assert tp.premium_subscription_duration == self.premium_subscription_duration
def test_to_dict(self, transaction_partner_user):
json_dict = transaction_partner_user.to_dict()
assert json_dict["type"] == self.type
assert json_dict["transaction_type"] == self.transaction_type
assert json_dict["user"] == self.user.to_dict()
assert json_dict["invoice_payload"] == self.invoice_payload
assert json_dict["paid_media"] == [pm.to_dict() for pm in self.paid_media]
assert json_dict["paid_media_payload"] == self.paid_media_payload
assert json_dict["subscription_period"] == self.subscription_period.total_seconds()
assert json_dict["premium_subscription_duration"] == self.premium_subscription_duration
def test_equality(self, transaction_partner_user):
a = transaction_partner_user
b = TransactionPartnerUser(
transaction_type=self.transaction_type,
user=self.user,
)
c = TransactionPartnerUser(
transaction_type=self.transaction_type,
user=User(id=1, is_bot=False, first_name="user", last_name="user"),
)
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a != c
assert hash(a) != hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_other():
return TransactionPartnerOther()
class TestTransactionPartnerOtherWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.OTHER
def test_slot_behaviour(self, transaction_partner_other):
inst = transaction_partner_other
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {}
tp = TransactionPartnerOther.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "other"
def test_to_dict(self, transaction_partner_other):
json_dict = transaction_partner_other.to_dict()
assert json_dict == {"type": self.type}
def test_equality(self, transaction_partner_other):
a = transaction_partner_other
b = TransactionPartnerOther()
c = TransactionPartnerOther()
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a == c
assert hash(a) == hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_telegram_ads():
return TransactionPartnerTelegramAds()
class TestTransactionPartnerTelegramAdsWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.TELEGRAM_ADS
def test_slot_behaviour(self, transaction_partner_telegram_ads):
inst = transaction_partner_telegram_ads
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {}
tp = TransactionPartnerTelegramAds.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "telegram_ads"
def test_to_dict(self, transaction_partner_telegram_ads):
json_dict = transaction_partner_telegram_ads.to_dict()
assert json_dict == {"type": self.type}
def test_equality(self, transaction_partner_telegram_ads):
a = transaction_partner_telegram_ads
b = TransactionPartnerTelegramAds()
c = TransactionPartnerTelegramAds()
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a == c
assert hash(a) == hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_telegram_api():
return TransactionPartnerTelegramApi(
request_count=TransactionPartnerTestBase.request_count,
)
class TestTransactionPartnerTelegramApiWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.TELEGRAM_API
def test_slot_behaviour(self, transaction_partner_telegram_api):
inst = transaction_partner_telegram_api
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {"request_count": self.request_count}
tp = TransactionPartnerTelegramApi.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "telegram_api"
assert tp.request_count == self.request_count
def test_to_dict(self, transaction_partner_telegram_api):
json_dict = transaction_partner_telegram_api.to_dict()
assert json_dict["type"] == self.type
assert json_dict["request_count"] == self.request_count
def test_equality(self, transaction_partner_telegram_api):
a = transaction_partner_telegram_api
b = TransactionPartnerTelegramApi(
request_count=self.request_count,
)
c = TransactionPartnerTelegramApi(
request_count=0,
)
d = User(id=1, is_bot=False, first_name="user", last_name="user")
assert a == b
assert hash(a) == hash(b)
assert a != c
assert hash(a) != hash(c)
assert a != d
assert hash(a) != hash(d)
@pytest.fixture
def transaction_partner_chat():
return TransactionPartnerChat(
chat=TransactionPartnerTestBase.chat,
gift=TransactionPartnerTestBase.gift,
)
class TestTransactionPartnerChatWithoutRequest(TransactionPartnerTestBase):
type = TransactionPartnerType.CHAT
def test_slot_behaviour(self, transaction_partner_chat):
inst = transaction_partner_chat
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"chat": self.chat.to_dict(),
"gift": self.gift.to_dict(),
}
tp = TransactionPartnerChat.de_json(json_dict, offline_bot)
assert tp.api_kwargs == {}
assert tp.type == "chat"
assert tp.chat == self.chat
assert tp.gift == self.gift
def test_to_dict(self, transaction_partner_chat):
json_dict = transaction_partner_chat.to_dict()
assert json_dict["type"] == self.type
assert json_dict["chat"] == self.chat.to_dict()
assert json_dict["gift"] == self.gift.to_dict()
def test_equality(self, transaction_partner_chat):
a = transaction_partner_chat
b = TransactionPartnerChat(
chat=self.chat,
gift=self.gift,
)
c = TransactionPartnerChat(
chat=Chat(id=1, type=Chat.CHANNEL),
)
d = Chat(id=1, type=Chat.CHANNEL)
assert a == b
assert hash(a) == hash(b)
assert a != c
assert hash(a) != hash(c)
assert a != d
assert hash(a) != hash(d)
|