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
|
#!/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 ChatInviteLink, User
from telegram._utils.datetime import UTC, to_timestamp
from telegram.warnings import PTBDeprecationWarning
from tests.auxil.slots import mro_slots
@pytest.fixture(scope="module")
def creator():
return User(1, "First name", False)
@pytest.fixture(scope="module")
def invite_link(creator):
return ChatInviteLink(
ChatInviteLinkTestBase.link,
creator,
ChatInviteLinkTestBase.creates_join_request,
ChatInviteLinkTestBase.primary,
ChatInviteLinkTestBase.revoked,
expire_date=ChatInviteLinkTestBase.expire_date,
member_limit=ChatInviteLinkTestBase.member_limit,
name=ChatInviteLinkTestBase.name,
pending_join_request_count=ChatInviteLinkTestBase.pending_join_request_count,
subscription_period=ChatInviteLinkTestBase.subscription_period,
subscription_price=ChatInviteLinkTestBase.subscription_price,
)
class ChatInviteLinkTestBase:
link = "thisialink"
creates_join_request = False
primary = True
revoked = False
expire_date = dtm.datetime.now(dtm.timezone.utc)
member_limit = 42
name = "LinkName"
pending_join_request_count = 42
subscription_period = dtm.timedelta(seconds=43)
subscription_price = 44
class TestChatInviteLinkWithoutRequest(ChatInviteLinkTestBase):
def test_slot_behaviour(self, invite_link):
for attr in invite_link.__slots__:
assert getattr(invite_link, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(invite_link)) == len(set(mro_slots(invite_link))), "duplicate slot"
def test_de_json_required_args(self, offline_bot, creator):
json_dict = {
"invite_link": self.link,
"creator": creator.to_dict(),
"creates_join_request": self.creates_join_request,
"is_primary": self.primary,
"is_revoked": self.revoked,
}
invite_link = ChatInviteLink.de_json(json_dict, offline_bot)
assert invite_link.api_kwargs == {}
assert invite_link.invite_link == self.link
assert invite_link.creator == creator
assert invite_link.creates_join_request == self.creates_join_request
assert invite_link.is_primary == self.primary
assert invite_link.is_revoked == self.revoked
def test_de_json_all_args(self, offline_bot, creator):
json_dict = {
"invite_link": self.link,
"creator": creator.to_dict(),
"creates_join_request": self.creates_join_request,
"is_primary": self.primary,
"is_revoked": self.revoked,
"expire_date": to_timestamp(self.expire_date),
"member_limit": self.member_limit,
"name": self.name,
"pending_join_request_count": str(self.pending_join_request_count),
"subscription_period": int(self.subscription_period.total_seconds()),
"subscription_price": self.subscription_price,
}
invite_link = ChatInviteLink.de_json(json_dict, offline_bot)
assert invite_link.api_kwargs == {}
assert invite_link.invite_link == self.link
assert invite_link.creator == creator
assert invite_link.creates_join_request == self.creates_join_request
assert invite_link.is_primary == self.primary
assert invite_link.is_revoked == self.revoked
assert abs(invite_link.expire_date - self.expire_date) < dtm.timedelta(seconds=1)
assert to_timestamp(invite_link.expire_date) == to_timestamp(self.expire_date)
assert invite_link.member_limit == self.member_limit
assert invite_link.name == self.name
assert invite_link.pending_join_request_count == self.pending_join_request_count
assert invite_link._subscription_period == self.subscription_period
assert invite_link.subscription_price == self.subscription_price
def test_de_json_localization(self, tz_bot, offline_bot, raw_bot, creator):
json_dict = {
"invite_link": self.link,
"creator": creator.to_dict(),
"creates_join_request": self.creates_join_request,
"is_primary": self.primary,
"is_revoked": self.revoked,
"expire_date": to_timestamp(self.expire_date),
"member_limit": self.member_limit,
"name": self.name,
"pending_join_request_count": str(self.pending_join_request_count),
}
invite_link_raw = ChatInviteLink.de_json(json_dict, raw_bot)
invite_link_bot = ChatInviteLink.de_json(json_dict, offline_bot)
invite_link_tz = ChatInviteLink.de_json(json_dict, tz_bot)
# comparing utcoffsets because comparing timezones is unpredicatable
invite_offset = invite_link_tz.expire_date.utcoffset()
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(
invite_link_tz.expire_date.replace(tzinfo=None)
)
assert invite_link_raw.expire_date.tzinfo == UTC
assert invite_link_bot.expire_date.tzinfo == UTC
assert invite_offset == tz_bot_offset
def test_to_dict(self, invite_link):
invite_link_dict = invite_link.to_dict()
assert isinstance(invite_link_dict, dict)
assert invite_link_dict["creator"] == invite_link.creator.to_dict()
assert invite_link_dict["invite_link"] == invite_link.invite_link
assert invite_link_dict["creates_join_request"] == invite_link.creates_join_request
assert invite_link_dict["is_primary"] == self.primary
assert invite_link_dict["is_revoked"] == self.revoked
assert invite_link_dict["expire_date"] == to_timestamp(self.expire_date)
assert invite_link_dict["member_limit"] == self.member_limit
assert invite_link_dict["name"] == self.name
assert invite_link_dict["pending_join_request_count"] == self.pending_join_request_count
assert invite_link_dict["subscription_period"] == int(
self.subscription_period.total_seconds()
)
assert isinstance(invite_link_dict["subscription_period"], int)
assert invite_link_dict["subscription_price"] == self.subscription_price
def test_time_period_properties(self, PTB_TIMEDELTA, invite_link):
if PTB_TIMEDELTA:
assert invite_link.subscription_period == self.subscription_period
assert isinstance(invite_link.subscription_period, dtm.timedelta)
else:
assert invite_link.subscription_period == int(self.subscription_period.total_seconds())
assert isinstance(invite_link.subscription_period, int)
def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, invite_link):
invite_link.subscription_period
if PTB_TIMEDELTA:
assert len(recwarn) == 0
else:
assert len(recwarn) == 1
assert "`subscription_period` will be of type `datetime.timedelta`" in str(
recwarn[0].message
)
assert recwarn[0].category is PTBDeprecationWarning
def test_equality(self):
a = ChatInviteLink("link", User(1, "", False), True, True, True)
b = ChatInviteLink("link", User(1, "", False), True, True, True)
c = ChatInviteLink("link", User(2, "", False), True, True, True)
d1 = ChatInviteLink("link", User(1, "", False), False, True, True)
d2 = ChatInviteLink("link", User(1, "", False), True, False, True)
d3 = ChatInviteLink("link", User(1, "", False), True, True, False)
e = ChatInviteLink("notalink", User(1, "", False), True, False, True)
f = ChatInviteLink("notalink", User(1, "", False), True, True, True)
g = User(1, "", False)
assert a == b
assert hash(a) == hash(b)
assert a is not b
assert a != c
assert hash(a) != hash(c)
assert a != d1
assert hash(a) != hash(d1)
assert a != d2
assert hash(a) != hash(d2)
assert d2 != d3
assert hash(d2) != hash(d3)
assert a != e
assert hash(a) != hash(e)
assert a != f
assert hash(a) != hash(f)
assert a != g
assert hash(a) != hash(g)
|