mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 01:46:22 +02:00
55e3ecf9f8
* First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * First take on 4.6 support * improved docs * Minor doc formattings * added poll and poll_answer to filters * added tests, fixed mentioned issues * added poll_answer + poll filter tests * Update docs according to official API docs * introducing pollhandler and pollanswerhandler * correct_option_id validated with None when trying to send a poll with correct option id 0 it was failing. Now None check is done so that even when 0 is passed it is assigned. * improving example * improving code * adding poll filter example to the pollbot.py * Update Readme * simplify pollbot.py and add some comments * add tests for Poll(Answer)Handler * We just want Filters.poll, not Filters.update.poll * Make test_official fail again * Handle ME.language in M._parse_* Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de> Co-authored-by: Sharun Kumar <715417+sharunkumar@users.noreply.github.com>
298 lines
9.9 KiB
Python
298 lines
9.9 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-2020
|
|
# 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 an object that represents a Telegram User."""
|
|
|
|
from telegram import TelegramObject
|
|
from telegram.utils.helpers import mention_html as util_mention_html
|
|
from telegram.utils.helpers import mention_markdown as util_mention_markdown
|
|
|
|
|
|
class User(TelegramObject):
|
|
"""This object represents a Telegram user or bot.
|
|
|
|
Attributes:
|
|
id (:obj:`int`): Unique identifier for this user or bot.
|
|
is_bot (:obj:`bool`): True, if this user is a bot
|
|
first_name (:obj:`str`): User's or bot's first name.
|
|
last_name (:obj:`str`): Optional. User's or bot's last name.
|
|
username (:obj:`str`): Optional. User's or bot's username.
|
|
language_code (:obj:`str`): Optional. IETF language tag of the user's language.
|
|
can_join_groups (:obj:`str`): Optional. True, if the bot can be invited to groups.
|
|
Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
can_read_all_group_messages (:obj:`str`): Optional. True, if privacy mode is disabled
|
|
for the bot. Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
supports_inline_queries (:obj:`str`): Optional. True, if the bot supports inline queries.
|
|
Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
|
|
|
|
Args:
|
|
id (:obj:`int`): Unique identifier for this user or bot.
|
|
is_bot (:obj:`bool`): True, if this user is a bot
|
|
first_name (:obj:`str`): User's or bot's first name.
|
|
last_name (:obj:`str`, optional): User's or bot's last name.
|
|
username (:obj:`str`, optional): User's or bot's username.
|
|
language_code (:obj:`str`, optional): IETF language tag of the user's language.
|
|
can_join_groups (:obj:`str`, optional): True, if the bot can be invited to groups.
|
|
Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
can_read_all_group_messages (:obj:`str`, optional): True, if privacy mode is disabled
|
|
for the bot. Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
supports_inline_queries (:obj:`str`, optional): True, if the bot supports inline queries.
|
|
Returned only in :attr:`telegram.Bot.get_me` requests.
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
id,
|
|
first_name,
|
|
is_bot,
|
|
last_name=None,
|
|
username=None,
|
|
language_code=None,
|
|
can_join_groups=None,
|
|
can_read_all_group_messages=None,
|
|
supports_inline_queries=None,
|
|
bot=None,
|
|
**kwargs):
|
|
# Required
|
|
self.id = int(id)
|
|
self.first_name = first_name
|
|
self.is_bot = is_bot
|
|
# Optionals
|
|
self.last_name = last_name
|
|
self.username = username
|
|
self.language_code = language_code
|
|
self.can_join_groups = can_join_groups
|
|
self.can_read_all_group_messages = can_read_all_group_messages
|
|
self.supports_inline_queries = supports_inline_queries
|
|
self.bot = bot
|
|
|
|
self._id_attrs = (self.id,)
|
|
|
|
@property
|
|
def name(self):
|
|
""":obj:`str`: Convenience property. If available, returns the user's :attr:`username`
|
|
prefixed with "@". If :attr:`username` is not available, returns :attr:`full_name`."""
|
|
if self.username:
|
|
return '@{}'.format(self.username)
|
|
return self.full_name
|
|
|
|
@property
|
|
def full_name(self):
|
|
""":obj:`str`: Convenience property. The user's :attr:`first_name`, followed by (if
|
|
available) :attr:`last_name`."""
|
|
|
|
if self.last_name:
|
|
return u'{} {}'.format(self.first_name, self.last_name)
|
|
return self.first_name
|
|
|
|
@property
|
|
def link(self):
|
|
""":obj:`str`: Convenience property. If :attr:`username` is available, returns a t.me link
|
|
of the user."""
|
|
|
|
if self.username:
|
|
return "https://t.me/{}".format(self.username)
|
|
return None
|
|
|
|
@classmethod
|
|
def de_json(cls, data, bot):
|
|
if not data:
|
|
return None
|
|
data = super(User, cls).de_json(data, bot)
|
|
|
|
return cls(bot=bot, **data)
|
|
|
|
def get_profile_photos(self, *args, **kwargs):
|
|
"""
|
|
Shortcut for::
|
|
|
|
bot.get_user_profile_photos(update.message.from_user.id, *args, **kwargs)
|
|
|
|
"""
|
|
|
|
return self.bot.get_user_profile_photos(self.id, *args, **kwargs)
|
|
|
|
@classmethod
|
|
def de_list(cls, data, bot):
|
|
if not data:
|
|
return []
|
|
|
|
users = list()
|
|
for user in data:
|
|
users.append(cls.de_json(user, bot))
|
|
|
|
return users
|
|
|
|
def mention_markdown(self, name=None):
|
|
"""
|
|
Args:
|
|
name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`.
|
|
|
|
Returns:
|
|
:obj:`str`: The inline mention for the user as markdown (version 1).
|
|
|
|
"""
|
|
if name:
|
|
return util_mention_markdown(self.id, name)
|
|
return util_mention_markdown(self.id, self.full_name)
|
|
|
|
def mention_markdown_v2(self, name=None):
|
|
"""
|
|
Args:
|
|
name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`.
|
|
|
|
Returns:
|
|
:obj:`str`: The inline mention for the user as markdown (version 2).
|
|
|
|
"""
|
|
if name:
|
|
return util_mention_markdown(self.id, name, version=2)
|
|
return util_mention_markdown(self.id, self.full_name, version=2)
|
|
|
|
def mention_html(self, name=None):
|
|
"""
|
|
Args:
|
|
name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`.
|
|
|
|
Returns:
|
|
:obj:`str`: The inline mention for the user as HTML.
|
|
|
|
"""
|
|
if name:
|
|
return util_mention_html(self.id, name)
|
|
return util_mention_html(self.id, self.full_name)
|
|
|
|
def send_message(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_message(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_message(self.id, *args, **kwargs)
|
|
|
|
def send_photo(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_photo(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_photo(self.id, *args, **kwargs)
|
|
|
|
def send_audio(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_audio(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_audio(self.id, *args, **kwargs)
|
|
|
|
def send_document(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_document(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_document(self.id, *args, **kwargs)
|
|
|
|
def send_animation(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_animation(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_animation(self.id, *args, **kwargs)
|
|
|
|
def send_sticker(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_sticker(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_sticker(self.id, *args, **kwargs)
|
|
|
|
def send_video(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_video(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_video(self.id, *args, **kwargs)
|
|
|
|
def send_video_note(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_video_note(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_video_note(self.id, *args, **kwargs)
|
|
|
|
def send_voice(self, *args, **kwargs):
|
|
"""Shortcut for::
|
|
|
|
bot.send_voice(User.id, *args, **kwargs)
|
|
|
|
Where User is the current instance.
|
|
|
|
Returns:
|
|
:class:`telegram.Message`: On success, instance representing the message posted.
|
|
|
|
"""
|
|
return self.bot.send_voice(self.id, *args, **kwargs)
|