mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 01:46:22 +02:00
e367b8519d
While not stickily necessary for most classes (since user isn't directly creating them) it still unifies our approach. However for some like ReplyKeyboardHide where users are making the classes themselves it should improve IDE autocomplete support.
112 lines
3.8 KiB
Python
112 lines
3.8 KiB
Python
#!/usr/bin/env python
|
|
# pylint: disable=C0103,W0622
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2016
|
|
# 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/].
|
|
"""This module contains a object that represents a Telegram Chat."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class Chat(TelegramObject):
|
|
"""This object represents a Telegram Chat.
|
|
|
|
Attributes:
|
|
id (int):
|
|
type (str): Can be 'private', 'group', 'supergroup' or 'channel'
|
|
title (str): Title, for channels and group chats
|
|
username (str): Username, for private chats and channels if available
|
|
first_name (str): First name of the other party in a private chat
|
|
last_name (str): Last name of the other party in a private chat
|
|
|
|
Args:
|
|
id (int):
|
|
type (str):
|
|
**kwargs: Arbitrary keyword arguments.
|
|
|
|
Keyword Args:
|
|
type (Optional[str]):
|
|
bot (Optional[Bot]): The Bot to use for instance methods
|
|
"""
|
|
|
|
PRIVATE = 'private'
|
|
GROUP = 'group'
|
|
SUPERGROUP = 'supergroup'
|
|
CHANNEL = 'channel'
|
|
|
|
def __init__(self,
|
|
id,
|
|
type,
|
|
title='',
|
|
username='',
|
|
first_name='',
|
|
last_name='',
|
|
bot=None,
|
|
**kwargs):
|
|
# Required
|
|
self.id = int(id)
|
|
self.type = type
|
|
# Optionals
|
|
self.title = title
|
|
self.username = username
|
|
self.first_name = first_name
|
|
self.last_name = last_name
|
|
|
|
self.bot = bot
|
|
|
|
@staticmethod
|
|
def de_json(data, bot):
|
|
"""
|
|
Args:
|
|
data (dict):
|
|
bot (telegram.Bot):
|
|
|
|
Returns:
|
|
telegram.Chat:
|
|
"""
|
|
if not data:
|
|
return None
|
|
|
|
return Chat(bot=bot, **data)
|
|
|
|
def send_action(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.sendChatAction(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.sendChatAction(self.id, *args, **kwargs)
|
|
|
|
def leave(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.leaveChat(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.leaveChat(self.id, *args, **kwargs)
|
|
|
|
def get_administrators(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.getChatAdministrators(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.getChatAdministrators(self.id, *args, **kwargs)
|
|
|
|
def get_members_count(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.getChatMembersCount(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.getChatMembersCount(self.id, *args, **kwargs)
|
|
|
|
def get_member(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.getChatMember(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.getChatMember(self.id, *args, **kwargs)
|
|
|
|
def kick_member(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.kickChatMember(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.kickChatMember(self.id, *args, **kwargs)
|
|
|
|
def unban_member(self, *args, **kwargs):
|
|
"""Shortcut for ``bot.unbanChatMember(update.message.chat.id, *args, **kwargs)``"""
|
|
return self.bot.unbanChatMember(self.id, *args, **kwargs)
|