mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 01:46:22 +02:00
92b9370c23
* 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
114 lines
3.7 KiB
Python
114 lines
3.7 KiB
Python
#!/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 Bot to send timed Telegram messages.
|
|
|
|
This Bot uses the Updater 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 Dispatcher 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 Updater, CommandHandler, CallbackContext
|
|
|
|
# Enable logging
|
|
logging.basicConfig(
|
|
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', level=logging.INFO
|
|
)
|
|
|
|
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: Update, context: CallbackContext) -> None:
|
|
update.message.reply_text('Hi! Use /set <seconds> to set a timer')
|
|
|
|
|
|
def alarm(context):
|
|
"""Send the alarm message."""
|
|
job = context.job
|
|
context.bot.send_message(job.context, text='Beep!')
|
|
|
|
|
|
def remove_job_if_exists(name, context):
|
|
"""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
|
|
|
|
|
|
def set_timer(update: Update, context: CallbackContext) -> None:
|
|
"""Add a job to the queue."""
|
|
chat_id = update.message.chat_id
|
|
try:
|
|
# args[0] should contain the time for the timer in seconds
|
|
due = int(context.args[0])
|
|
if due < 0:
|
|
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, context=chat_id, name=str(chat_id))
|
|
|
|
text = 'Timer successfully set!'
|
|
if job_removed:
|
|
text += ' Old one was removed.'
|
|
update.message.reply_text(text)
|
|
|
|
except (IndexError, ValueError):
|
|
update.message.reply_text('Usage: /set <seconds>')
|
|
|
|
|
|
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)
|
|
text = 'Timer successfully cancelled!' if job_removed else 'You have no active timer.'
|
|
update.message.reply_text(text)
|
|
|
|
|
|
def main():
|
|
"""Run bot."""
|
|
# 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
|
|
dispatcher = updater.dispatcher
|
|
|
|
# on different commands - answer in Telegram
|
|
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()
|
|
|
|
# Block until you press Ctrl-C or the process receives SIGINT, SIGTERM or
|
|
# SIGABRT. This should be used most of the time, since start_polling() is
|
|
# non-blocking and will stop the bot gracefully.
|
|
updater.idle()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|