python-telegram-bot/telegram/choseninlineresult.py

99 lines
2.8 KiB
Python
Raw Normal View History

2016-01-04 17:31:06 +01:00
#!/usr/bin/env python
# pylint: disable=R0902,R0912,R0913
#
# 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>
2016-01-04 17:31:06 +01:00
#
# 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/].
"""
2016-10-17 00:22:40 +02:00
This module contains an object that represents a Telegram ChosenInlineResult
2016-01-04 17:31:06 +01:00
"""
2016-04-14 07:21:00 +02:00
from telegram import TelegramObject, User, Location
2016-01-04 17:31:06 +01:00
class ChosenInlineResult(TelegramObject):
"""This object represents a Telegram ChosenInlineResult.
Note:
* In Python `from` is a reserved word, use `from_user` instead.
Attributes:
2016-02-07 23:34:26 +01:00
result_id (str):
2016-01-04 17:31:06 +01:00
from_user (:class:`telegram.User`):
query (str):
location (:class:`telegram.Location`):
inline_message_id (str):
2016-01-04 17:31:06 +01:00
Args:
2016-02-07 23:34:26 +01:00
result_id (str):
2016-01-04 17:31:06 +01:00
from_user (:class:`telegram.User`):
query (str):
location (Optional[:class:`telegram.Location`]):
inline_message_id (Optional[str]):
**kwargs (dict): Arbitrary keyword arguments.
2016-01-04 17:31:06 +01:00
"""
2016-05-24 01:43:17 +02:00
def __init__(self,
result_id,
from_user,
query,
location=None,
inline_message_id=None,
**kwargs):
2016-01-04 17:31:06 +01:00
# Required
self.result_id = result_id
2016-01-04 17:31:06 +01:00
self.from_user = from_user
self.query = query
2016-04-14 07:21:00 +02:00
# Optionals
self.location = location
self.inline_message_id = inline_message_id
2016-01-04 17:31:06 +01:00
self._id_attrs = (self.result_id,)
2016-01-04 17:31:06 +01:00
@staticmethod
def de_json(data, bot):
2016-01-04 17:31:06 +01:00
"""
Args:
data (dict):
bot (telegram.Bot):
2016-01-04 17:31:06 +01:00
Returns:
telegram.ChosenInlineResult:
"""
if not data:
return None
2016-04-14 08:40:26 +02:00
data = super(ChosenInlineResult, ChosenInlineResult).de_json(data, bot)
# Required
data['from_user'] = User.de_json(data.pop('from'), bot)
2016-04-14 08:40:26 +02:00
# Optionals
data['location'] = Location.de_json(data.get('location'), bot)
2016-01-04 17:31:06 +01:00
return ChosenInlineResult(**data)
def to_dict(self):
"""
Returns:
dict:
"""
data = super(ChosenInlineResult, self).to_dict()
# Required
data['from'] = data.pop('from_user', None)
return data