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-11-22 07:06:26 +01:00
Code Issues Projects Releases Packages Wiki Activity

Remove hyperlinks in Architecture diagram due to https://github.com/orgs/community/discussions/46096 & https://github.com/orgs/community/discussions/106690

Hinrich Mahler 2024-02-18 14:54:04 +01:00
parent c14e89b557
commit 0ee7236ed0
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
Architecture.md

@ -7,12 +7,12 @@ Because all of that can be a bit overwhelming, the below diagram gives you an ov
```mermaid ```mermaid
flowchart TD; flowchart TD;
AppBuilder(" AppBuilder("
<a href='https://docs.python-telegram-bot.org/telegram.ext.applicationbuilder.html'><code>ext.ApplicationBuilder</code></a> <code>ext.ApplicationBuilder</code>
builder pattern for builder pattern for
<a href='https://docs.python-telegram-bot.org/telegram.ext.application.html'><code>ext.Application</code></a> <code>ext.Application</code>
"); ");
App(" App("
<a href='https://docs.python-telegram-bot.org/telegram.ext.application.html'><code>ext.Application</code></a> <code>ext.Application</code>
• entry point for the whole application</li> • entry point for the whole application</li>
• provides convenience methods for running the whole app via run_polling/webhook()</li> • provides convenience methods for running the whole app via run_polling/webhook()</li>
@ -20,66 +20,66 @@ flowchart TD;
• administers user/chat/bot_data</li> • administers user/chat/bot_data</li>
"); ");
BaseHandler(" BaseHandler("
<a href='https://docs.python-telegram-bot.org/telegram.ext.basehandler.html'><code>ext.BaseHandler</code></a> <code>ext.BaseHandler</code>
specifies if and how specifies if and how
it handles updates it handles updates
"); ");
BaseRateLimiter(" BaseRateLimiter("
<a href='https://docs.python-telegram-bot.org/telegram.ext.baseratelimiter.html'><code>ext.BaseRateLimiter</code></a> <code>ext.BaseRateLimiter</code>
interface for rate limiting interface for rate limiting
API requests API requests
"); ");
BaseRequest(" BaseRequest("
<a href='https://docs.python-telegram-bot.org/telegram.request.baserequest.html'><code>request.BaseRequest</code></a> <code>request.BaseRequest</code>
interface for handling the interface for handling the
networking backend networking backend
"); ");
BasePersistence(" BasePersistence("
<a href='https://docs.python-telegram-bot.org/telegram.ext.basepersistence.html'><code>ext.BasePersistence</code></a> <code>ext.BasePersistence</code>
interface for persisting interface for persisting
data from <a href='https://docs.python-telegram-bot.org/telegram.ext.application.html'><code>ext.Application</code></a> data from <code>ext.Application</code>
across restarts across restarts
"); ");
BaseUpdateProcessor(" BaseUpdateProcessor("
<a href='https://docs.python-telegram-bot.org/telegram.ext.baseupdateprocessor.html'><code>ext.BaseUpdateProcessor</code></a> <code>ext.BaseUpdateProcessor</code>
interface for processing interface for processing
updates concurrently updates concurrently
"); ");
Bot(" Bot("
<code>(<a href='https://docs.python-telegram-bot.org/telegram.ext.extbot.html'>ext.Ext</a>)<a href='https://docs.python-telegram-bot.org/telegram.bot.html'>Bot</a></code> <code>(ext.Ext)Bot</code>
Telegram Bot API client Telegram Bot API client
used to make requests used to make requests
to the API to the API
"); ");
CallbackContext(" CallbackContext("
<a href='https://docs.python-telegram-bot.org/telegram.ext.callbackcontext.html'><code>ext.CallbackContext</code></a> <code>ext.CallbackContext</code>
Convenience class for unified Convenience class for unified
access to different objects within access to different objects within
handler/job/error callbacks handler/job/error callbacks
"); ");
CallbackDataCache(" CallbackDataCache("
<a href='https://docs.python-telegram-bot.org/telegram.ext.callbackdatacache.html'><code>ext.CallbackDataCache</code></a> <code>ext.CallbackDataCache</code>
in-memory LRU-cache for in-memory LRU-cache for
arbitrary callback_data arbitrary callback_data
"); ");
ContextTypes(" ContextTypes("
<a href='https://docs.python-telegram-bot.org/telegram.ext.contexttypes.html'><code>ext.ContextTypes</code></a> <code>ext.ContextTypes</code>
specifies types of specifies types of
the context argument the context argument
"); ");
Defaults(" Defaults("
<a href='https://docs.python-telegram-bot.org/telegram.ext.defaults.html'><code>ext.Defaults</code></a> <code>ext.Defaults</code>
gathers default values for frequently gathers default values for frequently
used parameters of <code>(<a href='https://docs.python-telegram-bot.org/telegram.ext.extbot.html'>ext.Ext</a>)<a href='https://docs.python-telegram-bot.org/telegram.bot.html'>Bot</a></code>, used parameters of <code>(ext.Ext)Bot</code>,
<a href='https://docs.python-telegram-bot.org/telegram.ext.jobqueue.html'><code>Ext.JobQueue</code></a> and <a href='https://docs.python-telegram-bot.org/telegram.ext.basehandler.html'><code>ext.BaseHandler</code></a> <code>Ext.JobQueue</code> and <code>ext.BaseHandler</code>
"); ");
JobQueue(" JobQueue("
<a href='https://docs.python-telegram-bot.org/telegram.ext.jobqueue.html'><code>ext.JobQueue</code></a> <code>ext.JobQueue</code>
schedules tasks to run schedules tasks to run
at specific times at specific times
"); ");
Updater(" Updater("
<a href='https://docs.python-telegram-bot.org/telegram.ext.updater.html'><code>ext.Updater</code></a> <code>ext.Updater</code>
fetches updates from Telegram fetches updates from Telegram
and puts them into the update_queue and puts them into the update_queue
"); ");
@ -88,7 +88,7 @@ flowchart TD;
App -- accesses to build <code>context</code> --> ContextTypes; App -- accesses to build <code>context</code> --> ContextTypes;
App -- "provides arguments for<br>handler callbacks, processes exceptions<br>raised in handler callbacks" --> BaseHandler; App -- "provides arguments for<br>handler callbacks, processes exceptions<br>raised in handler callbacks" --> BaseHandler;
App -- processes exceptions<br>raised in jobs --> JobQueue; App -- processes exceptions<br>raised in jobs --> JobQueue;
App -- fetches data<br>and passes it to<br><a href='https://docs.python-telegram-bot.org/telegram.ext.basepersistence.html'><code>ext.BasePersistence</code></a> --> CallbackDataCache; App -- fetches data<br>and passes it to<br><code>ext.BasePersistence</code> --> CallbackDataCache;
App -- fetches updates from<br>the update_queue --> Updater; App -- fetches updates from<br>the update_queue --> Updater;
App -- updates in<br>regular intervals --> BasePersistence; App -- updates in<br>regular intervals --> BasePersistence;
App -- gets default values<br>for parameters --> Defaults; App -- gets default values<br>for parameters --> Defaults;