OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2025-01-03 09:49:21 +01:00
Code Issues Projects Releases Packages Wiki Activity

Convenience Functionality for ChatInviteLinks (#2782)

Browse source
This commit is contained in:
Bibo-Joshi 2021-11-29 20:32:26 +01:00 committed by Hinrich Mahler
parent 9b56be44b4
commit de85eec674
5 changed files with 62 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
telegram/_bot.py
View file

@ -4096,13 +4096,15 @@ class Bot(TelegramObject):
For timezone naive :obj:`datetime.datetime` objects, the default timezone of the
bot will be used.
member_limit (:obj:`int`, optional): Maximum number of users that can be members of
the chat simultaneously after joining the chat via this invite link; 1-99999.
the chat simultaneously after joining the chat via this invite link;
1-:tg-const:`telegram.constants.ChatInviteLinkLimit.MEMBER_LIMIT`.
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
the read timeout from the server (instead of the one specified during creation of
the connection pool).
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
Telegram API.
name (:obj:`str`, optional): Invite link name; 0-32 characters.
name (:obj:`str`, optional): Invite link name;
0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters.
.. versionadded:: 13.8
creates_join_request (:obj:`bool`, optional): :obj:`True`, if users joining the chat
@ -4147,7 +4149,7 @@ class Bot(TelegramObject):
def edit_chat_invite_link(
self,
chat_id: Union[str, int],
invite_link: str,
invite_link: Union[str, 'ChatInviteLink'],
expire_date: Union[int, datetime] = None,
member_limit: int = None,
timeout: ODVInput[float] = DEFAULT_NONE,
@ -4170,19 +4172,24 @@ class Bot(TelegramObject):
Args:
chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username
of the target channel (in the format ``@channelusername``).
invite_link (:obj:`str`): The invite link to edit.
invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit.
.. versionchanged:: 14.0
Now also accepts :obj:`telegram.ChatInviteLink` instances.
expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will
expire.
For timezone naive :obj:`datetime.datetime` objects, the default timezone of the
bot will be used.
member_limit (:obj:`int`, optional): Maximum number of users that can be members of
the chat simultaneously after joining the chat via this invite link; 1-99999.
the chat simultaneously after joining the chat via this invite link;
1-:tg-const:`telegram.constants.ChatInviteLinkLimit.MEMBER_LIMIT`.
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
the read timeout from the server (instead of the one specified during creation of
the connection pool).
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
Telegram API.
name (:obj:`str`, optional): Invite link name; 0-32 characters.
name (:obj:`str`, optional): Invite link name;
0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters.
.. versionadded:: 13.8
creates_join_request (:obj:`bool`, optional): :obj:`True`, if users joining the chat
@ -4203,7 +4210,8 @@ class Bot(TelegramObject):
"If `creates_join_request` is `True`, `member_limit` can't be specified."
)
data: JSONDict = {'chat_id': chat_id, 'invite_link': invite_link}
link = invite_link.invite_link if isinstance(invite_link, ChatInviteLink) else invite_link
data: JSONDict = {'chat_id': chat_id, 'invite_link': link}
if expire_date is not None:
data['expire_date'] = expire_date
@ -4225,7 +4233,7 @@ class Bot(TelegramObject):
def revoke_chat_invite_link(
self,
chat_id: Union[str, int],
invite_link: str,
invite_link: Union[str, 'ChatInviteLink'],
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
) -> ChatInviteLink:
@ -4239,7 +4247,10 @@ class Bot(TelegramObject):
Args:
chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username
of the target channel (in the format ``@channelusername``).
invite_link (:obj:`str`): The invite link to edit.
invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to revoke.
.. versionchanged:: 14.0
Now also accepts :obj:`telegram.ChatInviteLink` instances.
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
the read timeout from the server (instead of the one specified during creation of
the connection pool).
@ -4253,7 +4264,8 @@ class Bot(TelegramObject):
:class:`telegram.error.TelegramError`
"""
data: JSONDict = {'chat_id': chat_id, 'invite_link': invite_link}
link = invite_link.invite_link if isinstance(invite_link, ChatInviteLink) else invite_link
data: JSONDict = {'chat_id': chat_id, 'invite_link': link}
result = self._post('revokeChatInviteLink', data, timeout=timeout, api_kwargs=api_kwargs)

4
telegram/_chat.py
View file

@ -1663,7 +1663,7 @@ class Chat(TelegramObject):
def edit_invite_link(
self,
invite_link: str,
invite_link: Union[str, 'ChatInviteLink'],
expire_date: Union[int, datetime] = None,
member_limit: int = None,
timeout: ODVInput[float] = DEFAULT_NONE,
@ -1700,7 +1700,7 @@ class Chat(TelegramObject):
def revoke_invite_link(
self,
invite_link: str,
invite_link: Union[str, 'ChatInviteLink'],
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
) -> 'ChatInviteLink':

4
telegram/_chatinvitelink.py
View file

@ -54,8 +54,10 @@ class ChatInviteLink(TelegramObject):
expire_date (:class:`datetime.datetime`, optional): Date when the link will expire or
has been expired.
member_limit (:obj:`int`, optional): Maximum number of users that can be members of the
chat simultaneously after joining the chat via this invite link; 1-99999.
chat simultaneously after joining the chat via this invite link;
1-:tg-const:`telegram.constants.ChatInviteLinkLimit.MEMBER_LIMIT`.
name (:obj:`str`, optional): Invite link name.
0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters.
.. versionadded:: 13.8
pending_join_request_count (:obj:`int`, optional): Number of pending join requests

19
telegram/constants.py
View file

@ -43,6 +43,7 @@ __all__ = [
'CallbackQueryLimit',
'ChatAction',
'ChatID',
'ChatInviteLinkLimit',
'ChatMemberStatus',
'ChatType',
'DiceEmoji',
@ -191,6 +192,24 @@ class ChatID(IntEnum):
"""
class ChatInviteLinkLimit(IntEnum):
"""This enum contains limitations for :class:`telegram.ChatInviteLink`/
:meth:`telegram.Bot.create_chat_invite_link`/:meth:`telegram.Bot.edit_chat_invite_link`. The
enum members of this enumeration are instances of :class:`int` and can be treated as such.
.. versionadded:: 14.0
"""
__slots__ = ()
MEMBER_LIMIT = 99999
""":obj:`int`: Maximum value allowed for the ``member_limit`` parameter of
:meth:`telegram.Bot.create_chat_invite_link` and :meth:`telegram.Bot.edit_chat_invite_link`."""
NAME_LENGTH = 32
""":obj:`int`: Maximum number of characters allowed for the ``name`` parameter of
:meth:`telegram.Bot.create_chat_invite_link` and :meth:`telegram.Bot.edit_chat_invite_link`."""
class ChatMemberStatus(_StringEnum):
"""This enum contains the available states for :class:`telegram.ChatMember`. The enum
members of this enumeration are instances of :class:`str` and can be treated as such.

16
tests/test_bot.py
View file

@ -1787,6 +1787,22 @@ class TestBot:
with pytest.raises(ValueError, match="`member_limit` can't be specified"):
bot.edit_chat_invite_link(**data)
@flaky(3, 1)
def test_edit_revoke_chat_invite_link_passing_link_objects(self, bot, channel_id):
invite_link = bot.create_chat_invite_link(chat_id=channel_id)
assert invite_link.name is None
edited_link = bot.edit_chat_invite_link(
chat_id=channel_id, invite_link=invite_link, name='some_name'
)
assert edited_link == invite_link
assert edited_link.name == 'some_name'
revoked_link = bot.revoke_chat_invite_link(chat_id=channel_id, invite_link=edited_link)
assert revoked_link.invite_link == edited_link.invite_link
assert revoked_link.is_revoked is True
assert revoked_link.name == 'some_name'
@flaky(3, 1)
@pytest.mark.parametrize('creates_join_request', [True, False])
@pytest.mark.parametrize('name', [None, 'name'])