OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-22 14:35:00 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve Code Quality (#2131)

Browse source 
* Make pre-commit more strict

* Get pylint to read setup.cfg

* Make pylint & mypy happy aka ignore all the things

* use LogRecord.getMessage() in tests

* Make noam happy

* Update both pylint & mypy while we're at it

* Bring reqs-dev and makefile up to speed

* try making pre-commit happy

* fix jobqueue tests on the fly
This commit is contained in:
Bibo-Joshi 2020-10-31 16:33:34 +01:00 committed by GitHub
parent 237e73bfb4
commit 92b9370c23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
140 changed files with 1279 additions and 1081 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
.pre-commit-config.yaml
View file

@ -1,3 +1,6 @@
# Make sure that
# * the revs specified here match requirements-dev.txt
# * the makefile checks the same files as pre-commit
repos:
- repo: https://github.com/psf/black
rev: 20.8b1
@ -7,19 +10,18 @@ repos:
- --diff
- --check
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.1
rev: 3.8.4
hooks:
- id: flake8
- repo: git://github.com/pre-commit/mirrors-pylint
rev: v2.5.3
- repo: https://github.com/PyCQA/pylint
rev: pylint-2.6.0
hooks:
- id: pylint
files: ^telegram/.*\.py$
files: ^(telegram|examples)/.*\.py$
args:
- --errors-only
- --disable=import-error
- --rcfile=setup.cfg
- repo: https://github.com/pre-commit/mirrors-mypy
rev: 'v0.770'
rev: v0.790
hooks:
- id: mypy
files: ^telegram/.*\.py$
files: ^(telegram|examples)/.*\.py$

25
Makefile
View file

@ -1,11 +1,10 @@
.DEFAULT_GOAL := help
.PHONY: clean pep257 pep8 yapf lint test install
.PHONY: clean pep8 black lint test install
PYLINT := pylint
PYTEST := pytest
PEP257 := pep257
PEP8 := flake8
YAPF := yapf
BLACK := black
MYPY := mypy
PIP := pip
@ -15,22 +14,20 @@ clean:
find . -name '*.pyc' -exec rm -f {} \;
find . -name '*.pyo' -exec rm -f {} \;
find . -name '*~' -exec rm -f {} \;
find . -regex "./telegram.\(mp3\|mp4\|ogg\|png\|webp\)" -exec rm {} \;
pep257:
$(PEP257) telegram
find . -regex "./telegram[0-9]*.\(jpg\|mp3\|mp4\|ogg\|png\|webp\)" -exec rm {} \;
pep8:
$(PEP8) telegram
$(PEP8) telegram tests examples
yapf:
$(YAPF) -r telegram
black:
$(BLACK) .
lint:
$(PYLINT) -E telegram --disable=no-name-in-module,import-error
$(PYLINT) --rcfile=setup.cfg telegram examples
mypy:
$(MYPY) -p telegram
$(MYPY) examples
test:
$(PYTEST) -v
@ -41,18 +38,16 @@ install:
help:
@echo "Available targets:"
@echo "- clean Clean up the source directory"
@echo "- pep257 Check docstring style with pep257"
@echo "- pep8 Check style with flake8"
@echo "- lint Check style with pylint"
@echo "- yapf Check style with yapf"
@echo "- black Check style with black"
@echo "- mypy Check type hinting with mypy"
@echo "- test Run tests using pytest"
@echo
@echo "Available variables:"
@echo "- PYLINT default: $(PYLINT)"
@echo "- PYTEST default: $(PYTEST)"
@echo "- PEP257 default: $(PEP257)"
@echo "- PEP8 default: $(PEP8)"
@echo "- YAPF default: $(YAPF)"
@echo "- BLACK default: $(BLACK)"
@echo "- MYPY default: $(MYPY)"
@echo "- PIP default: $(PIP)"

35
examples/conversationbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -16,8 +18,15 @@ bot.
import logging
from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters, ConversationHandler
from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update
from telegram.ext import (
Updater,
CommandHandler,
MessageHandler,
Filters,
ConversationHandler,
CallbackContext,
)
# Enable logging
logging.basicConfig(
@ -29,7 +38,7 @@ logger = logging.getLogger(__name__)
GENDER, PHOTO, LOCATION, BIO = range(4)
def start(update, context):
def start(update: Update, context: CallbackContext) -> int:
reply_keyboard = [['Boy', 'Girl', 'Other']]
update.message.reply_text(
@ -42,7 +51,7 @@ def start(update, context):
return GENDER
def gender(update, context):
def gender(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
logger.info("Gender of %s: %s", user.first_name, update.message.text)
update.message.reply_text(
@ -54,7 +63,7 @@ def gender(update, context):
return PHOTO
def photo(update, context):
def photo(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
photo_file = update.message.photo[-1].get_file()
photo_file.download('user_photo.jpg')
@ -66,7 +75,7 @@ def photo(update, context):
return LOCATION
def skip_photo(update, context):
def skip_photo(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
logger.info("User %s did not send a photo.", user.first_name)
update.message.reply_text(
@ -76,7 +85,7 @@ def skip_photo(update, context):
return LOCATION
def location(update, context):
def location(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
user_location = update.message.location
logger.info(
@ -89,7 +98,7 @@ def location(update, context):
return BIO
def skip_location(update, context):
def skip_location(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
logger.info("User %s did not send a location.", user.first_name)
update.message.reply_text(
@ -99,7 +108,7 @@ def skip_location(update, context):
return BIO
def bio(update, context):
def bio(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
logger.info("Bio of %s: %s", user.first_name, update.message.text)
update.message.reply_text('Thank you! I hope we can talk again some day.')
@ -107,7 +116,7 @@ def bio(update, context):
return ConversationHandler.END
def cancel(update, context):
def cancel(update: Update, context: CallbackContext) -> int:
user = update.message.from_user
logger.info("User %s canceled the conversation.", user.first_name)
update.message.reply_text(
@ -117,14 +126,14 @@ def cancel(update, context):
return ConversationHandler.END
def main():
def main() -> None:
# Create the Updater and pass it your bot's token.
# Make sure to set use_context=True to use the new context based callbacks
# Post version 12 this will no longer be necessary
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# Add conversation handler with the states GENDER, PHOTO, LOCATION and BIO
conv_handler = ConversationHandler(
@ -141,7 +150,7 @@ def main():
fallbacks=[CommandHandler('cancel', cancel)],
)
dp.add_handler(conv_handler)
dispatcher.add_handler(conv_handler)
# Start the Bot
updater.start_polling()

32
examples/conversationbot2.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -15,9 +17,17 @@ bot.
"""
import logging
from typing import Dict
from telegram import ReplyKeyboardMarkup
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters, ConversationHandler
from telegram import ReplyKeyboardMarkup, Update
from telegram.ext import (
Updater,
CommandHandler,
MessageHandler,
Filters,
ConversationHandler,
CallbackContext,
)
# Enable logging
logging.basicConfig(
@ -36,7 +46,7 @@ reply_keyboard = [
markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True)
def facts_to_str(user_data):
def facts_to_str(user_data: Dict[str, str]) -> str:
facts = list()
for key, value in user_data.items():
@ -45,7 +55,7 @@ def facts_to_str(user_data):
return "\n".join(facts).join(['\n', '\n'])
def start(update, context):
def start(update: Update, context: CallbackContext) -> int:
update.message.reply_text(
"Hi! My name is Doctor Botter. I will hold a more complex conversation with you. "
"Why don't you tell me something about yourself?",
@ -55,7 +65,7 @@ def start(update, context):
return CHOOSING
def regular_choice(update, context):
def regular_choice(update: Update, context: CallbackContext) -> int:
text = update.message.text
context.user_data['choice'] = text
update.message.reply_text(
@ -65,7 +75,7 @@ def regular_choice(update, context):
return TYPING_REPLY
def custom_choice(update, context):
def custom_choice(update: Update, context: CallbackContext) -> int:
update.message.reply_text(
'Alright, please send me the category first, ' 'for example "Most impressive skill"'
)
@ -73,7 +83,7 @@ def custom_choice(update, context):
return TYPING_CHOICE
def received_information(update, context):
def received_information(update: Update, context: CallbackContext) -> int:
user_data = context.user_data
text = update.message.text
category = user_data['choice']
@ -90,7 +100,7 @@ def received_information(update, context):
return CHOOSING
def done(update, context):
def done(update: Update, context: CallbackContext) -> int:
user_data = context.user_data
if 'choice' in user_data:
del user_data['choice']
@ -103,14 +113,14 @@ def done(update, context):
return ConversationHandler.END
def main():
def main() -> None:
# Create the Updater and pass it your bot's token.
# Make sure to set use_context=True to use the new context based callbacks
# Post version 12 this will no longer be necessary
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# Add conversation handler with the states CHOOSING, TYPING_CHOICE and TYPING_REPLY
conv_handler = ConversationHandler(
@ -137,7 +147,7 @@ def main():
fallbacks=[MessageHandler(Filters.regex('^Done$'), done)],
)
dp.add_handler(conv_handler)
dispatcher.add_handler(conv_handler)
# Start the Bot
updater.start_polling()

27
examples/deeplinking.py
View file

@ -1,5 +1,8 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""Bot that explains Telegram's "Deep Linking Parameters" functionality.
@ -19,8 +22,8 @@ bot.
import logging
from telegram import ParseMode, InlineKeyboardMarkup, InlineKeyboardButton
from telegram.ext import Updater, CommandHandler, Filters
from telegram import ParseMode, InlineKeyboardMarkup, InlineKeyboardButton, Update
from telegram.ext import Updater, CommandHandler, Filters, CallbackContext
# Enable logging
from telegram.utils import helpers
@ -37,7 +40,7 @@ USING_ENTITIES = 'using-entities-here'
SO_COOL = 'so-cool'
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Send a deep-linked URL when the command /start is issued."""
bot = context.bot
url = helpers.create_deep_linked_url(bot.get_me().username, CHECK_THIS_OUT, group=True)
@ -45,7 +48,7 @@ def start(update, context):
update.message.reply_text(text)
def deep_linked_level_1(update, context):
def deep_linked_level_1(update: Update, context: CallbackContext) -> None:
"""Reached through the CHECK_THIS_OUT payload"""
bot = context.bot
url = helpers.create_deep_linked_url(bot.get_me().username, SO_COOL)
@ -59,7 +62,7 @@ def deep_linked_level_1(update, context):
update.message.reply_text(text, reply_markup=keyboard)
def deep_linked_level_2(update, context):
def deep_linked_level_2(update: Update, context: CallbackContext) -> None:
"""Reached through the SO_COOL payload"""
bot = context.bot
url = helpers.create_deep_linked_url(bot.get_me().username, USING_ENTITIES)
@ -67,7 +70,7 @@ def deep_linked_level_2(update, context):
update.message.reply_text(text, parse_mode=ParseMode.MARKDOWN, disable_web_page_preview=True)
def deep_linked_level_3(update, context):
def deep_linked_level_3(update: Update, context: CallbackContext) -> None:
"""Reached through the USING_ENTITIES payload"""
payload = context.args
update.message.reply_text(
@ -81,24 +84,26 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# More info on what deep linking actually is (read this first if it's unclear to you):
# https://core.telegram.org/bots#deep-linking
# Register a deep-linking handler
dp.add_handler(CommandHandler("start", deep_linked_level_1, Filters.regex(CHECK_THIS_OUT)))
dispatcher.add_handler(
CommandHandler("start", deep_linked_level_1, Filters.regex(CHECK_THIS_OUT))
)
# This one works with a textual link instead of an URL
dp.add_handler(CommandHandler("start", deep_linked_level_2, Filters.regex(SO_COOL)))
dispatcher.add_handler(CommandHandler("start", deep_linked_level_2, Filters.regex(SO_COOL)))
# We can also pass on the deep-linking payload
dp.add_handler(
dispatcher.add_handler(
CommandHandler("start", deep_linked_level_3, Filters.regex(USING_ENTITIES), pass_args=True)
)
# Make sure the deep-linking handlers occur *before* the normal /start handler.
dp.add_handler(CommandHandler("start", start))
dispatcher.add_handler(CommandHandler("start", start))
# Start the Bot
updater.start_polling()

19
examples/echobot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -17,7 +19,8 @@ bot.
import logging
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters
from telegram import Update
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters, CallbackContext
# Enable logging
logging.basicConfig(
@ -29,17 +32,17 @@ logger = logging.getLogger(__name__)
# Define a few command handlers. These usually take the two arguments update and
# context. Error handlers also receive the raised TelegramError object in error.
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Send a message when the command /start is issued."""
update.message.reply_text('Hi!')
def help_command(update, context):
def help_command(update: Update, context: CallbackContext) -> None:
"""Send a message when the command /help is issued."""
update.message.reply_text('Help!')
def echo(update, context):
def echo(update: Update, context: CallbackContext) -> None:
"""Echo the user message."""
update.message.reply_text(update.message.text)
@ -52,14 +55,14 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# on different commands - answer in Telegram
dp.add_handler(CommandHandler("start", start))
dp.add_handler(CommandHandler("help", help_command))
dispatcher.add_handler(CommandHandler("start", start))
dispatcher.add_handler(CommandHandler("help", help_command))
# on noncommand i.e message - echo the message on Telegram
dp.add_handler(MessageHandler(Filters.text & ~Filters.command, echo))
dispatcher.add_handler(MessageHandler(Filters.text & ~Filters.command, echo))
# Start the Bot
updater.start_polling()

20
examples/errorhandlerbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -27,7 +29,7 @@ BOT_TOKEN = "TOKEN"
DEVELOPER_CHAT_ID = 123456789
def error_handler(update: Update, context: CallbackContext):
def error_handler(update: Update, context: CallbackContext) -> None:
"""Log the error and send a telegram message to notify the developer."""
# Log the error before we do anything else, so we can see it even if something breaks.
logger.error(msg="Exception while handling an update:", exc_info=context.error)
@ -35,7 +37,7 @@ def error_handler(update: Update, context: CallbackContext):
# traceback.format_exception returns the usual python message about an exception, but as a
# list of strings rather than a single string, so we have to join them together.
tb_list = traceback.format_exception(None, context.error, context.error.__traceback__)
tb = ''.join(tb_list)
tb_string = ''.join(tb_list)
# Build the message with some markup and additional information about what happened.
# You might need to add some logic to deal with messages longer than the 4096 character limit.
@ -49,19 +51,19 @@ def error_handler(update: Update, context: CallbackContext):
html.escape(json.dumps(update.to_dict(), indent=2, ensure_ascii=False)),
html.escape(str(context.chat_data)),
html.escape(str(context.user_data)),
html.escape(tb),
html.escape(tb_string),
)
# Finally, send the message
context.bot.send_message(chat_id=DEVELOPER_CHAT_ID, text=message, parse_mode=ParseMode.HTML)
def bad_command(update: Update, context: CallbackContext):
def bad_command(update: Update, context: CallbackContext) -> None:
"""Raise an error to trigger the error handler."""
context.bot.wrong_method_name()
def start(update: Update, context: CallbackContext):
def start(update: Update, context: CallbackContext) -> None:
update.effective_message.reply_html(
'Use /bad_command to cause an error.\n'
'Your chat id is <code>{}</code>.'.format(update.effective_chat.id)
@ -75,14 +77,14 @@ def main():
updater = Updater(BOT_TOKEN, use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# Register the commands...
dp.add_handler(CommandHandler('start', start))
dp.add_handler(CommandHandler('bad_command', bad_command))
dispatcher.add_handler(CommandHandler('start', start))
dispatcher.add_handler(CommandHandler('bad_command', bad_command))
# ...and the error handler
dp.add_error_handler(error_handler)
dispatcher.add_error_handler(error_handler)
# Start the Bot
updater.start_polling()

22
examples/inlinebot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -15,8 +17,8 @@ bot.
import logging
from uuid import uuid4
from telegram import InlineQueryResultArticle, ParseMode, InputTextMessageContent
from telegram.ext import Updater, InlineQueryHandler, CommandHandler
from telegram import InlineQueryResultArticle, ParseMode, InputTextMessageContent, Update
from telegram.ext import Updater, InlineQueryHandler, CommandHandler, CallbackContext
from telegram.utils.helpers import escape_markdown
# Enable logging
@ -29,17 +31,17 @@ logger = logging.getLogger(__name__)
# Define a few command handlers. These usually take the two arguments update and
# context. Error handlers also receive the raised TelegramError object in error.
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Send a message when the command /start is issued."""
update.message.reply_text('Hi!')
def help_command(update, context):
def help_command(update: Update, context: CallbackContext) -> None:
"""Send a message when the command /help is issued."""
update.message.reply_text('Help!')
def inlinequery(update, context):
def inlinequery(update: Update, context: CallbackContext) -> None:
"""Handle the inline query."""
query = update.inline_query.query
results = [
@ -65,21 +67,21 @@ def inlinequery(update, context):
update.inline_query.answer(results)
def main():
def main() -> None:
# Create the Updater and pass it your bot's token.
# Make sure to set use_context=True to use the new context based callbacks
# Post version 12 this will no longer be necessary
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# on different commands - answer in Telegram
dp.add_handler(CommandHandler("start", start))
dp.add_handler(CommandHandler("help", help_command))
dispatcher.add_handler(CommandHandler("start", start))
dispatcher.add_handler(CommandHandler("help", help_command))
# on noncommand i.e message - echo the message on Telegram
dp.add_handler(InlineQueryHandler(inlinequery))
dispatcher.add_handler(InlineQueryHandler(inlinequery))
# Start the Bot
updater.start_polling()

12
examples/inlinekeyboard.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -7,8 +9,8 @@ Basic example for a bot that uses inline keyboards.
"""
import logging
from telegram import InlineKeyboardButton, InlineKeyboardMarkup
from telegram.ext import Updater, CommandHandler, CallbackQueryHandler
from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
from telegram.ext import Updater, CommandHandler, CallbackQueryHandler, CallbackContext
logging.basicConfig(
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', level=logging.INFO
@ -16,7 +18,7 @@ logging.basicConfig(
logger = logging.getLogger(__name__)
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
keyboard = [
[
InlineKeyboardButton("Option 1", callback_data='1'),
@ -30,7 +32,7 @@ def start(update, context):
update.message.reply_text('Please choose:', reply_markup=reply_markup)
def button(update, context):
def button(update: Update, context: CallbackContext) -> None:
query = update.callback_query
# CallbackQueries need to be answered, even if no notification to the user is needed
@ -40,7 +42,7 @@ def button(update, context):
query.edit_message_text(text="Selected option: {}".format(query.data))
def help_command(update, context):
def help_command(update: Update, context: CallbackContext) -> None:
update.message.reply_text("Use /start to test this bot.")

32
examples/inlinekeyboard2.py
View file

@ -1,5 +1,9 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""Simple inline keyboard bot with multiple CallbackQueryHandlers.
This Bot uses the Updater class to handle the bot.
@ -12,9 +16,15 @@ ConversationHandler.
Send /start to initiate the conversation.
Press Ctrl-C on the command line to stop the bot.
"""
from telegram import InlineKeyboardButton, InlineKeyboardMarkup
from telegram.ext import Updater, CommandHandler, CallbackQueryHandler, ConversationHandler
import logging
from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
from telegram.ext import (
Updater,
CommandHandler,
CallbackQueryHandler,
ConversationHandler,
CallbackContext,
)
# Enable logging
logging.basicConfig(
@ -29,7 +39,7 @@ FIRST, SECOND = range(2)
ONE, TWO, THREE, FOUR = range(4)
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Send message on `/start`."""
# Get user that sent /start and log his name
user = update.message.from_user
@ -51,7 +61,7 @@ def start(update, context):
return FIRST
def start_over(update, context):
def start_over(update: Update, context: CallbackContext) -> None:
"""Prompt same text & keyboard as `start` does but not as new message"""
# Get CallbackQuery from Update
query = update.callback_query
@ -72,7 +82,7 @@ def start_over(update, context):
return FIRST
def one(update, context):
def one(update: Update, context: CallbackContext) -> None:
"""Show new choice of buttons"""
query = update.callback_query
query.answer()
@ -89,7 +99,7 @@ def one(update, context):
return FIRST
def two(update, context):
def two(update: Update, context: CallbackContext) -> None:
"""Show new choice of buttons"""
query = update.callback_query
query.answer()
@ -106,7 +116,7 @@ def two(update, context):
return FIRST
def three(update, context):
def three(update: Update, context: CallbackContext) -> None:
"""Show new choice of buttons"""
query = update.callback_query
query.answer()
@ -124,7 +134,7 @@ def three(update, context):
return SECOND
def four(update, context):
def four(update: Update, context: CallbackContext) -> None:
"""Show new choice of buttons"""
query = update.callback_query
query.answer()
@ -141,7 +151,7 @@ def four(update, context):
return FIRST
def end(update, context):
def end(update: Update, context: CallbackContext) -> None:
"""Returns `ConversationHandler.END`, which tells the
ConversationHandler that the conversation is over"""
query = update.callback_query
@ -155,7 +165,7 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# Setup conversation handler with the states FIRST and SECOND
# Use the pattern parameter to pass CallbackQueries with specific
@ -182,7 +192,7 @@ def main():
# Add ConversationHandler to dispatcher that will be used for handling
# updates
dp.add_handler(conv_handler)
dispatcher.add_handler(conv_handler)
# Start the Bot
updater.start_polling()

68
examples/nestedconversationbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -16,7 +18,7 @@ bot.
import logging
from telegram import InlineKeyboardMarkup, InlineKeyboardButton
from telegram import InlineKeyboardMarkup, InlineKeyboardButton, Update
from telegram.ext import (
Updater,
CommandHandler,
@ -24,6 +26,7 @@ from telegram.ext import (
Filters,
ConversationHandler,
CallbackQueryHandler,
CallbackContext,
)
# Enable logging
@ -64,13 +67,12 @@ END = ConversationHandler.END
# Helper
def _name_switcher(level):
if level == PARENTS:
return ('Father', 'Mother')
elif level == CHILDREN:
return ('Brother', 'Sister')
return 'Father', 'Mother'
return 'Brother', 'Sister'
# Top level conversation callbacks
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Select an action: Adding parent/child or show data."""
text = (
'You may add a familiy member, yourself show the gathered data or end the '
@ -102,7 +104,7 @@ def start(update, context):
return SELECTING_ACTION
def adding_self(update, context):
def adding_self(update: Update, context: CallbackContext) -> None:
"""Add information about youself."""
context.user_data[CURRENT_LEVEL] = SELF
text = 'Okay, please tell me about yourself.'
@ -115,7 +117,7 @@ def adding_self(update, context):
return DESCRIBING_SELF
def show_data(update, context):
def show_data(update: Update, context: CallbackContext) -> None:
"""Pretty print gathered data."""
def prettyprint(user_data, level):
@ -137,29 +139,29 @@ def show_data(update, context):
)
return text
ud = context.user_data
text = 'Yourself:' + prettyprint(ud, SELF)
text += '\n\nParents:' + prettyprint(ud, PARENTS)
text += '\n\nChildren:' + prettyprint(ud, CHILDREN)
user_data = context.user_data
text = 'Yourself:' + prettyprint(user_data, SELF)
text += '\n\nParents:' + prettyprint(user_data, PARENTS)
text += '\n\nChildren:' + prettyprint(user_data, CHILDREN)
buttons = [[InlineKeyboardButton(text='Back', callback_data=str(END))]]
keyboard = InlineKeyboardMarkup(buttons)
update.callback_query.answer()
update.callback_query.edit_message_text(text=text, reply_markup=keyboard)
ud[START_OVER] = True
user_data[START_OVER] = True
return SHOWING
def stop(update, context):
def stop(update: Update, context: CallbackContext) -> None:
"""End Conversation by command."""
update.message.reply_text('Okay, bye.')
return END
def end(update, context):
def end(update: Update, context: CallbackContext) -> None:
"""End conversation from InlineKeyboardButton."""
update.callback_query.answer()
@ -170,7 +172,7 @@ def end(update, context):
# Second level conversation callbacks
def select_level(update, context):
def select_level(update: Update, context: CallbackContext) -> None:
"""Choose to add a parent or a child."""
text = 'You may add a parent or a child. Also you can show the gathered data or go back.'
buttons = [
@ -191,7 +193,7 @@ def select_level(update, context):
return SELECTING_LEVEL
def select_gender(update, context):
def select_gender(update: Update, context: CallbackContext) -> None:
"""Choose to add mother or father."""
level = update.callback_query.data
context.user_data[CURRENT_LEVEL] = level
@ -218,7 +220,7 @@ def select_gender(update, context):
return SELECTING_GENDER
def end_second_level(update, context):
def end_second_level(update: Update, context: CallbackContext) -> None:
"""Return to top level conversation."""
context.user_data[START_OVER] = True
start(update, context)
@ -227,7 +229,7 @@ def end_second_level(update, context):
# Third level callbacks
def select_feature(update, context):
def select_feature(update: Update, context: CallbackContext) -> None:
"""Select a feature to update for the person."""
buttons = [
[
@ -254,7 +256,7 @@ def select_feature(update, context):
return SELECTING_FEATURE
def ask_for_input(update, context):
def ask_for_input(update: Update, context: CallbackContext) -> None:
"""Prompt user to input data for selected feature."""
context.user_data[CURRENT_FEATURE] = update.callback_query.data
text = 'Okay, tell me.'
@ -265,27 +267,27 @@ def ask_for_input(update, context):
return TYPING
def save_input(update, context):
def save_input(update: Update, context: CallbackContext) -> None:
"""Save input for feature and return to feature selection."""
ud = context.user_data
ud[FEATURES][ud[CURRENT_FEATURE]] = update.message.text
user_data = context.user_data
user_data[FEATURES][user_data[CURRENT_FEATURE]] = update.message.text
ud[START_OVER] = True
user_data[START_OVER] = True
return select_feature(update, context)
def end_describing(update, context):
def end_describing(update: Update, context: CallbackContext) -> None:
"""End gathering of features and return to parent conversation."""
ud = context.user_data
level = ud[CURRENT_LEVEL]
if not ud.get(level):
ud[level] = []
ud[level].append(ud[FEATURES])
user_data = context.user_data
level = user_data[CURRENT_LEVEL]
if not user_data.get(level):
user_data[level] = []
user_data[level].append(user_data[FEATURES])
# Print upper level menu
if level == SELF:
ud[START_OVER] = True
user_data[START_OVER] = True
start(update, context)
else:
select_level(update, context)
@ -293,7 +295,7 @@ def end_describing(update, context):
return END
def stop_nested(update, context):
def stop_nested(update: Update, context: CallbackContext) -> None:
"""Completely end conversation from within nested conversation."""
update.message.reply_text('Okay, bye.')
@ -307,7 +309,7 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# Set up third level ConversationHandler (collecting features)
description_conv = ConversationHandler(
@ -381,7 +383,7 @@ def main():
fallbacks=[CommandHandler('stop', stop)],
)
dp.add_handler(conv_handler)
dispatcher.add_handler(conv_handler)
# Start the Bot
updater.start_polling()

11
examples/passportbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -12,7 +14,8 @@ See https://git.io/fAvYd for how to use Telegram Passport properly with python-t
"""
import logging
from telegram.ext import Updater, MessageHandler, Filters
from telegram import Update
from telegram.ext import Updater, MessageHandler, Filters, CallbackContext
# Enable logging
logging.basicConfig(
@ -22,7 +25,7 @@ logging.basicConfig(
logger = logging.getLogger(__name__)
def msg(update, context):
def msg(update: Update, context: CallbackContext) -> None:
# If we received any passport data
passport_data = update.message.passport_data
if passport_data:
@ -100,10 +103,10 @@ def main():
updater = Updater("TOKEN", private_key=open('private.key', 'rb').read())
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# On messages that include passport data call msg
dp.add_handler(MessageHandler(Filters.passport_data, msg))
dispatcher.add_handler(MessageHandler(Filters.passport_data, msg))
# Start the Bot
updater.start_polling()

47
examples/paymentbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -8,7 +10,7 @@ Basic example for a bot that can receive payment from user.
import logging
from telegram import LabeledPrice, ShippingOption
from telegram import LabeledPrice, ShippingOption, Update
from telegram.ext import (
Updater,
CommandHandler,
@ -16,6 +18,7 @@ from telegram.ext import (
Filters,
PreCheckoutQueryHandler,
ShippingQueryHandler,
CallbackContext,
)
# Enable logging
@ -26,13 +29,13 @@ logging.basicConfig(
logger = logging.getLogger(__name__)
def start_callback(update, context):
def start_callback(update: Update, context: CallbackContext) -> None:
msg = "Use /shipping to get an invoice for shipping-payment, "
msg += "or /noshipping for an invoice without shipping."
update.message.reply_text(msg)
def start_with_shipping_callback(update, context):
def start_with_shipping_callback(update: Update, context: CallbackContext) -> None:
chat_id = update.message.chat_id
title = "Payment Example"
description = "Payment Example using python-telegram-bot"
@ -67,7 +70,7 @@ def start_with_shipping_callback(update, context):
)
def start_without_shipping_callback(update, context):
def start_without_shipping_callback(update: Update, context: CallbackContext) -> None:
chat_id = update.message.chat_id
title = "Payment Example"
description = "Payment Example using python-telegram-bot"
@ -89,25 +92,25 @@ def start_without_shipping_callback(update, context):
)
def shipping_callback(update, context):
def shipping_callback(update: Update, context: CallbackContext) -> None:
query = update.shipping_query
# check the payload, is this from your bot?
if query.invoice_payload != 'Custom-Payload':
# answer False pre_checkout_query
query.answer(ok=False, error_message="Something went wrong...")
return
else:
options = list()
# a single LabeledPrice
options.append(ShippingOption('1', 'Shipping Option A', [LabeledPrice('A', 100)]))
# an array of LabeledPrice objects
price_list = [LabeledPrice('B1', 150), LabeledPrice('B2', 200)]
options.append(ShippingOption('2', 'Shipping Option B', price_list))
query.answer(ok=True, shipping_options=options)
options = list()
# a single LabeledPrice
options.append(ShippingOption('1', 'Shipping Option A', [LabeledPrice('A', 100)]))
# an array of LabeledPrice objects
price_list = [LabeledPrice('B1', 150), LabeledPrice('B2', 200)]
options.append(ShippingOption('2', 'Shipping Option B', price_list))
query.answer(ok=True, shipping_options=options)
# after (optional) shipping, it's the pre-checkout
def precheckout_callback(update, context):
def precheckout_callback(update: Update, context: CallbackContext) -> None:
query = update.pre_checkout_query
# check the payload, is this from your bot?
if query.invoice_payload != 'Custom-Payload':
@ -118,7 +121,7 @@ def precheckout_callback(update, context):
# finally, after contacting the payment provider...
def successful_payment_callback(update, context):
def successful_payment_callback(update: Update, context: CallbackContext) -> None:
# do something after successfully receiving payment?
update.message.reply_text("Thank you for your payment!")
@ -130,23 +133,23 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# simple start function
dp.add_handler(CommandHandler("start", start_callback))
dispatcher.add_handler(CommandHandler("start", start_callback))
# Add command handler to start the payment invoice
dp.add_handler(CommandHandler("shipping", start_with_shipping_callback))
dp.add_handler(CommandHandler("noshipping", start_without_shipping_callback))
dispatcher.add_handler(CommandHandler("shipping", start_with_shipping_callback))
dispatcher.add_handler(CommandHandler("noshipping", start_without_shipping_callback))
# Optional handler if your product requires shipping
dp.add_handler(ShippingQueryHandler(shipping_callback))
dispatcher.add_handler(ShippingQueryHandler(shipping_callback))
# Pre-checkout handler to final check
dp.add_handler(PreCheckoutQueryHandler(precheckout_callback))
dispatcher.add_handler(PreCheckoutQueryHandler(precheckout_callback))
# Success! Notify your user!
dp.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
dispatcher.add_handler(MessageHandler(Filters.successful_payment, successful_payment_callback))
# Start the Bot
updater.start_polling()

20
examples/persistentconversationbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116, C0103
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -14,7 +16,9 @@ Press Ctrl-C on the command line or send a signal to the process to stop the
bot.
"""
from telegram import ReplyKeyboardMarkup
import logging
from telegram import ReplyKeyboardMarkup, Update
from telegram.ext import (
Updater,
CommandHandler,
@ -22,9 +26,9 @@ from telegram.ext import (
Filters,
ConversationHandler,
PicklePersistence,
CallbackContext,
)
import logging
# Enable logging
logging.basicConfig(
@ -52,7 +56,7 @@ def facts_to_str(user_data):
return "\n".join(facts).join(['\n', '\n'])
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
reply_text = "Hi! My name is Doctor Botter."
if context.user_data:
reply_text += (
@ -70,7 +74,7 @@ def start(update, context):
return CHOOSING
def regular_choice(update, context):
def regular_choice(update: Update, context: CallbackContext) -> None:
text = update.message.text.lower()
context.user_data['choice'] = text
if context.user_data.get(text):
@ -84,7 +88,7 @@ def regular_choice(update, context):
return TYPING_REPLY
def custom_choice(update, context):
def custom_choice(update: Update, context: CallbackContext) -> None:
update.message.reply_text(
'Alright, please send me the category first, ' 'for example "Most impressive skill"'
)
@ -92,7 +96,7 @@ def custom_choice(update, context):
return TYPING_CHOICE
def received_information(update, context):
def received_information(update: Update, context: CallbackContext) -> None:
text = update.message.text
category = context.user_data['choice']
context.user_data[category] = text.lower()
@ -109,13 +113,13 @@ def received_information(update, context):
return CHOOSING
def show_data(update, context):
def show_data(update: Update, context: CallbackContext) -> None:
update.message.reply_text(
"This is what you already told me:" "{}".format(facts_to_str(context.user_data))
)
def done(update, context):
def done(update: Update, context: CallbackContext) -> None:
if 'choice' in context.user_data:
del context.user_data['choice']

40
examples/pollbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -16,6 +18,7 @@ from telegram import (
KeyboardButtonPollType,
ReplyKeyboardMarkup,
ReplyKeyboardRemove,
Update,
)
from telegram.ext import (
Updater,
@ -24,6 +27,7 @@ from telegram.ext import (
PollHandler,
MessageHandler,
Filters,
CallbackContext,
)
logging.basicConfig(
@ -32,7 +36,7 @@ logging.basicConfig(
logger = logging.getLogger(__name__)
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
"""Inform user about what this bot can do"""
update.message.reply_text(
'Please select /poll to get a Poll, /quiz to get a Quiz or /preview'
@ -40,7 +44,7 @@ def start(update, context):
)
def poll(update, context):
def poll(update: Update, context: CallbackContext) -> None:
"""Sends a predefined poll"""
questions = ["Good", "Really good", "Fantastic", "Great"]
message = context.bot.send_poll(
@ -62,7 +66,7 @@ def poll(update, context):
context.bot_data.update(payload)
def receive_poll_answer(update, context):
def receive_poll_answer(update: Update, context: CallbackContext) -> None:
"""Summarize a users poll vote"""
answer = update.poll_answer
poll_id = answer.poll_id
@ -91,7 +95,7 @@ def receive_poll_answer(update, context):
)
def quiz(update, context):
def quiz(update: Update, context: CallbackContext) -> None:
"""Send a predefined poll"""
questions = ["1", "2", "4", "20"]
message = update.effective_message.reply_poll(
@ -104,7 +108,7 @@ def quiz(update, context):
context.bot_data.update(payload)
def receive_quiz_answer(update, context):
def receive_quiz_answer(update: Update, context: CallbackContext) -> None:
"""Close quiz after three participants took it"""
# the bot can receive closed poll updates we don't care about
if update.poll.is_closed:
@ -118,7 +122,7 @@ def receive_quiz_answer(update, context):
context.bot.stop_poll(quiz_data["chat_id"], quiz_data["message_id"])
def preview(update, context):
def preview(update: Update, context: CallbackContext) -> None:
"""Ask user to create a poll and display a preview of it"""
# using this without a type lets the user chooses what he wants (quiz or poll)
button = [[KeyboardButton("Press me!", request_poll=KeyboardButtonPollType())]]
@ -129,7 +133,7 @@ def preview(update, context):
)
def receive_poll(update, context):
def receive_poll(update: Update, context: CallbackContext) -> None:
"""On receiving polls, reply to it by a closed poll copying the received poll"""
actual_poll = update.effective_message.poll
# Only need to set the question and options, since all other parameters don't matter for
@ -143,25 +147,25 @@ def receive_poll(update, context):
)
def help_handler(update, context):
def help_handler(update: Update, context: CallbackContext) -> None:
"""Display a help message"""
update.message.reply_text("Use /quiz, /poll or /preview to test this " "bot.")
def main():
def main() -> None:
# Create the Updater and pass it your bot's token.
# Make sure to set use_context=True to use the new context based callbacks
# Post version 12 this will no longer be necessary
updater = Updater("TOKEN", use_context=True)
dp = updater.dispatcher
dp.add_handler(CommandHandler('start', start))
dp.add_handler(CommandHandler('poll', poll))
dp.add_handler(PollAnswerHandler(receive_poll_answer))
dp.add_handler(CommandHandler('quiz', quiz))
dp.add_handler(PollHandler(receive_quiz_answer))
dp.add_handler(CommandHandler('preview', preview))
dp.add_handler(MessageHandler(Filters.poll, receive_poll))
dp.add_handler(CommandHandler('help', help_handler))
dispatcher = updater.dispatcher
dispatcher.add_handler(CommandHandler('start', start))
dispatcher.add_handler(CommandHandler('poll', poll))
dispatcher.add_handler(PollAnswerHandler(receive_poll_answer))
dispatcher.add_handler(CommandHandler('quiz', quiz))
dispatcher.add_handler(PollHandler(receive_quiz_answer))
dispatcher.add_handler(CommandHandler('preview', preview))
dispatcher.add_handler(MessageHandler(Filters.poll, receive_poll))
dispatcher.add_handler(CommandHandler('help', help_handler))
# Start the Bot
updater.start_polling()

29
examples/rawapibot.py
View file

@ -1,5 +1,6 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0603
"""Simple Bot to reply to Telegram messages.
This is built on the API wrapper, see rawapibot.py to see the same example built
@ -7,26 +8,28 @@ on the telegram.ext bot framework.
This program is dedicated to the public domain under the CC0 license.
"""
import logging
import telegram
from telegram.error import NetworkError, Unauthorized
from typing import NoReturn
from time import sleep
update_id = None
import telegram
from telegram.error import NetworkError, Unauthorized
def main():
UPDATE_ID = None
def main() -> NoReturn:
"""Run the bot."""
global update_id
global UPDATE_ID
# Telegram Bot Authorization Token
bot = telegram.Bot('TOKEN')
# get the first pending update_id, this is so we can skip over it in case
# we get an "Unauthorized" exception.
try:
update_id = bot.get_updates()[0].update_id
UPDATE_ID = bot.get_updates()[0].update_id
except IndexError:
update_id = None
UPDATE_ID = None
logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
@ -37,15 +40,15 @@ def main():
sleep(1)
except Unauthorized:
# The user has removed or blocked the bot.
update_id += 1
UPDATE_ID += 1 # type: ignore[operator]
def echo(bot):
def echo(bot: telegram.Bot) -> None:
"""Echo the message the user sent."""
global update_id
global UPDATE_ID
# Request updates after the last update_id
for update in bot.get_updates(offset=update_id, timeout=10):
update_id = update.update_id + 1
for update in bot.get_updates(offset=UPDATE_ID, timeout=10):
UPDATE_ID = update.update_id + 1
if update.message: # your bot can receive updates without messages
# Reply to the message

21
examples/timerbot.py
View file

@ -1,5 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pylint: disable=W0613, C0116
# type: ignore[union-attr]
# This program is dedicated to the public domain under the CC0 license.
"""
@ -20,7 +22,8 @@ bot.
import logging
from telegram.ext import Updater, CommandHandler
from telegram import Update
from telegram.ext import Updater, CommandHandler, CallbackContext
# Enable logging
logging.basicConfig(
@ -32,7 +35,7 @@ logger = logging.getLogger(__name__)
# Define a few command handlers. These usually take the two arguments update and
# context. Error handlers also receive the raised TelegramError object in error.
def start(update, context):
def start(update: Update, context: CallbackContext) -> None:
update.message.reply_text('Hi! Use /set <seconds> to set a timer')
@ -52,7 +55,7 @@ def remove_job_if_exists(name, context):
return True
def set_timer(update, context):
def set_timer(update: Update, context: CallbackContext) -> None:
"""Add a job to the queue."""
chat_id = update.message.chat_id
try:
@ -74,7 +77,7 @@ def set_timer(update, context):
update.message.reply_text('Usage: /set <seconds>')
def unset(update, context):
def unset(update: Update, context: CallbackContext) -> None:
"""Remove the job if the user changed their mind."""
chat_id = update.message.chat_id
job_removed = remove_job_if_exists(str(chat_id), context)
@ -90,13 +93,13 @@ def main():
updater = Updater("TOKEN", use_context=True)
# Get the dispatcher to register handlers
dp = updater.dispatcher
dispatcher = updater.dispatcher
# on different commands - answer in Telegram
dp.add_handler(CommandHandler("start", start))
dp.add_handler(CommandHandler("help", start))
dp.add_handler(CommandHandler("set", set_timer))
dp.add_handler(CommandHandler("unset", unset))
dispatcher.add_handler(CommandHandler("start", start))
dispatcher.add_handler(CommandHandler("help", start))
dispatcher.add_handler(CommandHandler("set", set_timer))
dispatcher.add_handler(CommandHandler("unset", unset))
# Start the Bot
updater.start_polling()

19
requirements-dev.txt
View file

@ -1,12 +1,15 @@
flake8
pep257
pylint
flaky
yapf
mypy==0.770
pre-commit
beautifulsoup4
# Make sure that the versions specified here match the pre-commit settings
black==20.8b1
flake8==3.8.4
pylint==2.6.0
mypy==0.790
pytest==4.2.0
# Need older attrs version for pytest 4.2.0
attrs==19.1.0
flaky
beautifulsoup4
pytest-timeout
wheel
attrs==19.1.0

14
setup.cfg
View file

@ -13,7 +13,13 @@ upload-dir = docs/build/html
max-line-length = 99
ignore = W503, W605
extend-ignore = E203
exclude = setup.py, docs/source/conf.py
exclude = setup.py, docs/source/conf.py, telegram/vendor
[pylint]
ignore=vendor
[pylint.message-control]
disable = C0330,R0801,R0913,R0904,R0903,R0902,W0511,C0116,C0115,W0703,R0914,R0914,C0302,R0912,R0915,R0401
[tool:pytest]
testpaths = tests
@ -52,3 +58,9 @@ ignore_errors = True
# We don't want to clutter the code with 'if self.bot is None: raise RuntimeError()'
[mypy-telegram.callbackquery,telegram.chat,telegram.message,telegram.user,telegram.files.*,telegram.inline.inlinequery,telegram.payment.precheckoutquery,telegram.payment.shippingquery,telegram.passport.passportdata,telegram.passport.credentials,telegram.passport.passportfile,telegram.ext.filters]
strict_optional = False
[mypy-urllib3.*]
ignore_missing_imports = True
[mypy-apscheduler.*]
ignore_missing_imports = True

6
telegram/__main__.py
View file

@ -16,13 +16,13 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
import sys
# pylint: disable=E0401, C0114
import subprocess
import sys
from typing import Optional
import certifi
from typing import Optional
from . import __version__ as telegram_ver

7
telegram/base.py
View file

@ -23,9 +23,9 @@ except ImportError:
import json # type: ignore[no-redef]
import warnings
from typing import TYPE_CHECKING, Any, List, Optional, Tuple, Type, TypeVar
from telegram.utils.types import JSONDict
from typing import Tuple, Any, Optional, Type, TypeVar, TYPE_CHECKING, List
if TYPE_CHECKING:
from telegram import Bot
@ -36,7 +36,7 @@ TO = TypeVar('TO', bound='TelegramObject', covariant=True)
class TelegramObject:
"""Base class for most telegram objects."""
# def __init__(self, *args: Any, **kwargs: Any):
# def __init__(self, *args: Any, **kwargs: Any): # pylint: disable=W0613
# pass
_id_attrs: Tuple[Any, ...] = ()
@ -62,8 +62,7 @@ class TelegramObject:
if cls == TelegramObject:
return cls()
else:
return cls(bot=bot, **data) # type: ignore[call-arg]
return cls(bot=bot, **data) # type: ignore[call-arg]
@classmethod
def de_list(cls: Type[TO], data: Optional[List[JSONDict]], bot: 'Bot') -> List[Optional[TO]]:

109
telegram/bot.py
View file

@ -18,10 +18,27 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=E0401
"""This module contains an object that represents a Telegram Bot."""
import functools
import inspect
import logging
from datetime import datetime
from typing import (
IO,
TYPE_CHECKING,
Any,
Callable,
List,
Optional,
Tuple,
TypeVar,
Union,
cast,
no_type_check,
)
from decorator import decorate
@ -29,67 +46,51 @@ try:
import ujson as json
except ImportError:
import json # type: ignore[no-redef] # noqa: F723
import logging
from datetime import datetime
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import serialization
from telegram import (
User,
Message,
Update,
Animation,
Audio,
BotCommand,
Chat,
ChatMember,
UserProfilePhotos,
File,
ReplyMarkup,
TelegramObject,
WebhookInfo,
GameHighScore,
StickerSet,
PhotoSize,
Audio,
Document,
Sticker,
Video,
Animation,
Voice,
VideoNote,
Location,
Venue,
Contact,
InputFile,
Poll,
BotCommand,
InlineQueryResult,
InputMedia,
PassportElementError,
MaskPosition,
ChatPermissions,
ShippingOption,
LabeledPrice,
ChatPhoto,
Contact,
Document,
File,
GameHighScore,
InlineQueryResult,
InputFile,
InputMedia,
LabeledPrice,
Location,
MaskPosition,
Message,
PassportElementError,
PhotoSize,
Poll,
ReplyMarkup,
ShippingOption,
Sticker,
StickerSet,
TelegramObject,
Update,
User,
UserProfilePhotos,
Venue,
Video,
VideoNote,
Voice,
WebhookInfo,
)
from telegram.constants import MAX_INLINE_QUERY_RESULTS
from telegram.error import InvalidToken, TelegramError
from telegram.utils.helpers import to_timestamp, DEFAULT_NONE, DefaultValue
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue, to_timestamp
from telegram.utils.request import Request
from telegram.utils.types import JSONDict, FileLike
from typing import (
Any,
Callable,
Optional,
TypeVar,
Union,
TYPE_CHECKING,
List,
Tuple,
no_type_check,
IO,
cast,
)
from telegram.utils.types import FileLike, JSONDict
if TYPE_CHECKING:
from telegram.ext import Defaults
@ -98,6 +99,7 @@ RT = TypeVar('RT')
def info(func: Callable[..., RT]) -> Callable[..., RT]:
# pylint: disable=W0212
@functools.wraps(func)
def decorator(self: 'Bot', *args: Any, **kwargs: Any) -> RT:
if not self.bot:
@ -264,7 +266,7 @@ class Bot(TelegramObject):
result = self._post(endpoint, data, timeout=timeout, api_kwargs=api_kwargs)
if result is True:
return result # type: ignore
return result
return Message.de_json(result, self) # type: ignore[arg-type]
@ -1346,7 +1348,7 @@ class Bot(TelegramObject):
"Either location or latitude and longitude must be passed as" "argument."
)
if not ((latitude is not None or longitude is not None) ^ bool(location)):
if not (latitude is not None or longitude is not None) ^ bool(location):
raise ValueError(
"Either location or latitude and longitude must be passed as" "argument. Not both."
)
@ -1417,7 +1419,7 @@ class Bot(TelegramObject):
raise ValueError(
"Either location or latitude and longitude must be passed as" "argument."
)
if not ((latitude is not None or longitude is not None) ^ bool(location)):
if not (latitude is not None or longitude is not None) ^ bool(location):
raise ValueError(
"Either location or latitude and longitude must be passed as" "argument. Not both."
)
@ -1831,6 +1833,7 @@ class Bot(TelegramObject):
@no_type_check
def _set_defaults(res):
# pylint: disable=W0212
if res._has_parse_mode and res.parse_mode == DEFAULT_NONE:
if self.defaults:
res.parse_mode = self.defaults.parse_mode
@ -3207,7 +3210,7 @@ class Bot(TelegramObject):
"""
ok = bool(ok)
if not (ok ^ (error_message is not None)):
if not (ok ^ (error_message is not None)): # pylint: disable=C0325
raise TelegramError(
'answerPreCheckoutQuery: If ok is True, there should '
'not be error_message; if ok is False, error_message '
@ -4079,7 +4082,7 @@ class Bot(TelegramObject):
question: str,
options: List[str],
is_anonymous: bool = True,
type: str = Poll.REGULAR,
type: str = Poll.REGULAR, # pylint: disable=W0622
allows_multiple_answers: bool = False,
correct_option_id: int = None,
is_closed: bool = None,

5
telegram/botcommand.py
View file

@ -18,9 +18,10 @@
# 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 Bot Command."""
from telegram import TelegramObject
from typing import Any
from telegram import TelegramObject
class BotCommand(TelegramObject):
"""
@ -39,7 +40,7 @@ class BotCommand(TelegramObject):
description (:obj:`str`): Description of the command, 3-256 characters.
"""
def __init__(self, command: str, description: str, **kwargs: Any):
def __init__(self, command: str, description: str, **kwargs: Any): # pylint: disable=W0613
self.command = command
self.description = description

112
telegram/callbackquery.py
View file

@ -16,14 +16,15 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=W0622
"""This module contains an object that represents a Telegram CallbackQuery"""
from telegram import TelegramObject, Message, User
from typing import TYPE_CHECKING, Any, List, Optional, Union
from telegram import Message, TelegramObject, User
from telegram.utils.types import JSONDict
from typing import Optional, Any, Union, TYPE_CHECKING, List
if TYPE_CHECKING:
from telegram import Bot, InlineKeyboardMarkup, GameHighScore
from telegram import Bot, GameHighScore, InlineKeyboardMarkup
class CallbackQuery(TelegramObject):
@ -79,8 +80,8 @@ class CallbackQuery(TelegramObject):
"""
def __init__(
self,
id: str,
self, # pylint: disable=W0613
id: str, # pylint: disable=W0622
from_user: User,
chat_instance: str,
message: Message = None,
@ -91,7 +92,7 @@ class CallbackQuery(TelegramObject):
**kwargs: Any,
):
# Required
self.id = id
self.id = id # pylint: disable=C0103
self.from_user = from_user
self.chat_instance = chat_instance
# Optionals
@ -148,14 +149,13 @@ class CallbackQuery(TelegramObject):
return self.bot.edit_message_text(
text, inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.edit_message_text(
text,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
return self.bot.edit_message_text(
text,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
def edit_message_caption(
self, caption: str, *args: Any, **kwargs: Any
@ -182,30 +182,34 @@ class CallbackQuery(TelegramObject):
return self.bot.edit_message_caption(
caption=caption, inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.edit_message_caption(
caption=caption,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
return self.bot.edit_message_caption(
caption=caption,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
def edit_message_reply_markup(
self, reply_markup: 'InlineKeyboardMarkup', *args: Any, **kwargs: Any
) -> Union[Message, bool]:
"""Shortcut for either::
bot.edit_message_reply_markup(chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.message_id,
reply_markup=reply_markup,
*args, **kwargs)
bot.edit_message_reply_markup(
chat_id=update.callback_query.message.chat_id,
message_id=update.callback_query.message.message_id,
reply_markup=reply_markup,
*args, **kwargs
)
or::
bot.edit_message_reply_markup(inline_message_id=update.callback_query.inline_message_id,
reply_markup=reply_markup,
*args, **kwargs)
bot.edit_message_reply_markup
inline_message_id=update.callback_query.inline_message_id,
reply_markup=reply_markup,
*args,
**kwargs
)
Returns:
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
@ -219,14 +223,13 @@ class CallbackQuery(TelegramObject):
*args,
**kwargs,
)
else:
return self.bot.edit_message_reply_markup(
reply_markup=reply_markup,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
return self.bot.edit_message_reply_markup(
reply_markup=reply_markup,
chat_id=self.message.chat_id,
message_id=self.message.message_id,
*args,
**kwargs,
)
def edit_message_media(self, *args: Any, **kwargs: Any) -> Union[Message, bool]:
"""Shortcut for either::
@ -251,10 +254,9 @@ class CallbackQuery(TelegramObject):
return self.bot.edit_message_media(
inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.edit_message_media(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
return self.bot.edit_message_media(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
def edit_message_live_location(self, *args: Any, **kwargs: Any) -> Union[Message, bool]:
"""Shortcut for either::
@ -281,10 +283,9 @@ class CallbackQuery(TelegramObject):
return self.bot.edit_message_live_location(
inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.edit_message_live_location(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
return self.bot.edit_message_live_location(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
def stop_message_live_location(self, *args: Any, **kwargs: Any) -> Union[Message, bool]:
"""Shortcut for either::
@ -311,10 +312,9 @@ class CallbackQuery(TelegramObject):
return self.bot.stop_message_live_location(
inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.stop_message_live_location(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
return self.bot.stop_message_live_location(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
def set_game_score(self, *args: Any, **kwargs: Any) -> Union[Message, bool]:
"""Shortcut for either::
@ -339,10 +339,9 @@ class CallbackQuery(TelegramObject):
return self.bot.set_game_score(
inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.set_game_score(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
return self.bot.set_game_score(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
def get_game_high_scores(self, *args: Any, **kwargs: Any) -> List['GameHighScore']:
"""Shortcut for either::
@ -366,7 +365,6 @@ class CallbackQuery(TelegramObject):
return self.bot.get_game_high_scores(
inline_message_id=self.inline_message_id, *args, **kwargs
)
else:
return self.bot.get_game_high_scores(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)
return self.bot.get_game_high_scores(
chat_id=self.message.chat_id, message_id=self.message.message_id, *args, **kwargs
)

15
telegram/chat.py
View file

@ -19,14 +19,15 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Chat."""
from telegram import TelegramObject, ChatPhoto, constants
from typing import TYPE_CHECKING, Any, List, Optional, ClassVar
from telegram import ChatPhoto, TelegramObject, constants
from telegram.utils.types import JSONDict
from .chatpermissions import ChatPermissions
from telegram.utils.types import JSONDict
from typing import Any, Optional, List, TYPE_CHECKING, ClassVar
if TYPE_CHECKING:
from telegram import Bot, Message, ChatMember
from telegram import Bot, ChatMember, Message
class Chat(TelegramObject):
@ -102,7 +103,7 @@ class Chat(TelegramObject):
""":const:`telegram.constants.CHAT_CHANNEL`"""
def __init__(
self,
self, # pylint: disable=W0613
id: int,
type: str,
title: str = None,
@ -173,7 +174,7 @@ class Chat(TelegramObject):
return None
data['photo'] = ChatPhoto.de_json(data.get('photo'), bot)
from telegram import Message
from telegram import Message # pylint: disable=C0415
data['pinned_message'] = Message.de_json(data.get('pinned_message'), bot)
data['permissions'] = ChatPermissions.de_json(data.get('permissions'), bot)

9
telegram/chatmember.py
View file

@ -18,12 +18,11 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram ChatMember."""
import datetime
from typing import TYPE_CHECKING, Any, Optional, ClassVar
from telegram import User, TelegramObject, constants
from telegram.utils.helpers import to_timestamp, from_timestamp
from telegram import TelegramObject, User, constants
from telegram.utils.helpers import from_timestamp, to_timestamp
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING, ClassVar
if TYPE_CHECKING:
from telegram import Bot
@ -126,7 +125,7 @@ class ChatMember(TelegramObject):
""":const:`telegram.constants.CHATMEMBER_RESTRICTED`"""
def __init__(
self,
self, # pylint: disable=W0613
user: User,
status: str,
until_date: datetime.datetime = None,

5
telegram/chatpermissions.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram ChatPermission."""
from telegram import TelegramObject
from typing import Any
from telegram import TelegramObject
class ChatPermissions(TelegramObject):
"""Describes actions that a non-administrator user is allowed to take in a chat.
@ -78,7 +79,7 @@ class ChatPermissions(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
can_send_messages: bool = None,
can_send_media_messages: bool = None,
can_send_polls: bool = None,

9
telegram/choseninlineresult.py
View file

@ -1,5 +1,5 @@
#!/usr/bin/env python
# pylint: disable=R0902,R0912,R0913
# pylint: disable=R0902,R0913
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2020
@ -19,9 +19,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram ChosenInlineResult."""
from telegram import TelegramObject, User, Location
from typing import TYPE_CHECKING, Any, Optional
from telegram import Location, TelegramObject, User
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot
@ -63,7 +64,7 @@ class ChosenInlineResult(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
result_id: str,
from_user: User,
query: str,

5
telegram/dice.py
View file

@ -18,9 +18,10 @@
# 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 Dice."""
from telegram import TelegramObject, constants
from typing import Any, List, ClassVar
from telegram import TelegramObject, constants
class Dice(TelegramObject):
"""
@ -49,7 +50,7 @@ class Dice(TelegramObject):
emoji (:obj:`str`): Emoji on which the dice throw animation is based.
"""
def __init__(self, value: int, emoji: str, **kwargs: Any):
def __init__(self, value: int, emoji: str, **kwargs: Any): # pylint: disable=W0613
self.value = value
self.emoji = emoji

4
telegram/error.py
View file

@ -16,6 +16,7 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=C0115
"""This module contains an object that represents Telegram errors."""
from typing import Tuple
@ -123,8 +124,5 @@ class Conflict(TelegramError):
"""
def __init__(self, msg: str):
super().__init__(msg)
def __reduce__(self) -> Tuple[type, Tuple[str]]:
return self.__class__, (self.message,)

15
telegram/ext/basepersistence.py
View file

@ -21,10 +21,10 @@
from abc import ABC, abstractmethod
from collections import defaultdict
from copy import copy
from typing import Any, DefaultDict, Dict, Optional, Tuple, cast, ClassVar
from telegram import Bot
from typing import DefaultDict, Dict, Any, Tuple, Optional, cast, ClassVar
from telegram.utils.types import ConversationDict
@ -73,7 +73,7 @@ class BasePersistence(ABC):
persistence class. Default is :obj:`True` .
"""
def __new__(cls, *args: Any, **kwargs: Any) -> 'BasePersistence':
def __new__(cls, *args: Any, **kwargs: Any) -> 'BasePersistence': # pylint: disable=W0613
instance = super().__new__(cls)
get_user_data = instance.get_user_data
get_chat_data = instance.get_chat_data
@ -150,8 +150,8 @@ class BasePersistence(ABC):
if isinstance(obj, (dict, defaultdict)):
new_obj = cast(dict, new_obj)
new_obj.clear()
for k, v in obj.items():
new_obj[cls.replace_bot(k)] = cls.replace_bot(v)
for k, val in obj.items():
new_obj[cls.replace_bot(k)] = cls.replace_bot(val)
return new_obj
if hasattr(obj, '__dict__'):
for attr_name, attr in new_obj.__dict__.items():
@ -168,7 +168,7 @@ class BasePersistence(ABC):
return obj
def insert_bot(self, obj: object) -> object:
def insert_bot(self, obj: object) -> object: # pylint: disable=R0911
"""
Replaces all instances of :attr:`REPLACED_BOT` that occur within the passed object with
:attr:`bot`. Currently, this handles objects of type ``list``, ``tuple``, ``set``,
@ -192,8 +192,8 @@ class BasePersistence(ABC):
if isinstance(obj, (dict, defaultdict)):
new_obj = cast(dict, new_obj)
new_obj.clear()
for k, v in obj.items():
new_obj[self.insert_bot(k)] = self.insert_bot(v)
for k, val in obj.items():
new_obj[self.insert_bot(k)] = self.insert_bot(val)
return new_obj
if hasattr(obj, '__dict__'):
for attr_name, attr in new_obj.__dict__.items():
@ -300,7 +300,6 @@ class BasePersistence(ABC):
persistence a chance to finish up saving or close a database connection gracefully. If this
is not of any importance just pass will be sufficient.
"""
pass
REPLACED_BOT: ClassVar[str] = 'bot_instance_replaced_by_ptb_persistence'
""":obj:`str`: Placeholder for :class:`telegram.Bot` instances replaced in saved data."""

7
telegram/ext/callbackcontext.py
View file

@ -16,9 +16,10 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=R0201
"""This module contains the CallbackContext class."""
from queue import Queue
from typing import Dict, Any, Tuple, TYPE_CHECKING, Optional, Match, List, NoReturn, Union
from typing import TYPE_CHECKING, Any, Dict, List, Match, NoReturn, Optional, Tuple, Union
from telegram import Update
@ -165,9 +166,9 @@ class CallbackContext:
user = update.effective_user
if chat:
self._chat_data = dispatcher.chat_data[chat.id]
self._chat_data = dispatcher.chat_data[chat.id] # pylint: disable=W0212
if user:
self._user_data = dispatcher.user_data[user.id]
self._user_data = dispatcher.user_data[user.id] # pylint: disable=W0212
return self
@classmethod

22
telegram/ext/callbackqueryhandler.py
View file

@ -19,24 +19,24 @@
"""This module contains the CallbackQueryHandler class."""
import re
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from typing import (
Callable,
TYPE_CHECKING,
Any,
Optional,
Union,
TypeVar,
Pattern,
Match,
Callable,
Dict,
Match,
Optional,
Pattern,
TypeVar,
Union,
cast,
)
from telegram import Update
from telegram.utils.types import HandlerArg
from .handler import Handler
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher

7
telegram/ext/choseninlineresulthandler.py
View file

@ -18,11 +18,12 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the ChosenInlineResultHandler class."""
from telegram import Update
from .handler import Handler
from typing import Optional, TypeVar, Union
from telegram import Update
from telegram.utils.types import HandlerArg
from typing import Optional, Union, TypeVar
from .handler import Handler
RT = TypeVar('RT')

32
telegram/ext/commandhandler.py
View file

@ -19,15 +19,14 @@
"""This module contains the CommandHandler and PrefixHandler classes."""
import re
import warnings
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union
from telegram.ext import Filters, BaseFilter
from telegram import MessageEntity, Update
from telegram.ext import BaseFilter, Filters
from telegram.utils.deprecate import TelegramDeprecationWarning
from telegram import Update, MessageEntity
from .handler import Handler
from telegram.utils.types import HandlerArg
from typing import Callable, TYPE_CHECKING, Any, Optional, Union, TypeVar, Dict, List, Tuple
from .handler import Handler
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher
@ -212,8 +211,7 @@ class CommandHandler(Handler):
filter_result = self.filters(update)
if filter_result:
return args, filter_result
else:
return False
return False
return None
def collect_optional_args(
@ -270,9 +268,6 @@ class PrefixHandler(CommandHandler):
use ~``Filters.update.edited_message``.
Attributes:
prefix (:obj:`str` | List[:obj:`str`]): The prefix(es) that will precede :attr:`command`.
command (:obj:`str` | List[:obj:`str`]): The command or list of commands this handler
should listen for.
callback (:obj:`callable`): The callback function for this handler.
filters (:class:`telegram.ext.BaseFilter`): Optional. Only allow updates with these
Filters.
@ -380,6 +375,12 @@ class PrefixHandler(CommandHandler):
@property
def prefix(self) -> List[str]:
"""
The prefixes that will precede :attr:`command`.
Returns:
List[:obj:`str`]
"""
return self._prefix
@prefix.setter
@ -392,6 +393,12 @@ class PrefixHandler(CommandHandler):
@property # type: ignore[override]
def command(self) -> List[str]: # type: ignore[override]
"""
The list of commands this handler should listen for.
Returns:
List[:obj:`str`]
"""
return self._command
@command.setter
@ -427,8 +434,7 @@ class PrefixHandler(CommandHandler):
filter_result = self.filters(update)
if filter_result:
return text_list[1:], filter_result
else:
return False
return False
return None
def collect_additional_context(

61
telegram/ext/conversationhandler.py
View file

@ -16,26 +16,26 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=R0201
"""This module contains the ConversationHandler."""
import logging
import warnings
from threading import Lock
from typing import TYPE_CHECKING, Any, Dict, List, NoReturn, Optional, Tuple, cast, ClassVar
from telegram import Update
from telegram.ext import (
Handler,
CallbackQueryHandler,
InlineQueryHandler,
ChosenInlineResultHandler,
CallbackContext,
BasePersistence,
CallbackContext,
CallbackQueryHandler,
ChosenInlineResultHandler,
DispatcherHandlerStop,
Handler,
InlineQueryHandler,
)
from telegram.utils.promise import Promise
from telegram.utils.types import ConversationDict, HandlerArg
from typing import Dict, Any, List, Optional, Tuple, TYPE_CHECKING, cast, NoReturn, ClassVar
if TYPE_CHECKING:
from telegram.ext import Dispatcher, Job
@ -176,7 +176,7 @@ class ConversationHandler(Handler):
WAITING: ClassVar[int] = -3
""":obj:`int`: Used as a constant to handle state when a conversation is still waiting on the
previous ``@run_sync`` decorated running handler to finish."""
# pylint: disable=W0231
def __init__(
self,
entry_points: List[Handler],
@ -389,7 +389,7 @@ class ConversationHandler(Handler):
return tuple(key)
def check_update(self, update: HandlerArg) -> CheckUpdateType:
def check_update(self, update: HandlerArg) -> CheckUpdateType: # pylint: disable=R0911
"""
Determines whether an update should be handled by this conversationhandler, and if so in
which state the conversation currently is.
@ -401,18 +401,16 @@ class ConversationHandler(Handler):
:obj:`bool`
"""
if not isinstance(update, Update):
return None
# Ignore messages in channels
if (
not isinstance(update, Update)
or update.channel_post
or self.per_chat
and not update.effective_chat
or self.per_message
and not update.callback_query
or update.callback_query
and self.per_chat
and not update.callback_query.message
):
if update.channel_post:
return None
if self.per_chat and not update.effective_chat:
return None
if self.per_message and not update.callback_query:
return None
if update.callback_query and self.per_chat and not update.callback_query.message:
return None
key = self._get_key(update)
@ -430,7 +428,7 @@ class ConversationHandler(Handler):
res = res if res is not None else old_state
except Exception as exc:
self.logger.exception("Promise function raised exception")
self.logger.exception("{}".format(exc))
self.logger.exception("%s", exc)
res = old_state
finally:
if res is None and old_state is None:
@ -446,7 +444,7 @@ class ConversationHandler(Handler):
return key, hdlr, check
return None
self.logger.debug('selecting conversation {} with state {}'.format(str(key), str(state)))
self.logger.debug('selecting conversation %s with state %s', str(key), str(state))
handler = None
@ -515,8 +513,8 @@ class ConversationHandler(Handler):
timeout_job.schedule_removal()
try:
new_state = handler.handle_update(update, dispatcher, check_result, context)
except DispatcherHandlerStop as e:
new_state = e.state
except DispatcherHandlerStop as exception:
new_state = exception.state
raise_dp_handler_stop = True
with self._timeout_jobs_lock:
if self.conversation_timeout and new_state != self.END and dispatcher.job_queue:
@ -533,14 +531,13 @@ class ConversationHandler(Handler):
self.update_state(self.END, conversation_key)
if raise_dp_handler_stop:
raise DispatcherHandlerStop(self.map_to_parent.get(new_state))
else:
return self.map_to_parent.get(new_state)
else:
self.update_state(new_state, conversation_key)
if raise_dp_handler_stop:
# Don't pass the new state here. If we're in a nested conversation, the parent is
# expecting None as return value.
raise DispatcherHandlerStop()
return self.map_to_parent.get(new_state)
self.update_state(new_state, conversation_key)
if raise_dp_handler_stop:
# Don't pass the new state here. If we're in a nested conversation, the parent is
# expecting None as return value.
raise DispatcherHandlerStop()
return None
def update_state(self, new_state: object, key: Tuple[int, ...]) -> None:

4
telegram/ext/defaults.py
View file

@ -16,9 +16,11 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=R0201, E0401
"""This module contains the class Defaults, which allows to pass default values to Updater."""
from typing import Any, NoReturn, Optional, Union
import pytz
from typing import Union, Optional, Any, NoReturn
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue

42
telegram/ext/dictpersistence.py
View file

@ -19,21 +19,21 @@
"""This module contains the DictPersistence class."""
from copy import deepcopy
from typing import Any, DefaultDict, Dict, Optional, Tuple
from collections import defaultdict
from telegram.utils.helpers import (
decode_user_chat_data_from_json,
decode_conversations_from_json,
decode_user_chat_data_from_json,
encode_conversations_to_json,
)
from telegram.ext import BasePersistence
from telegram.utils.types import ConversationDict
try:
import ujson as json
except ImportError:
import json # type: ignore[no-redef]
from collections import defaultdict
from telegram.ext import BasePersistence
from typing import DefaultDict, Dict, Any, Tuple, Optional
from telegram.utils.types import ConversationDict
class DictPersistence(BasePersistence):
@ -106,20 +106,20 @@ class DictPersistence(BasePersistence):
try:
self._user_data = decode_user_chat_data_from_json(user_data_json)
self._user_data_json = user_data_json
except (ValueError, AttributeError):
raise TypeError("Unable to deserialize user_data_json. Not valid JSON")
except (ValueError, AttributeError) as exc:
raise TypeError("Unable to deserialize user_data_json. Not valid JSON") from exc
if chat_data_json:
try:
self._chat_data = decode_user_chat_data_from_json(chat_data_json)
self._chat_data_json = chat_data_json
except (ValueError, AttributeError):
raise TypeError("Unable to deserialize chat_data_json. Not valid JSON")
except (ValueError, AttributeError) as exc:
raise TypeError("Unable to deserialize chat_data_json. Not valid JSON") from exc
if bot_data_json:
try:
self._bot_data = json.loads(bot_data_json)
self._bot_data_json = bot_data_json
except (ValueError, AttributeError):
raise TypeError("Unable to deserialize bot_data_json. Not valid JSON")
except (ValueError, AttributeError) as exc:
raise TypeError("Unable to deserialize bot_data_json. Not valid JSON") from exc
if not isinstance(self._bot_data, dict):
raise TypeError("bot_data_json must be serialized dict")
@ -127,8 +127,10 @@ class DictPersistence(BasePersistence):
try:
self._conversations = decode_conversations_from_json(conversations_json)
self._conversations_json = conversations_json
except (ValueError, AttributeError):
raise TypeError("Unable to deserialize conversations_json. Not valid JSON")
except (ValueError, AttributeError) as exc:
raise TypeError(
"Unable to deserialize conversations_json. Not valid JSON"
) from exc
@property
def user_data(self) -> Optional[DefaultDict[int, Dict]]:
@ -140,8 +142,7 @@ class DictPersistence(BasePersistence):
""":obj:`str`: The user_data serialized as a JSON-string."""
if self._user_data_json:
return self._user_data_json
else:
return json.dumps(self.user_data)
return json.dumps(self.user_data)
@property
def chat_data(self) -> Optional[DefaultDict[int, Dict]]:
@ -153,8 +154,7 @@ class DictPersistence(BasePersistence):
""":obj:`str`: The chat_data serialized as a JSON-string."""
if self._chat_data_json:
return self._chat_data_json
else:
return json.dumps(self.chat_data)
return json.dumps(self.chat_data)
@property
def bot_data(self) -> Optional[Dict]:
@ -166,8 +166,7 @@ class DictPersistence(BasePersistence):
""":obj:`str`: The bot_data serialized as a JSON-string."""
if self._bot_data_json:
return self._bot_data_json
else:
return json.dumps(self.bot_data)
return json.dumps(self.bot_data)
@property
def conversations(self) -> Optional[Dict[str, Dict[Tuple, Any]]]:
@ -179,8 +178,7 @@ class DictPersistence(BasePersistence):
""":obj:`str`: The conversations serialized as a JSON-string."""
if self._conversations_json:
return self._conversations_json
else:
return encode_conversations_to_json(self.conversations) # type: ignore[arg-type]
return encode_conversations_to_json(self.conversations) # type: ignore[arg-type]
def get_user_data(self) -> DefaultDict[int, Dict[Any, Any]]:
"""Returns the user_data created from the ``user_data_json`` or an empty

60
telegram/ext/dispatcher.py
View file

@ -21,23 +21,20 @@
import logging
import warnings
import weakref
from functools import wraps
from threading import Thread, Lock, Event, current_thread, BoundedSemaphore
from time import sleep
from uuid import uuid4
from collections import defaultdict
from queue import Queue, Empty
from functools import wraps
from queue import Empty, Queue
from threading import BoundedSemaphore, Event, Lock, Thread, current_thread
from time import sleep
from typing import TYPE_CHECKING, Any, Callable, DefaultDict, Dict, List, Optional, Set, Union
from uuid import uuid4
from telegram import TelegramError, Update
from telegram.ext.handler import Handler
from telegram.ext import BasePersistence
from telegram.ext.callbackcontext import CallbackContext
from telegram.ext.handler import Handler
from telegram.utils.deprecate import TelegramDeprecationWarning
from telegram.utils.promise import Promise
from telegram.ext import BasePersistence
from typing import Any, Callable, TYPE_CHECKING, Optional, Union, DefaultDict, Dict, List, Set
from telegram.utils.types import HandlerArg
if TYPE_CHECKING:
@ -74,7 +71,7 @@ def run_async(
TelegramDeprecationWarning,
stacklevel=2,
)
return Dispatcher.get_instance()._run_async(
return Dispatcher.get_instance()._run_async( # pylint: disable=W0212
func, *args, update=None, error_handling=False, **kwargs
)
@ -245,10 +242,7 @@ class Dispatcher:
"""
if cls.__singleton is not None:
return cls.__singleton() # type: ignore[return-value] # pylint: disable=not-callable
else:
raise RuntimeError(
'{} not initialized or multiple instances exist'.format(cls.__name__)
)
raise RuntimeError('{} not initialized or multiple instances exist'.format(cls.__name__))
def _pooled(self) -> None:
thr_name = current_thread().getName()
@ -328,7 +322,7 @@ class Dispatcher:
*args: Any,
update: HandlerArg = None,
error_handling: bool = True,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
) -> Promise:
# TODO: Remove error_handling parameter once we drop the @run_async decorator
promise = Promise(func, args, kwargs, update=update, error_handling=error_handling)
@ -371,12 +365,12 @@ class Dispatcher:
if self.__stop_event.is_set():
self.logger.debug('orderly stopping')
break
elif self.__exception_event.is_set():
if self.__exception_event.is_set():
self.logger.critical('stopping due to exception in another thread')
break
continue
self.logger.debug('Processing Update: %s' % update)
self.logger.debug('Processing Update: %s', update)
self.process_update(update)
self.update_queue.task_done()
@ -401,10 +395,10 @@ class Dispatcher:
self.__async_queue.put(None)
for i, thr in enumerate(threads):
self.logger.debug('Waiting for async thread {}/{} to end'.format(i + 1, total))
self.logger.debug('Waiting for async thread %s/%s to end', i + 1, total)
thr.join()
self.__async_threads.remove(thr)
self.logger.debug('async thread {}/{} has ended'.format(i + 1, total))
self.logger.debug('async thread %s/%s has ended', i + 1, total)
@property
def has_running_threads(self) -> bool:
@ -450,9 +444,9 @@ class Dispatcher:
break
# Dispatch any error.
except Exception as e:
except Exception as exc:
try:
self.dispatch_error(update, e)
self.dispatch_error(update, exc)
except DispatcherHandlerStop:
self.logger.debug('Error handler stopped further handlers')
break
@ -486,7 +480,7 @@ class Dispatcher:
"""
# Unfortunately due to circular imports this has to be here
from .conversationhandler import ConversationHandler
from .conversationhandler import ConversationHandler # pylint: disable=C0415
if not isinstance(handler, Handler):
raise TypeError('handler is not an instance of {}'.format(Handler.__name__))
@ -552,9 +546,9 @@ class Dispatcher:
if self.persistence.store_bot_data:
try:
self.persistence.update_bot_data(self.bot_data)
except Exception as e:
except Exception as exc:
try:
self.dispatch_error(update, e)
self.dispatch_error(update, exc)
except Exception:
message = (
'Saving bot data raised an error and an '
@ -566,9 +560,9 @@ class Dispatcher:
for chat_id in chat_ids:
try:
self.persistence.update_chat_data(chat_id, self.chat_data[chat_id])
except Exception as e:
except Exception as exc:
try:
self.dispatch_error(update, e)
self.dispatch_error(update, exc)
except Exception:
message = (
'Saving chat data raised an error and an '
@ -580,9 +574,9 @@ class Dispatcher:
for user_id in user_ids:
try:
self.persistence.update_user_data(user_id, self.user_data[user_id])
except Exception as e:
except Exception as exc:
try:
self.dispatch_error(update, e)
self.dispatch_error(update, exc)
except Exception:
message = (
'Saving user data raised an error and an '
@ -592,7 +586,9 @@ class Dispatcher:
self.logger.exception(message)
def add_error_handler(
self, callback: Callable[[Any, CallbackContext], None], run_async: bool = False
self,
callback: Callable[[Any, CallbackContext], None],
run_async: bool = False, # pylint: disable=W0621
) -> None:
"""Registers an error handler in the Dispatcher. This handler will receive every error
which happens in your bot.
@ -647,7 +643,7 @@ class Dispatcher:
async_kwargs = None if not promise else promise.kwargs
if self.error_handlers:
for callback, run_async in self.error_handlers.items():
for callback, run_async in self.error_handlers.items(): # pylint: disable=W0621
if self.use_context:
context = CallbackContext.from_error(
update, error, self, async_args=async_args, async_kwargs=async_kwargs

35
telegram/ext/filters.py
View file

@ -16,6 +16,7 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=C0112, C0103, W0221
"""This module contains the Filters for use with the MessageHandler class."""
import re
@ -23,10 +24,9 @@ import warnings
from abc import ABC, abstractmethod
from threading import Lock
from typing import Dict, FrozenSet, List, Match, Optional, Pattern, Set, Union, cast
from telegram import Chat, Update, MessageEntity, Message
from typing import Optional, Dict, Union, List, Pattern, Match, cast, Set, FrozenSet
from telegram import Chat, Message, MessageEntity, Update
__all__ = [
'Filters',
@ -223,7 +223,8 @@ class MergedFilter(UpdateFilter):
if self.or_filter and not isinstance(self.and_filter, bool) and self.or_filter.data_filter:
self.data_filter = True
def _merge(self, base_output: Union[bool, Dict], comp_output: Union[bool, Dict]) -> Dict:
@staticmethod
def _merge(base_output: Union[bool, Dict], comp_output: Union[bool, Dict]) -> Dict:
base = base_output if isinstance(base_output, dict) else {}
comp = comp_output if isinstance(comp_output, dict) else {}
for k in comp.keys():
@ -239,7 +240,7 @@ class MergedFilter(UpdateFilter):
base[k] = comp_value
return base
def filter(self, update: Update) -> Union[bool, Dict]:
def filter(self, update: Update) -> Union[bool, Dict]: # pylint: disable=R0911
base_output = self.base_filter(update)
# We need to check if the filters are data filters and if so return the merged data.
# If it's not a data filter or an or_filter but no matches return bool
@ -259,12 +260,12 @@ class MergedFilter(UpdateFilter):
if self.data_filter:
return base_output
return True
else:
comp_output = self.or_filter(update)
if comp_output:
if self.data_filter:
return comp_output
return True
comp_output = self.or_filter(update)
if comp_output:
if self.data_filter:
return comp_output
return True
return False
def __repr__(self) -> str:
@ -296,8 +297,7 @@ class _DiceEmoji(MessageFilter):
) -> Union[bool, '_DiceValues']:
if isinstance(update, Update):
return self.filter(update.effective_message)
else:
return self._DiceValues(update, self.name, emoji=self.emoji)
return self._DiceValues(update, self.name, emoji=self.emoji)
def filter(self, message: Message) -> bool:
if bool(message.dice):
@ -344,8 +344,7 @@ class Filters:
) -> Union[bool, '_TextStrings']:
if isinstance(update, Update):
return self.filter(update.effective_message)
else:
return self._TextStrings(update)
return self._TextStrings(update)
def filter(self, message: Message) -> bool:
return bool(message.text)
@ -396,8 +395,7 @@ class Filters:
) -> Union[bool, '_CaptionStrings']:
if isinstance(update, Update):
return self.filter(update.effective_message)
else:
return self._CaptionStrings(update)
return self._CaptionStrings(update)
def filter(self, message: Message) -> bool:
return bool(message.caption)
@ -433,8 +431,7 @@ class Filters:
) -> Union[bool, '_CommandOnlyStart']:
if isinstance(update, Update):
return self.filter(update.effective_message)
else:
return self._CommandOnlyStart(update)
return self._CommandOnlyStart(update)
def filter(self, message: Message) -> bool:
return bool(

28
telegram/ext/handler.py
View file

@ -19,11 +19,11 @@
"""This module contains the base class for handlers as used by the Dispatcher."""
from abc import ABC, abstractmethod
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, TypeVar, Union
from telegram import Update
from telegram.utils.promise import Promise
from telegram.utils.types import HandlerArg
from telegram import Update
from typing import Callable, TYPE_CHECKING, Any, Optional, Union, TypeVar, Dict
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher
@ -147,16 +147,14 @@ class Handler(ABC):
self.collect_additional_context(context, update, dispatcher, check_result)
if self.run_async:
return dispatcher.run_async(self.callback, update, context, update=update)
else:
return self.callback(update, context)
else:
optional_args = self.collect_optional_args(dispatcher, update, check_result)
if self.run_async:
return dispatcher.run_async(
self.callback, dispatcher.bot, update, update=update, **optional_args
)
else:
return self.callback(dispatcher.bot, update, **optional_args) # type: ignore
return self.callback(update, context)
optional_args = self.collect_optional_args(dispatcher, update, check_result)
if self.run_async:
return dispatcher.run_async(
self.callback, dispatcher.bot, update, update=update, **optional_args
)
return self.callback(dispatcher.bot, update, **optional_args) # type: ignore
def collect_additional_context(
self,
@ -174,10 +172,12 @@ class Handler(ABC):
check_result: The result (return value) from :attr:`check_update`.
"""
pass
def collect_optional_args(
self, dispatcher: 'Dispatcher', update: HandlerArg = None, check_result: Any = None
self,
dispatcher: 'Dispatcher',
update: HandlerArg = None,
check_result: Any = None, # pylint: disable=W0613
) -> Dict[str, Any]:
"""
Prepares the optional arguments. If the handler has additional optional args,

21
telegram/ext/inlinequeryhandler.py
View file

@ -18,25 +18,24 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
""" This module contains the InlineQueryHandler class """
import re
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from typing import (
Callable,
TYPE_CHECKING,
Any,
Optional,
Union,
TypeVar,
Callable,
Dict,
Pattern,
Match,
Optional,
Pattern,
TypeVar,
Union,
cast,
)
from telegram import Update
from telegram.utils.types import HandlerArg
from .handler import Handler
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher

36
telegram/ext/jobqueue.py
View file

@ -16,25 +16,25 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=E0401
"""This module contains the classes JobQueue and Job."""
import datetime
import logging
import pytz
from typing import TYPE_CHECKING, Any, Callable, List, Optional, Tuple, Union, cast, overload
import pytz
from apscheduler.events import EVENT_JOB_ERROR, EVENT_JOB_EXECUTED, JobEvent
from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.triggers.cron import CronTrigger
from apscheduler.triggers.combining import OrTrigger
from apscheduler.events import EVENT_JOB_EXECUTED, EVENT_JOB_ERROR, JobEvent
from apscheduler.triggers.cron import CronTrigger
from telegram.ext.callbackcontext import CallbackContext
from typing import TYPE_CHECKING, Union, Callable, Tuple, Optional, List, Any, cast, overload
from telegram.utils.types import JSONDict
if TYPE_CHECKING:
from telegram.ext import Dispatcher
from telegram import Bot
from telegram.ext import Dispatcher
class Days:
@ -76,7 +76,7 @@ class JobQueue:
def _tz_now(self) -> datetime.datetime:
return datetime.datetime.now(self.scheduler.timezone)
def _update_persistence(self, event: JobEvent) -> None:
def _update_persistence(self, event: JobEvent) -> None: # pylint: disable=W0613
self._dispatcher.update_persistence()
def _dispatch_error(self, event: JobEvent) -> None:
@ -114,14 +114,14 @@ class JobQueue:
if isinstance(time, datetime.timedelta):
return self._tz_now() + time
if isinstance(time, datetime.time):
dt = datetime.datetime.combine(
date_time = datetime.datetime.combine(
datetime.datetime.now(tz=time.tzinfo or self.scheduler.timezone).date(), time
)
if dt.tzinfo is None:
dt = self.scheduler.timezone.localize(dt)
if shift_day and dt <= datetime.datetime.now(pytz.utc):
dt += datetime.timedelta(days=1)
return dt
if date_time.tzinfo is None:
date_time = self.scheduler.timezone.localize(date_time)
if shift_day and date_time <= datetime.datetime.now(pytz.utc):
date_time += datetime.timedelta(days=1)
return date_time
# isinstance(time, datetime.datetime):
return time
@ -190,15 +190,15 @@ class JobQueue:
name = name or callback.__name__
job = Job(callback, context, name, self)
dt = self._parse_time_input(when, shift_day=True)
date_time = self._parse_time_input(when, shift_day=True)
j = self.scheduler.add_job(
callback,
name=name,
trigger='date',
run_date=dt,
run_date=date_time,
args=self._build_args(job),
timezone=dt.tzinfo or self.scheduler.timezone,
timezone=date_time.tzinfo or self.scheduler.timezone,
**job_kwargs,
)
@ -568,9 +568,9 @@ class Job:
self.callback(CallbackContext.from_job(self, dispatcher))
else:
self.callback(dispatcher.bot, self) # type: ignore[arg-type,call-arg]
except Exception as e:
except Exception as exc:
try:
dispatcher.dispatch_error(None, e)
dispatcher.dispatch_error(None, exc)
# Errors should not stop the thread.
except Exception:
dispatcher.logger.exception(

11
telegram/ext/messagehandler.py
View file

@ -19,15 +19,14 @@
# TODO: Remove allow_edited
"""This module contains the MessageHandler class."""
import warnings
from telegram.utils.deprecate import TelegramDeprecationWarning
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, TypeVar, Union
from telegram import Update
from telegram.ext import Filters, BaseFilter
from .handler import Handler
from telegram.ext import BaseFilter, Filters
from telegram.utils.deprecate import TelegramDeprecationWarning
from telegram.utils.types import HandlerArg
from typing import Callable, TYPE_CHECKING, Any, Optional, Union, TypeVar, Dict
from .handler import Handler
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher

14
telegram/ext/messagequeue.py
View file

@ -20,14 +20,13 @@
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/]
"""A throughput-limiting message processor for Telegram bots."""
from telegram.utils import promise
import functools
import time
import threading
import queue as q
import threading
import time
from typing import TYPE_CHECKING, Any, Callable, List, NoReturn
from typing import Callable, Any, TYPE_CHECKING, List, NoReturn
from telegram.utils.promise import Promise
if TYPE_CHECKING:
from telegram import Bot
@ -39,8 +38,6 @@ curtime = time.perf_counter
class DelayQueueError(RuntimeError):
"""Indicates processing errors."""
pass
class DelayQueue(threading.Thread):
"""
@ -304,12 +301,13 @@ def queuedmessage(method: Callable) -> Callable:
@functools.wraps(method)
def wrapped(self: 'Bot', *args: Any, **kwargs: Any) -> Any:
# pylint: disable=W0212
queued = kwargs.pop(
'queued', self._is_messages_queued_default # type: ignore[attr-defined]
)
isgroup = kwargs.pop('isgroup', False)
if queued:
prom = promise.Promise(method, (self,) + args, kwargs)
prom = Promise(method, (self,) + args, kwargs)
return self._msg_queue(prom, isgroup) # type: ignore[attr-defined]
return method(self, *args, **kwargs)

41
telegram/ext/picklepersistence.py
View file

@ -20,10 +20,9 @@
import pickle
from collections import defaultdict
from copy import deepcopy
from typing import Any, DefaultDict, Dict, Optional, Tuple
from telegram.ext import BasePersistence
from typing import DefaultDict, Dict, Any, Tuple, Optional
from telegram.utils.types import ConversationDict
@ -99,8 +98,8 @@ class PicklePersistence(BasePersistence):
def load_singlefile(self) -> None:
try:
filename = self.filename
with open(self.filename, "rb") as f:
data = pickle.load(f)
with open(self.filename, "rb") as file:
data = pickle.load(file)
self.user_data = defaultdict(dict, data['user_data'])
self.chat_data = defaultdict(dict, data['chat_data'])
# For backwards compatibility with files not containing bot data
@ -111,35 +110,37 @@ class PicklePersistence(BasePersistence):
self.user_data = defaultdict(dict)
self.chat_data = defaultdict(dict)
self.bot_data = {}
except pickle.UnpicklingError:
raise TypeError("File {} does not contain valid pickle data".format(filename))
except Exception:
raise TypeError("Something went wrong unpickling {}".format(filename))
except pickle.UnpicklingError as exc:
raise TypeError("File {} does not contain valid pickle data".format(filename)) from exc
except Exception as exc:
raise TypeError("Something went wrong unpickling {}".format(filename)) from exc
def load_file(self, filename: str) -> Any:
@staticmethod
def load_file(filename: str) -> Any:
try:
with open(filename, "rb") as f:
return pickle.load(f)
with open(filename, "rb") as file:
return pickle.load(file)
except IOError:
return None
except pickle.UnpicklingError:
raise TypeError("File {} does not contain valid pickle data".format(filename))
except Exception:
raise TypeError("Something went wrong unpickling {}".format(filename))
except pickle.UnpicklingError as exc:
raise TypeError("File {} does not contain valid pickle data".format(filename)) from exc
except Exception as exc:
raise TypeError("Something went wrong unpickling {}".format(filename)) from exc
def dump_singlefile(self) -> None:
with open(self.filename, "wb") as f:
with open(self.filename, "wb") as file:
data = {
'conversations': self.conversations,
'user_data': self.user_data,
'chat_data': self.chat_data,
'bot_data': self.bot_data,
}
pickle.dump(data, f)
pickle.dump(data, file)
def dump_file(self, filename: str, data: Any) -> None:
with open(filename, "wb") as f:
pickle.dump(data, f)
@staticmethod
def dump_file(filename: str, data: Any) -> None:
with open(filename, "wb") as file:
pickle.dump(data, file)
def get_user_data(self) -> DefaultDict[int, Dict[Any, Any]]:
"""Returns the user_data from the pickle file if it exists or an empty :obj:`defaultdict`.

5
telegram/ext/pollanswerhandler.py
View file

@ -16,12 +16,13 @@
#
# 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 the PollAnswerHandler class."""
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from .handler import Handler
class PollAnswerHandler(Handler):
"""Handler class to handle Telegram updates that contain a poll answer.

5
telegram/ext/pollhandler.py
View file

@ -16,12 +16,13 @@
#
# 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 the PollHandler classes."""
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from .handler import Handler
class PollHandler(Handler):
"""Handler class to handle Telegram updates that contain a poll.

4
telegram/ext/precheckoutqueryhandler.py
View file

@ -19,10 +19,10 @@
"""This module contains the PreCheckoutQueryHandler class."""
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from .handler import Handler
class PreCheckoutQueryHandler(Handler):
"""Handler class to handle Telegram PreCheckout callback queries.

8
telegram/ext/regexhandler.py
View file

@ -20,13 +20,11 @@
"""This module contains the RegexHandler class."""
import warnings
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Pattern, TypeVar, Union
from telegram.ext import Filters, MessageHandler
from telegram.utils.deprecate import TelegramDeprecationWarning
from telegram.ext import MessageHandler, Filters
from telegram.utils.types import HandlerArg
from typing import Callable, TYPE_CHECKING, Any, Optional, Union, TypeVar, Dict, Pattern
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher
@ -119,7 +117,7 @@ class RegexHandler(MessageHandler):
pass_job_queue: bool = False,
pass_user_data: bool = False,
pass_chat_data: bool = False,
allow_edited: bool = False,
allow_edited: bool = False, # pylint: disable=W0613
message_updates: bool = True,
channel_post_updates: bool = False,
edited_updates: bool = False,

4
telegram/ext/shippingqueryhandler.py
View file

@ -19,10 +19,10 @@
"""This module contains the ShippingQueryHandler class."""
from telegram import Update
from .handler import Handler
from telegram.utils.types import HandlerArg
from .handler import Handler
class ShippingQueryHandler(Handler):
"""Handler class to handle Telegram shipping callback queries.

5
telegram/ext/stringcommandhandler.py
View file

@ -18,10 +18,11 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the StringCommandHandler class."""
from .handler import Handler
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, TypeVar
from telegram.utils.types import HandlerArg
from typing import Callable, TYPE_CHECKING, Any, Optional, TypeVar, Dict, List
from .handler import Handler
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher

6
telegram/ext/stringregexhandler.py
View file

@ -19,12 +19,12 @@
"""This module contains the StringRegexHandler class."""
import re
from typing import TYPE_CHECKING, Any, Callable, Dict, Match, Optional, Pattern, TypeVar, Union
from telegram.utils.types import HandlerArg
from .handler import Handler
from typing import Callable, TYPE_CHECKING, Optional, TypeVar, Match, Dict, Any, Union, Pattern
from telegram.utils.types import HandlerArg
if TYPE_CHECKING:
from telegram.ext import CallbackContext, Dispatcher

10
telegram/ext/typehandler.py
View file

@ -18,11 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the TypeHandler class."""
from typing import TYPE_CHECKING, Any, Callable, Type, TypeVar
from .handler import Handler
from typing import Callable, TYPE_CHECKING, TypeVar, Type, Any
if TYPE_CHECKING:
from telegram.ext import CallbackContext
@ -76,7 +75,7 @@ class TypeHandler(Handler):
def __init__(
self,
type: Type,
type: Type, # pylint: disable=W0622
callback: Callable[[Any, 'CallbackContext'], RT],
strict: bool = False,
pass_update_queue: bool = False,
@ -104,5 +103,4 @@ class TypeHandler(Handler):
"""
if not self.strict:
return isinstance(update, self.type)
else:
return type(update) is self.type
return type(update) is self.type # pylint: disable=C0123

40
telegram/ext/updater.py
View file

@ -21,20 +21,19 @@
import logging
import ssl
import warnings
from threading import Thread, Lock, current_thread, Event
from time import sleep
from signal import signal, SIGINT, SIGTERM, SIGABRT
from queue import Queue
from signal import SIGABRT, SIGINT, SIGTERM, signal
from threading import Event, Lock, Thread, current_thread
from time import sleep
from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Union, no_type_check
from telegram import Bot, TelegramError
from telegram.error import InvalidToken, RetryAfter, TimedOut, Unauthorized
from telegram.ext import Dispatcher, JobQueue
from telegram.error import Unauthorized, InvalidToken, RetryAfter, TimedOut
from telegram.utils.deprecate import TelegramDeprecationWarning
from telegram.utils.helpers import get_signal_name
from telegram.utils.request import Request
from telegram.utils.webhookhandler import WebhookServer, WebhookAppClass
from typing import Callable, Dict, TYPE_CHECKING, Any, List, Union, Tuple, no_type_check, Optional
from telegram.utils.webhookhandler import WebhookAppClass, WebhookServer
if TYPE_CHECKING:
from telegram.ext import BasePersistence, Defaults
@ -232,14 +231,14 @@ class Updater:
def _thread_wrapper(self, target: Callable, *args: Any, **kwargs: Any) -> None:
thr_name = current_thread().name
self.logger.debug('{} - started'.format(thr_name))
self.logger.debug('%s - started', thr_name)
try:
target(*args, **kwargs)
except Exception:
self.__exception_event.set()
self.logger.exception('unhandled exception in %s', thr_name)
raise
self.logger.debug('{} - ended'.format(thr_name))
self.logger.debug('%s - ended', thr_name)
def start_polling(
self,
@ -465,9 +464,9 @@ class Updater:
try:
if not action_cb():
break
except RetryAfter as e:
self.logger.info('%s', e)
cur_interval = 0.5 + e.retry_after
except RetryAfter as exc:
self.logger.info('%s', exc)
cur_interval = 0.5 + exc.retry_after
except TimedOut as toe:
self.logger.debug('Timed out %s: %s', description, toe)
# If failure is due to timeout, we should retry asap.
@ -475,9 +474,9 @@ class Updater:
except InvalidToken as pex:
self.logger.error('Invalid token; aborting')
raise pex
except TelegramError as te:
self.logger.error('Error while %s: %s', description, te)
onerr_cb(te)
except TelegramError as telegram_exc:
self.logger.error('Error while %s: %s', description, telegram_exc)
onerr_cb(telegram_exc)
cur_interval = self._increase_poll_interval(cur_interval)
else:
cur_interval = interval
@ -525,8 +524,8 @@ class Updater:
try:
ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
ssl_ctx.load_cert_chain(cert, key)
except ssl.SSLError:
raise TelegramError('Invalid SSL Certificate')
except ssl.SSLError as exc:
raise TelegramError('Invalid SSL Certificate') from exc
else:
ssl_ctx = None
@ -661,9 +660,9 @@ class Updater:
@no_type_check
def _join_threads(self) -> None:
for thr in self.__threads:
self.logger.debug('Waiting for {} thread to end'.format(thr.name))
self.logger.debug('Waiting for %s thread to end', thr.name)
thr.join()
self.logger.debug('{} thread has ended'.format(thr.name))
self.logger.debug('%s thread has ended', thr.name)
self.__threads = []
@no_type_check
@ -671,7 +670,7 @@ class Updater:
self.is_idle = False
if self.running:
self.logger.info(
'Received signal {} ({}), stopping...'.format(signum, get_signal_name(signum))
'Received signal %s (%s), stopping...', signum, get_signal_name(signum)
)
if self.persistence:
# Update user_data, chat_data and bot_data before flushing
@ -682,6 +681,7 @@ class Updater:
self.user_sig_handler(signum, frame)
else:
self.logger.warning('Exiting immediately!')
# pylint: disable=C0415,W0212
import os
os._exit(1)

7
telegram/files/animation.py
View file

@ -17,11 +17,10 @@
# 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 Animation."""
from telegram import PhotoSize
from telegram import TelegramObject
from typing import TYPE_CHECKING, Any, Optional
from telegram import PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -66,7 +65,7 @@ class Animation(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
width: int,

6
telegram/files/audio.py
View file

@ -18,10 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Audio."""
from telegram import TelegramObject, PhotoSize
from typing import TYPE_CHECKING, Any, Optional
from telegram import PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -67,7 +67,7 @@ class Audio(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
duration: int,

6
telegram/files/chatphoto.py
View file

@ -17,9 +17,9 @@
# 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 ChatPhoto."""
from telegram import TelegramObject
from typing import TYPE_CHECKING, Any
from typing import Any, TYPE_CHECKING
from telegram import TelegramObject
if TYPE_CHECKING:
from telegram import Bot, File
@ -63,7 +63,7 @@ class ChatPhoto(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
small_file_id: str,
small_file_unique_id: str,
big_file_id: str,

5
telegram/files/contact.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Contact."""
from telegram import TelegramObject
from typing import Any
from telegram import TelegramObject
class Contact(TelegramObject):
"""This object represents a phone contact.
@ -46,7 +47,7 @@ class Contact(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
phone_number: str,
first_name: str,
last_name: str = None,

6
telegram/files/document.py
View file

@ -18,10 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Document."""
from telegram import PhotoSize, TelegramObject
from typing import TYPE_CHECKING, Any, Optional
from telegram import PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -62,7 +62,7 @@ class Document(TelegramObject):
_id_keys = ('file_id',)
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
thumb: PhotoSize = None,

40
telegram/files/file.py
View file

@ -17,17 +17,15 @@
# 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 File."""
import os
import urllib.parse as urllib_parse
from base64 import b64decode
from os.path import basename
import os
import urllib.parse as urllib_parse
from typing import IO, TYPE_CHECKING, Any, Optional, Union
from telegram import TelegramObject
from telegram.passport.credentials import decrypt
from typing import Any, Optional, IO, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, FileCredentials
@ -70,7 +68,7 @@ class File(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
bot: 'Bot' = None,
@ -132,22 +130,22 @@ class File(TelegramObject):
)
out.write(buf)
return out
else:
if custom_path:
filename = custom_path
elif self.file_path:
filename = basename(self.file_path)
else:
filename = os.path.join(os.getcwd(), self.file_id)
buf = self.bot.request.retrieve(url, timeout=timeout)
if self._credentials:
buf = decrypt(
b64decode(self._credentials.secret), b64decode(self._credentials.hash), buf
)
with open(filename, 'wb') as fobj:
fobj.write(buf)
return filename
if custom_path:
filename = custom_path
elif self.file_path:
filename = basename(self.file_path)
else:
filename = os.path.join(os.getcwd(), self.file_id)
buf = self.bot.request.retrieve(url, timeout=timeout)
if self._credentials:
buf = decrypt(
b64decode(self._credentials.secret), b64decode(self._credentials.hash), buf
)
with open(filename, 'wb') as fobj:
fobj.write(buf)
return filename
def _get_encoded_url(self) -> str:
"""Convert any UTF-8 char in :obj:`File.file_path` into a url encoded ASCII string."""

3
telegram/files/inputfile.py
View file

@ -22,12 +22,11 @@
import imghdr
import mimetypes
import os
from typing import IO, Optional, Tuple
from uuid import uuid4
from telegram import TelegramError
from typing import IO, Tuple, Optional
DEFAULT_MIME_TYPE = 'application/octet-stream'

9
telegram/files/inputmedia.py
View file

@ -18,11 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""Base class for Telegram InputMedia Objects."""
from telegram import TelegramObject, InputFile, PhotoSize, Animation, Video, Audio, Document
from typing import IO, Union, cast
from telegram import Animation, Audio, Document, InputFile, PhotoSize, TelegramObject, Video
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Union, IO, cast
from telegram.utils.types import FileLike
@ -35,8 +34,6 @@ class InputMedia(TelegramObject):
"""
pass
class InputMediaAnimation(InputMedia):
"""Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

5
telegram/files/location.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Location."""
from telegram import TelegramObject
from typing import Any
from telegram import TelegramObject
class Location(TelegramObject):
"""This object represents a point on the map.
@ -39,7 +40,7 @@ class Location(TelegramObject):
"""
def __init__(self, longitude: float, latitude: float, **kwargs: Any):
def __init__(self, longitude: float, latitude: float, **kwargs: Any): # pylint: disable=W0613
# Required
self.longitude = float(longitude)
self.latitude = float(latitude)

5
telegram/files/photosize.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram PhotoSize."""
from typing import TYPE_CHECKING, Any
from telegram import TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -57,7 +58,7 @@ class PhotoSize(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
width: int,

13
telegram/files/sticker.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains objects that represents stickers."""
from typing import TYPE_CHECKING, Any, List, Optional, ClassVar
from telegram import PhotoSize, TelegramObject, constants
from telegram.utils.types import JSONDict
from typing import Any, Optional, List, TYPE_CHECKING, ClassVar
if TYPE_CHECKING:
from telegram import Bot, File
@ -73,7 +74,7 @@ class Sticker(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
width: int,
@ -162,13 +163,13 @@ class StickerSet(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
name: str,
title: str,
is_animated: bool,
contains_masks: bool,
stickers: List[Sticker],
bot: 'Bot' = None,
bot: 'Bot' = None, # pylint: disable=W0613
thumb: PhotoSize = None,
**kwargs: Any,
):
@ -242,7 +243,9 @@ class MaskPosition(TelegramObject):
CHIN: ClassVar[str] = constants.STICKER_CHIN
""":const:`telegram.constants.STICKER_CHIN`"""
def __init__(self, point: str, x_shift: float, y_shift: float, scale: float, **kwargs: Any):
def __init__(
self, point: str, x_shift: float, y_shift: float, scale: float, **kwargs: Any
): # pylint: disable=W0613
self.point = point
self.x_shift = x_shift
self.y_shift = y_shift

7
telegram/files/venue.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Venue."""
from telegram import TelegramObject, Location
from typing import TYPE_CHECKING, Any, Optional
from telegram import Location, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot
@ -52,7 +53,7 @@ class Venue(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
location: Location,
title: str,
address: str,

5
telegram/files/video.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Video."""
from typing import TYPE_CHECKING, Any, Optional
from telegram import PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -63,7 +64,7 @@ class Video(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
width: int,

5
telegram/files/videonote.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram VideoNote."""
from typing import TYPE_CHECKING, Any, Optional
from telegram import PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -60,7 +61,7 @@ class VideoNote(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
length: int,

5
telegram/files/voice.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram Voice."""
from typing import TYPE_CHECKING, Any
from telegram import TelegramObject
from telegram.utils.types import JSONDict
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot, File
@ -57,7 +58,7 @@ class Voice(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
file_id: str,
file_unique_id: str,
duration: int,

7
telegram/forcereply.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram ForceReply."""
from telegram import ReplyMarkup
from typing import Any
from telegram import ReplyMarkup
class ForceReply(ReplyMarkup):
"""
@ -49,7 +50,9 @@ class ForceReply(ReplyMarkup):
"""
def __init__(self, force_reply: bool = True, selective: bool = False, **kwargs: Any):
def __init__(
self, force_reply: bool = True, selective: bool = False, **kwargs: Any
): # pylint: disable=W0613
# Required
self.force_reply = bool(force_reply)
# Optionals

11
telegram/games/game.py
View file

@ -19,10 +19,10 @@
"""This module contains an object that represents a Telegram Game."""
import sys
from typing import TYPE_CHECKING, Any, Dict, List, Optional
from telegram import MessageEntity, TelegramObject, Animation, PhotoSize
from telegram import Animation, MessageEntity, PhotoSize, TelegramObject
from telegram.utils.types import JSONDict
from typing import List, Any, Dict, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot
@ -68,7 +68,7 @@ class Game(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
title: str,
description: str,
photo: List[PhotoSize],
@ -135,9 +135,8 @@ class Game(TelegramObject):
# Is it a narrow build, if so we don't need to convert
if sys.maxunicode == 0xFFFF:
return self.text[entity.offset : entity.offset + entity.length]
else:
entity_text = self.text.encode('utf-16-le')
entity_text = entity_text[entity.offset * 2 : (entity.offset + entity.length) * 2]
entity_text = self.text.encode('utf-16-le')
entity_text = entity_text[entity.offset * 2 : (entity.offset + entity.length) * 2]
return entity_text.decode('utf-16-le')

3
telegram/games/gamehighscore.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram GameHighScore."""
from typing import TYPE_CHECKING, Optional
from telegram import TelegramObject, User
from telegram.utils.types import JSONDict
from typing import Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot

5
telegram/inline/inlinekeyboardbutton.py
View file

@ -18,8 +18,9 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram InlineKeyboardButton."""
from typing import TYPE_CHECKING, Any
from telegram import TelegramObject
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import CallbackGame, LoginUrl
@ -83,7 +84,7 @@ class InlineKeyboardButton(TelegramObject):
"""
def __init__(
self,
self, # pylint: disable=W0613
text: str,
url: str = None,
callback_data: str = None,

11
telegram/inline/inlinekeyboardmarkup.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram InlineKeyboardMarkup."""
from telegram import ReplyMarkup, InlineKeyboardButton
from typing import TYPE_CHECKING, Any, List, Optional
from telegram import InlineKeyboardButton, ReplyMarkup
from telegram.utils.types import JSONDict
from typing import Any, List, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot
@ -44,7 +45,9 @@ class InlineKeyboardMarkup(ReplyMarkup):
"""
def __init__(self, inline_keyboard: List[List[InlineKeyboardButton]], **kwargs: Any):
def __init__(
self, inline_keyboard: List[List[InlineKeyboardButton]], **kwargs: Any
): # pylint: disable=W0613
# Required
self.inline_keyboard = inline_keyboard
@ -138,7 +141,7 @@ class InlineKeyboardMarkup(ReplyMarkup):
if button != other.inline_keyboard[idx][jdx]:
return False
return True
return super(InlineKeyboardMarkup, self).__eq__(other) # pylint: disable=no-member
return super().__eq__(other)
def __hash__(self) -> int:
return hash(tuple(tuple(button for button in row) for row in self.inline_keyboard))

13
telegram/inline/inlinequery.py
View file

@ -1,5 +1,5 @@
#!/usr/bin/env python
# pylint: disable=R0902,R0912,R0913
# pylint: disable=R0902,R0913
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2020
@ -19,9 +19,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram InlineQuery."""
from telegram import TelegramObject, User, Location
from typing import TYPE_CHECKING, Any, Optional
from telegram import Location, TelegramObject, User
from telegram.utils.types import JSONDict
from typing import Any, Optional, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import Bot
@ -59,8 +60,8 @@ class InlineQuery(TelegramObject):
"""
def __init__(
self,
id: str,
self, # pylint: disable=W0613
id: str, # pylint: disable=W0622
from_user: User,
query: str,
offset: str,
@ -69,7 +70,7 @@ class InlineQuery(TelegramObject):
**kwargs: Any,
):
# Required
self.id = id
self.id = id # pylint: disable=C0103
self.from_user = from_user
self.query = query
self.offset = offset

8
telegram/inline/inlinequeryresult.py
View file

@ -16,11 +16,13 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=W0622
"""This module contains the classes that represent Telegram InlineQueryResult."""
from telegram import TelegramObject
from typing import Any
from telegram import TelegramObject
class InlineQueryResult(TelegramObject):
"""Baseclass for the InlineQueryResult* classes.
@ -39,10 +41,10 @@ class InlineQueryResult(TelegramObject):
"""
def __init__(self, type: str, id: str, **kwargs: Any):
def __init__(self, type: str, id: str, **kwargs: Any): # pylint: disable=W0613
# Required
self.type = str(type)
self.id = str(id)
self.id = str(id) # pylint: disable=C0103
self._id_attrs = (self.id,)

7
telegram/inline/inlinequeryresultarticle.py
View file

@ -18,8 +18,9 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultArticle."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -64,7 +65,7 @@ class InlineQueryResultArticle(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
title: str,
input_message_content: 'InputMessageContent',
reply_markup: 'ReplyMarkup' = None,
@ -74,7 +75,7 @@ class InlineQueryResultArticle(InlineQueryResult):
thumb_url: str = None,
thumb_width: int = None,
thumb_height: int = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

7
telegram/inline/inlinequeryresultaudio.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultAudio."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -68,7 +69,7 @@ class InlineQueryResultAudio(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
audio_url: str,
title: str,
performer: str = None,
@ -77,7 +78,7 @@ class InlineQueryResultAudio(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

7
telegram/inline/inlinequeryresultcachedaudio.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultCachedAudio."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -62,13 +63,13 @@ class InlineQueryResultCachedAudio(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
audio_file_id: str,
caption: str = None,
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('audio', id)

8
telegram/inline/inlinequeryresultcacheddocument.py
View file

@ -16,11 +16,13 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=W0622
"""This module contains the classes that represent Telegram InlineQueryResultCachedDocument."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -68,7 +70,7 @@ class InlineQueryResultCachedDocument(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
title: str,
document_file_id: str,
description: str = None,
@ -76,7 +78,7 @@ class InlineQueryResultCachedDocument(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('document', id)

7
telegram/inline/inlinequeryresultcachedgif.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultCachedGif."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -67,14 +68,14 @@ class InlineQueryResultCachedGif(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
gif_file_id: str,
title: str = None,
caption: str = None,
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('gif', id)

7
telegram/inline/inlinequeryresultcachedmpeg4gif.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -67,14 +68,14 @@ class InlineQueryResultCachedMpeg4Gif(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
mpeg4_file_id: str,
title: str = None,
caption: str = None,
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('mpeg4_gif', id)

8
telegram/inline/inlinequeryresultcachedphoto.py
View file

@ -16,11 +16,13 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=W0622
"""This module contains the classes that represent Telegram InlineQueryResultPhoto"""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -69,7 +71,7 @@ class InlineQueryResultCachedPhoto(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
photo_file_id: str,
title: str = None,
description: str = None,
@ -77,7 +79,7 @@ class InlineQueryResultCachedPhoto(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('photo', id)

9
telegram/inline/inlinequeryresultcachedsticker.py
View file

@ -18,11 +18,12 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultCachedSticker."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import ReplyMarkup, InputMessageContent
from telegram import InputMessageContent, ReplyMarkup
class InlineQueryResultCachedSticker(InlineQueryResult):
@ -53,11 +54,11 @@ class InlineQueryResultCachedSticker(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
sticker_file_id: str,
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('sticker', id)

7
telegram/inline/inlinequeryresultcachedvideo.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultCachedVideo."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -69,7 +70,7 @@ class InlineQueryResultCachedVideo(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
video_file_id: str,
title: str,
description: str = None,
@ -77,7 +78,7 @@ class InlineQueryResultCachedVideo(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('video', id)

7
telegram/inline/inlinequeryresultcachedvoice.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultCachedVoice."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -64,14 +65,14 @@ class InlineQueryResultCachedVoice(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
voice_file_id: str,
title: str,
caption: str = None,
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('voice', id)

9
telegram/inline/inlinequeryresultcontact.py
View file

@ -18,11 +18,12 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultContact."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import ReplyMarkup, InputMessageContent
from telegram import InputMessageContent, ReplyMarkup
class InlineQueryResultContact(InlineQueryResult):
@ -67,7 +68,7 @@ class InlineQueryResultContact(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
phone_number: str,
first_name: str,
last_name: str = None,
@ -77,7 +78,7 @@ class InlineQueryResultContact(InlineQueryResult):
thumb_width: int = None,
thumb_height: int = None,
vcard: str = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('contact', id)

7
telegram/inline/inlinequeryresultdocument.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultDocument"""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -79,7 +80,7 @@ class InlineQueryResultDocument(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
document_url: str,
title: str,
mime_type: str,
@ -91,7 +92,7 @@ class InlineQueryResultDocument(InlineQueryResult):
thumb_width: int = None,
thumb_height: int = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('document', id)

11
telegram/inline/inlinequeryresultgame.py
View file

@ -18,8 +18,9 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultGame."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import ReplyMarkup
@ -45,11 +46,15 @@ class InlineQueryResultGame(InlineQueryResult):
"""
def __init__(
self, id: str, game_short_name: str, reply_markup: 'ReplyMarkup' = None, **kwargs: Any
self,
id: str, # pylint: disable=W0622
game_short_name: str,
reply_markup: 'ReplyMarkup' = None,
**kwargs: Any,
):
# Required
super().__init__('game', id)
self.id = id
self.id = id # pylint: disable=W0622
self.game_short_name = game_short_name
self.reply_markup = reply_markup

8
telegram/inline/inlinequeryresultgif.py
View file

@ -16,11 +16,13 @@
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
# pylint: disable=W0622
"""This module contains the classes that represent Telegram InlineQueryResultGif."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -79,7 +81,7 @@ class InlineQueryResultGif(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
gif_url: str,
thumb_url: str,
gif_width: int = None,
@ -91,7 +93,7 @@ class InlineQueryResultGif(InlineQueryResult):
gif_duration: int = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
thumb_mime_type: str = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

9
telegram/inline/inlinequeryresultlocation.py
View file

@ -18,11 +18,12 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultLocation."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import ReplyMarkup, InputMessageContent
from telegram import InputMessageContent, ReplyMarkup
class InlineQueryResultLocation(InlineQueryResult):
@ -67,7 +68,7 @@ class InlineQueryResultLocation(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
latitude: float,
longitude: float,
title: str,
@ -77,7 +78,7 @@ class InlineQueryResultLocation(InlineQueryResult):
thumb_url: str = None,
thumb_width: int = None,
thumb_height: int = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('location', id)

7
telegram/inline/inlinequeryresultmpeg4gif.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -79,7 +80,7 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
mpeg4_url: str,
thumb_url: str,
mpeg4_width: int = None,
@ -91,7 +92,7 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult):
mpeg4_duration: int = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
thumb_mime_type: str = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

7
telegram/inline/inlinequeryresultphoto.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultPhoto."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -76,7 +77,7 @@ class InlineQueryResultPhoto(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
photo_url: str,
thumb_url: str,
photo_width: int = None,
@ -87,7 +88,7 @@ class InlineQueryResultPhoto(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required
super().__init__('photo', id)

9
telegram/inline/inlinequeryresultvenue.py
View file

@ -18,11 +18,12 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultVenue."""
from typing import TYPE_CHECKING, Any
from telegram import InlineQueryResult
from typing import Any, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import ReplyMarkup, InputMessageContent
from telegram import InputMessageContent, ReplyMarkup
class InlineQueryResultVenue(InlineQueryResult):
@ -73,7 +74,7 @@ class InlineQueryResultVenue(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
latitude: float,
longitude: float,
title: str,
@ -85,7 +86,7 @@ class InlineQueryResultVenue(InlineQueryResult):
thumb_url: str = None,
thumb_width: int = None,
thumb_height: int = None,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

7
telegram/inline/inlinequeryresultvideo.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultVideo."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -86,7 +87,7 @@ class InlineQueryResultVideo(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
video_url: str,
mime_type: str,
thumb_url: str,
@ -99,7 +100,7 @@ class InlineQueryResultVideo(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

7
telegram/inline/inlinequeryresultvoice.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InlineQueryResultVoice."""
from typing import TYPE_CHECKING, Any, Union
from telegram import InlineQueryResult
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union, TYPE_CHECKING
if TYPE_CHECKING:
from telegram import InputMessageContent, ReplyMarkup
@ -67,7 +68,7 @@ class InlineQueryResultVoice(InlineQueryResult):
def __init__(
self,
id: str,
id: str, # pylint: disable=W0622
voice_url: str,
title: str,
voice_duration: int = None,
@ -75,7 +76,7 @@ class InlineQueryResultVoice(InlineQueryResult):
reply_markup: 'ReplyMarkup' = None,
input_message_content: 'InputMessageContent' = None,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
**kwargs: Any,
**kwargs: Any, # pylint: disable=W0613
):
# Required

5
telegram/inline/inputcontactmessagecontent.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InputContactMessageContent."""
from telegram import InputMessageContent
from typing import Any
from telegram import InputMessageContent
class InputContactMessageContent(InputMessageContent):
"""Represents the content of a contact message to be sent as the result of an inline query.
@ -46,7 +47,7 @@ class InputContactMessageContent(InputMessageContent):
"""
def __init__(
self,
self, # pylint: disable=W0613
phone_number: str,
first_name: str,
last_name: str = None,

7
telegram/inline/inputlocationmessagecontent.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InputLocationMessageContent."""
from telegram import InputMessageContent
from typing import Any
from telegram import InputMessageContent
class InputLocationMessageContent(InputMessageContent):
# fmt: off
@ -46,7 +47,9 @@ class InputLocationMessageContent(InputMessageContent):
"""
# fmt: on
def __init__(self, latitude: float, longitude: float, live_period: int = None, **kwargs: Any):
def __init__(
self, latitude: float, longitude: float, live_period: int = None, **kwargs: Any
): # pylint: disable=W0613
# Required
self.latitude = latitude
self.longitude = longitude

5
telegram/inline/inputtextmessagecontent.py
View file

@ -18,9 +18,10 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains the classes that represent Telegram InputTextMessageContent."""
from typing import Any, Union
from telegram import InputMessageContent
from telegram.utils.helpers import DEFAULT_NONE, DefaultValue
from typing import Any, Union
class InputTextMessageContent(InputMessageContent):
@ -52,7 +53,7 @@ class InputTextMessageContent(InputMessageContent):
"""
def __init__(
self,
self, # pylint: disable=W0613
message_text: str,
parse_mode: Union[str, DefaultValue] = DEFAULT_NONE,
disable_web_page_preview: Union[bool, DefaultValue] = DEFAULT_NONE,

Some files were not shown because too many files have changed in this diff Show more