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 2025-03-29 01:37:28 +01:00
Code Issues Projects Releases Packages Wiki Activity

refactor BotEventHandler to Updater, improve documentation, add idle() method

Browse source
This commit is contained in:
Jannes Höke 2015-11-22 19:15:17 +01:00
parent 65177e791f
commit d91f210f7c
2 changed files with 32 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
telegram/__init__.py
View file

@ -48,9 +48,9 @@ from .message import Message
from .update import Update from .update import Update
from .bot import Bot from .bot import Bot
from .dispatcher import Dispatcher from .dispatcher import Dispatcher
from .boteventhandler import BotEventHandler from .boteventhandler import Updater
__all__ = ['Bot', 'BotEventHandler', 'Dispatcher', 'Emoji', 'TelegramError', __all__ = ['Bot', 'Updater', 'Dispatcher', 'Emoji', 'TelegramError',
'InputFile', 'ReplyMarkup', 'ForceReply', 'ReplyKeyboardHide', 'InputFile', 'ReplyMarkup', 'ForceReply', 'ReplyKeyboardHide',
'ReplyKeyboardMarkup', 'UserProfilePhotos', 'ChatAction', 'ReplyKeyboardMarkup', 'UserProfilePhotos', 'ChatAction',
'Location', 'Contact', 'Video', 'Sticker', 'Document', 'File', 'Location', 'Contact', 'Video', 'Sticker', 'Document', 'File',

45
telegram/boteventhandler.py
View file

@ -27,14 +27,18 @@ H = NullHandler()
logging.getLogger(__name__).addHandler(H) logging.getLogger(__name__).addHandler(H)
class BotEventHandler: class Updater:
""" """
This class provides a frontend to telegram.Bot to the programmer, so they This class, which employs the Dispatcher class, provides a frontend to
can focus on coding the bot. It also runs in a separate thread, so the user telegram.Bot to the programmer, so they can focus on coding the bot. It's
can interact with the bot, for example on the command line. It supports purpose is to receive the updates from Telegram and to deliver them to said
Handlers for different kinds of data: Updates from Telegram, basic text dispatcher. It also runs in a separate thread, so the user can interact
with the bot, for example on the command line. The dispatcher supports
handlers for different kinds of data: Updates from Telegram, basic text
commands and even arbitrary types. commands and even arbitrary types.
Polling as well as webhook are supported. The updater can be started as a polling service or, for production, use a
webhook to receive updates. This is achieved using the WebhookServer and
WebhookHandler classes.
Attributes: Attributes:
@ -75,7 +79,7 @@ class BotEventHandler:
dispatcher_thread = Thread(target=self.dispatcher.start, dispatcher_thread = Thread(target=self.dispatcher.start,
name="dispatcher") name="dispatcher")
event_handler_thread = Thread(target=self._start_polling, event_handler_thread = Thread(target=self._start_polling,
name="eventhandler", name="updater",
args=(poll_interval, timeout, args=(poll_interval, timeout,
network_delay)) network_delay))
@ -107,7 +111,7 @@ class BotEventHandler:
dispatcher_thread = Thread(target=self.dispatcher.start, dispatcher_thread = Thread(target=self.dispatcher.start,
name="dispatcher") name="dispatcher")
event_handler_thread = Thread(target=self._start_webhook, event_handler_thread = Thread(target=self._start_webhook,
name="eventhandler", name="updater",
args=(host, port, cert, key, listen)) args=(host, port, cert, key, listen))
self.running = True self.running = True
@ -121,13 +125,13 @@ class BotEventHandler:
def _start_polling(self, poll_interval, timeout, network_delay): def _start_polling(self, poll_interval, timeout, network_delay):
""" """
Thread target of thread 'eventhandler'. Runs in background, pulls Thread target of thread 'updater'. Runs in background, pulls
updates from Telegram and inserts them in the update queue of the updates from Telegram and inserts them in the update queue of the
Dispatcher. Dispatcher.
""" """
current_interval = poll_interval current_interval = poll_interval
self.logger.info('Event Handler thread started') self.logger.info('Updater thread started')
# Remove webhook # Remove webhook
self.bot.setWebhook(webhook_url=None) self.bot.setWebhook(webhook_url=None)
@ -161,10 +165,10 @@ class BotEventHandler:
if current_interval > 30: if current_interval > 30:
current_interval = 30 current_interval = 30
self.logger.info('Event Handler thread stopped') self.logger.info('Updater thread stopped')
def _start_webhook(self, host, port, cert, key, listen): def _start_webhook(self, host, port, cert, key, listen):
self.logger.info('Event Handler thread started') self.logger.info('Updater thread started')
url_base = "https://%s:%d" % (host, port) url_base = "https://%s:%d" % (host, port)
url_path = "/%s" % self.bot.token url_path = "/%s" % self.bot.token
@ -199,15 +203,17 @@ class BotEventHandler:
except ssl.SSLError as error: except ssl.SSLError as error:
self.logger.error(str(error)) self.logger.error(str(error))
finally: finally:
self.logger.info('Event Handler thread stopped') self.logger.info('Updater thread stopped')
else: else:
raise TelegramError('SSL Certificate invalid') raise TelegramError('SSL Certificate invalid')
def stop(self): def stop(self):
""" """
Stops the polling thread and the dispatcher Stops the polling/webhook thread and the dispatcher
""" """
self.logger.info('Stopping Event Handler and Dispatcher...') self.logger.info('Stopping Updater and Dispatcher...')
self.logger.debug('This might take a long time if you set a high value'
' as polling timeout.')
self.running = False self.running = False
if self.httpd: if self.httpd:
@ -223,3 +229,12 @@ class BotEventHandler:
sleep(1) sleep(1)
self.logger.debug("Dispatcher stopped.") self.logger.debug("Dispatcher stopped.")
def idle(self):
""" Waits for the user to press Ctrl-C and stops the updater """
while True:
try:
sleep(1)
except KeyboardInterrupt:
self.stop()
break