forked from python-telegram-bot/python-telegram-bot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuser.py
More file actions
107 lines (87 loc) · 3.44 KB
/
user.py
File metadata and controls
107 lines (87 loc) · 3.44 KB
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
#!/usr/bin/env python
# pylint: disable=C0103,W0622
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2017
# 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
class User(TelegramObject):
"""
This object represents a Telegram user or bot.
Attributes:
id (:obj:`int`): Unique identifier for this user or 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 last name.
language_code (:obj:`str`): Optional. IETF language tag of the user's language.
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
Args:
id (:obj:`int`): Unique identifier for this user or 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.
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
"""
def __init__(self,
id,
first_name,
last_name=None,
username=None,
language_code=None,
bot=None,
**kwargs):
# Required
self.id = int(id)
self.first_name = first_name
# Optionals
self.last_name = last_name
self.username = username
self.language_code = language_code
self.bot = bot
self._id_attrs = (self.id,)
@property
def name(self):
"""
:obj:`str`: The users :attr:`username` if available, if not it returns the first name and
if present :attr:`first_name` and :attr:`last_name`.
"""
if self.username:
return '@%s' % self.username
if self.last_name:
return '%s %s' % (self.first_name, self.last_name)
return self.first_name
@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