mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-23 17:36:26 +02:00
104 lines
3.6 KiB
Python
104 lines
3.6 KiB
Python
#!/usr/bin/env python
|
|
# pylint: disable=unused-argument
|
|
# This program is dedicated to the public domain under the CC0 license.
|
|
|
|
"""
|
|
Simple Bot to send timed Telegram messages.
|
|
|
|
This Bot uses the Application class to handle the bot and the JobQueue to send
|
|
timed messages.
|
|
|
|
First, a few handler functions are defined. Then, those functions are passed to
|
|
the Application and registered at their respective places.
|
|
Then, the bot is started and runs until we press Ctrl-C on the command line.
|
|
|
|
Usage:
|
|
Basic Alarm Bot example, sends a message after a set time.
|
|
Press Ctrl-C on the command line or send a signal to the process to stop the
|
|
bot.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from telegram import Update
|
|
from telegram.ext import Application, CallbackContext, CommandHandler
|
|
|
|
# Enable logging
|
|
logging.basicConfig(
|
|
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
|
|
)
|
|
|
|
|
|
# Define a few command handlers. These usually take the two arguments update and
|
|
# context.
|
|
# Best practice would be to replace context with an underscore,
|
|
# since context is an unused local variable.
|
|
# This being an example and not having context present confusing beginners,
|
|
# we decided to have it present as context.
|
|
async def start(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
|
|
"""Sends explanation on how to use the bot."""
|
|
await update.message.reply_text("Hi! Use /set <seconds> to set a timer")
|
|
|
|
|
|
async def alarm(context: CallbackContext.DEFAULT_TYPE) -> None:
|
|
"""Send the alarm message."""
|
|
job = context.job
|
|
await context.bot.send_message(job.chat_id, text=f"Beep! {job.context} seconds are over!")
|
|
|
|
|
|
def remove_job_if_exists(name: str, context: CallbackContext.DEFAULT_TYPE) -> bool:
|
|
"""Remove job with given name. Returns whether job was removed."""
|
|
current_jobs = context.job_queue.get_jobs_by_name(name)
|
|
if not current_jobs:
|
|
return False
|
|
for job in current_jobs:
|
|
job.schedule_removal()
|
|
return True
|
|
|
|
|
|
async def set_timer(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
|
|
"""Add a job to the queue."""
|
|
chat_id = update.effective_message.chat_id
|
|
try:
|
|
# args[0] should contain the time for the timer in seconds
|
|
due = int(context.args[0])
|
|
if due < 0:
|
|
await update.message.reply_text("Sorry we can not go back to future!")
|
|
return
|
|
|
|
job_removed = remove_job_if_exists(str(chat_id), context)
|
|
context.job_queue.run_once(alarm, due, chat_id=chat_id, name=str(chat_id), context=due)
|
|
|
|
text = "Timer successfully set!"
|
|
if job_removed:
|
|
text += " Old one was removed."
|
|
await update.message.reply_text(text)
|
|
|
|
except (IndexError, ValueError):
|
|
await update.effective_message.reply_text("Usage: /set <seconds>")
|
|
|
|
|
|
async def unset(update: Update, context: CallbackContext.DEFAULT_TYPE) -> 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)
|
|
text = "Timer successfully cancelled!" if job_removed else "You have no active timer."
|
|
await update.message.reply_text(text)
|
|
|
|
|
|
def main() -> None:
|
|
"""Run bot."""
|
|
# Create the Application and pass it your bot's token.
|
|
application = Application.builder().token("TOKEN").build()
|
|
|
|
# on different commands - answer in Telegram
|
|
application.add_handler(CommandHandler(["start", "help"], start))
|
|
application.add_handler(CommandHandler("set", set_timer))
|
|
application.add_handler(CommandHandler("unset", unset))
|
|
|
|
# Run the bot until the user presses Ctrl-C
|
|
application.run_polling()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|