2017-08-11 23:58:41 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2018-01-04 16:16:06 +01:00
|
|
|
# Copyright (C) 2015-2018
|
2017-08-11 23:58:41 +02:00
|
|
|
# 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/].
|
2017-06-14 13:42:57 +02:00
|
|
|
import inspect
|
2017-08-11 23:58:41 +02:00
|
|
|
import sys
|
|
|
|
from platform import python_implementation
|
2017-06-14 13:42:57 +02:00
|
|
|
|
|
|
|
import certifi
|
2017-08-11 23:58:41 +02:00
|
|
|
import pytest
|
2017-06-14 13:42:57 +02:00
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
from telegram.vendor.ptb_urllib3 import urllib3
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
|
2017-06-14 13:42:57 +02:00
|
|
|
import telegram
|
|
|
|
|
|
|
|
IGNORED_OBJECTS = ('ResponseParameters', 'CallbackGame')
|
2018-02-22 13:17:06 +01:00
|
|
|
IGNORED_PARAMETERS = {'self', 'args', 'kwargs', 'read_latency', 'network_delay', 'timeout', 'bot'}
|
2017-06-14 13:42:57 +02:00
|
|
|
|
|
|
|
|
|
|
|
def find_next_sibling_until(tag, name, until):
|
|
|
|
for sibling in tag.next_siblings:
|
|
|
|
if sibling is until:
|
|
|
|
return
|
|
|
|
if sibling.name == name:
|
|
|
|
return sibling
|
|
|
|
|
|
|
|
|
|
|
|
def parse_table(h4):
|
|
|
|
table = find_next_sibling_until(h4, 'table', h4.find_next_sibling('h4'))
|
|
|
|
if not table:
|
|
|
|
return []
|
|
|
|
t = []
|
|
|
|
for tr in table.find_all('tr')[1:]:
|
2017-10-14 20:03:02 +02:00
|
|
|
t.append([td.text for td in tr.find_all('td')])
|
2017-06-14 13:42:57 +02:00
|
|
|
return t
|
|
|
|
|
|
|
|
|
|
|
|
def check_method(h4):
|
|
|
|
name = h4.text
|
|
|
|
method = getattr(telegram.Bot, name)
|
|
|
|
table = parse_table(h4)
|
|
|
|
|
|
|
|
# Check arguments based on source
|
|
|
|
sig = inspect.signature(method, follow_wrapped=True)
|
|
|
|
|
|
|
|
checked = []
|
|
|
|
for parameter in table:
|
2017-10-14 20:03:02 +02:00
|
|
|
param = sig.parameters.get(parameter[0])
|
|
|
|
assert param is not None, "Parameter {} not found in {}".format(parameter[0],
|
2017-09-01 08:40:52 +02:00
|
|
|
method.__name__)
|
2017-06-14 13:42:57 +02:00
|
|
|
# TODO: Check type via docstring
|
|
|
|
# TODO: Check if optional or required
|
2017-10-14 20:03:02 +02:00
|
|
|
checked.append(parameter[0])
|
2017-06-14 13:42:57 +02:00
|
|
|
|
|
|
|
ignored = IGNORED_PARAMETERS.copy()
|
|
|
|
if name == 'getUpdates':
|
|
|
|
ignored -= {'timeout'} # Has it's own timeout parameter that we do wanna check for
|
|
|
|
elif name == 'sendDocument':
|
|
|
|
ignored |= {'filename'} # Undocumented
|
|
|
|
elif name == 'setGameScore':
|
|
|
|
ignored |= {'edit_message'} # TODO: Now deprecated, so no longer in telegrams docs
|
2017-07-25 00:35:22 +02:00
|
|
|
elif name == 'sendContact':
|
|
|
|
ignored |= {'contact'} # Added for ease of use
|
2017-10-14 20:03:02 +02:00
|
|
|
elif name in ['sendLocation', 'editMessageLiveLocation']:
|
2017-07-25 00:35:22 +02:00
|
|
|
ignored |= {'location'} # Added for ease of use
|
|
|
|
elif name == 'sendVenue':
|
|
|
|
ignored |= {'venue'} # Added for ease of use
|
2017-06-14 13:42:57 +02:00
|
|
|
|
|
|
|
assert (sig.parameters.keys() ^ checked) - ignored == set()
|
|
|
|
|
|
|
|
|
|
|
|
def check_object(h4):
|
|
|
|
name = h4.text
|
|
|
|
obj = getattr(telegram, name)
|
|
|
|
table = parse_table(h4)
|
|
|
|
|
|
|
|
# Check arguments based on source
|
|
|
|
sig = inspect.signature(obj, follow_wrapped=True)
|
|
|
|
|
|
|
|
checked = []
|
|
|
|
for parameter in table:
|
2017-10-14 20:03:02 +02:00
|
|
|
field = parameter[0]
|
2017-06-14 13:42:57 +02:00
|
|
|
if field == 'from':
|
|
|
|
field = 'from_user'
|
2018-11-01 10:18:07 +01:00
|
|
|
elif ((name.startswith('InlineQueryResult')
|
|
|
|
or name.startswith('InputMedia')) and field == 'type'):
|
2017-06-14 13:42:57 +02:00
|
|
|
continue
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
elif name.startswith('PassportElementError') and field == 'source':
|
|
|
|
continue
|
2017-06-14 13:42:57 +02:00
|
|
|
elif field == 'remove_keyboard':
|
|
|
|
continue
|
|
|
|
|
|
|
|
param = sig.parameters.get(field)
|
2017-09-01 08:40:52 +02:00
|
|
|
assert param is not None, "Attribute {} not found in {}".format(field, obj.__name__)
|
2017-06-14 13:42:57 +02:00
|
|
|
# TODO: Check type via docstring
|
|
|
|
# TODO: Check if optional or required
|
|
|
|
checked.append(field)
|
|
|
|
|
|
|
|
ignored = IGNORED_PARAMETERS.copy()
|
|
|
|
if name == 'InputFile':
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
return
|
2017-06-14 13:42:57 +02:00
|
|
|
elif name == 'InlineQueryResult':
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
ignored |= {'id', 'type'}
|
2017-06-14 13:42:57 +02:00
|
|
|
elif name == 'User':
|
|
|
|
ignored |= {'type'} # TODO: Deprecation
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
elif name in ('PassportFile', 'EncryptedPassportElement'):
|
|
|
|
ignored |= {'credentials'}
|
|
|
|
elif name == 'PassportElementError':
|
|
|
|
ignored |= {'message', 'type', 'source'}
|
2017-06-14 13:42:57 +02:00
|
|
|
|
|
|
|
assert (sig.parameters.keys() ^ checked) - ignored == set()
|
|
|
|
|
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
argvalues = []
|
|
|
|
names = []
|
|
|
|
http = urllib3.PoolManager(
|
|
|
|
cert_reqs='CERT_REQUIRED',
|
|
|
|
ca_certs=certifi.where())
|
|
|
|
request = http.request('GET', 'https://core.telegram.org/bots/api')
|
|
|
|
soup = BeautifulSoup(request.data.decode('utf-8'), 'html.parser')
|
|
|
|
|
|
|
|
for thing in soup.select('h4 > a.anchor'):
|
|
|
|
# Methods and types don't have spaces in them, luckily all other sections of the docs do
|
|
|
|
# TODO: don't depend on that
|
|
|
|
if '-' not in thing['name']:
|
|
|
|
h4 = thing.parent
|
|
|
|
|
|
|
|
# Is it a method
|
|
|
|
if h4.text[0].lower() == h4.text[0]:
|
|
|
|
argvalues.append((check_method, h4))
|
|
|
|
names.append(h4.text)
|
|
|
|
elif h4.text not in IGNORED_OBJECTS: # Or a type/object
|
|
|
|
argvalues.append((check_object, h4))
|
|
|
|
names.append(h4.text)
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.mark.parametrize(('method', 'data'), argvalues=argvalues, ids=names)
|
2017-09-01 08:40:52 +02:00
|
|
|
@pytest.mark.skipif(not sys.version_info >= (3, 6) or python_implementation() != 'CPython',
|
2017-08-11 23:58:41 +02:00
|
|
|
reason='follow_wrapped (inspect.signature) is not supported on this platform')
|
|
|
|
def test_official(method, data):
|
|
|
|
method(data)
|