mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-26 00:56:22 +01:00
93 lines
2.5 KiB
Python
93 lines
2.5 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015 Leandro Toledo de Souza <leandrotoeldodesouza@gmail.com>
|
|
#
|
|
# 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 Contact"""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class Contact(TelegramObject):
|
|
"""This object represents a Telegram Contact.
|
|
|
|
Attributes:
|
|
phone_number (str):
|
|
first_name (str):
|
|
last_name (str):
|
|
user_id (int):
|
|
|
|
Args:
|
|
phone_number (str):
|
|
first_name (str):
|
|
**kwargs: Arbitrary keyword arguments.
|
|
|
|
Keyword Args:
|
|
last_name (Optional[str]):
|
|
user_id (Optional[int]):
|
|
"""
|
|
|
|
def __init__(self,
|
|
phone_number,
|
|
first_name,
|
|
**kwargs):
|
|
# Required
|
|
self.phone_number = phone_number
|
|
self.first_name = first_name
|
|
# Optionals
|
|
self.last_name = kwargs.get('last_name', '')
|
|
self.user_id = int(kwargs.get('user_id', 0))
|
|
|
|
@staticmethod
|
|
def de_json(data):
|
|
"""
|
|
Args:
|
|
data (str):
|
|
|
|
Returns:
|
|
telegram.Contact:
|
|
"""
|
|
if not data:
|
|
return None
|
|
|
|
contact = dict()
|
|
|
|
# Required
|
|
contact['phone_number'] = data['phone_number']
|
|
contact['first_name'] = data['first_name']
|
|
# Optionals
|
|
contact['last_name'] = data.get('last_name')
|
|
contact['user_id'] = data.get('user_id', 0)
|
|
|
|
return Contact(**contact)
|
|
|
|
def to_dict(self):
|
|
"""
|
|
Returns:
|
|
dict:
|
|
"""
|
|
data = dict()
|
|
|
|
# Required
|
|
data['phone_number'] = self.phone_number
|
|
data['first_name'] = self.first_name
|
|
# Optionals
|
|
if self.last_name:
|
|
data['last_name'] = self.last_name
|
|
if self.user_id:
|
|
data['user_id'] = self.user_id
|
|
|
|
return data
|