mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-23 17:36:26 +02:00
149 lines
5 KiB
Python
149 lines
5 KiB
Python
#!/usr/bin/env python
|
|
# pylint: disable=unused-argument, wrong-import-position
|
|
# This program is dedicated to the public domain under the CC0 license.
|
|
|
|
"""
|
|
Simple Bot to showcase `telegram.ext.ContextTypes`.
|
|
|
|
Usage:
|
|
Press Ctrl-C on the command line or send a signal to the process to stop the
|
|
bot.
|
|
"""
|
|
|
|
import logging
|
|
from collections import defaultdict
|
|
from typing import DefaultDict, Optional, Set
|
|
|
|
from telegram import __version__ as TG_VER
|
|
|
|
try:
|
|
from telegram import __version_info__
|
|
except ImportError:
|
|
__version_info__ = (0, 0, 0, 0, 0) # type: ignore[assignment]
|
|
|
|
if __version_info__ < (20, 0, 0, "alpha", 1):
|
|
raise RuntimeError(
|
|
f"This example is not compatible with your current PTB version {TG_VER}. To view the "
|
|
f"{TG_VER} version of this example, "
|
|
f"visit https://github.com/python-telegram-bot/python-telegram-bot/tree/v{TG_VER}/examples"
|
|
)
|
|
from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
|
|
from telegram.constants import ParseMode
|
|
from telegram.ext import (
|
|
Application,
|
|
CallbackContext,
|
|
CallbackQueryHandler,
|
|
CommandHandler,
|
|
ContextTypes,
|
|
ExtBot,
|
|
TypeHandler,
|
|
)
|
|
|
|
# Enable logging
|
|
logging.basicConfig(
|
|
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
|
|
)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class ChatData:
|
|
"""Custom class for chat_data. Here we store data per message."""
|
|
|
|
def __init__(self) -> None:
|
|
self.clicks_per_message: DefaultDict[int, int] = defaultdict(int)
|
|
|
|
|
|
# The [ExtBot, dict, ChatData, dict] is for type checkers like mypy
|
|
class CustomContext(CallbackContext[ExtBot, dict, ChatData, dict]):
|
|
"""Custom class for context."""
|
|
|
|
def __init__(self, application: Application):
|
|
super().__init__(application=application)
|
|
self._message_id: Optional[int] = None
|
|
|
|
@property
|
|
def bot_user_ids(self) -> Set[int]:
|
|
"""Custom shortcut to access a value stored in the bot_data dict"""
|
|
return self.bot_data.setdefault("user_ids", set())
|
|
|
|
@property
|
|
def message_clicks(self) -> Optional[int]:
|
|
"""Access the number of clicks for the message this context object was built for."""
|
|
if self._message_id:
|
|
return self.chat_data.clicks_per_message[self._message_id]
|
|
return None
|
|
|
|
@message_clicks.setter
|
|
def message_clicks(self, value: int) -> None:
|
|
"""Allow to change the count"""
|
|
if not self._message_id:
|
|
raise RuntimeError("There is no message associated with this context object.")
|
|
self.chat_data.clicks_per_message[self._message_id] = value
|
|
|
|
@classmethod
|
|
def from_update(cls, update: object, application: "Application") -> "CustomContext":
|
|
"""Override from_update to set _message_id."""
|
|
# Make sure to call super()
|
|
context = super().from_update(update, application)
|
|
|
|
if context.chat_data and isinstance(update, Update) and update.effective_message:
|
|
# pylint: disable=protected-access
|
|
context._message_id = update.effective_message.message_id
|
|
|
|
# Remember to return the object
|
|
return context
|
|
|
|
|
|
async def start(update: Update, context: CustomContext) -> None:
|
|
"""Display a message with a button."""
|
|
await update.message.reply_html(
|
|
"This button was clicked <i>0</i> times.",
|
|
reply_markup=InlineKeyboardMarkup.from_button(
|
|
InlineKeyboardButton(text="Click me!", callback_data="button")
|
|
),
|
|
)
|
|
|
|
|
|
async def count_click(update: Update, context: CustomContext) -> None:
|
|
"""Update the click count for the message."""
|
|
context.message_clicks += 1
|
|
await update.callback_query.answer()
|
|
await update.effective_message.edit_text(
|
|
f"This button was clicked <i>{context.message_clicks}</i> times.",
|
|
reply_markup=InlineKeyboardMarkup.from_button(
|
|
InlineKeyboardButton(text="Click me!", callback_data="button")
|
|
),
|
|
parse_mode=ParseMode.HTML,
|
|
)
|
|
|
|
|
|
async def print_users(update: Update, context: CustomContext) -> None:
|
|
"""Show which users have been using this bot."""
|
|
await update.message.reply_text(
|
|
"The following user IDs have used this bot: "
|
|
f'{", ".join(map(str, context.bot_user_ids))}'
|
|
)
|
|
|
|
|
|
async def track_users(update: Update, context: CustomContext) -> None:
|
|
"""Store the user id of the incoming update, if any."""
|
|
if update.effective_user:
|
|
context.bot_user_ids.add(update.effective_user.id)
|
|
|
|
|
|
def main() -> None:
|
|
"""Run the bot."""
|
|
context_types = ContextTypes(context=CustomContext, chat_data=ChatData)
|
|
application = Application.builder().token("TOKEN").context_types(context_types).build()
|
|
|
|
# run track_users in its own group to not interfere with the user handlers
|
|
application.add_handler(TypeHandler(Update, track_users), group=-1)
|
|
application.add_handler(CommandHandler("start", start))
|
|
application.add_handler(CallbackQueryHandler(count_click))
|
|
application.add_handler(CommandHandler("print_users", print_users))
|
|
|
|
application.run_polling()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|