Add section to docs about scheduling

This commit is contained in:
MrNaif2018 2019-07-15 15:37:18 +03:00
parent 5599182fd1
commit bb1470e57f
No known key found for this signature in database
GPG Key ID: 5CDE50436C3DB40C
2 changed files with 74 additions and 0 deletions

View File

@ -40,6 +40,7 @@ Welcome to Pyrogram
topics/more-on-updates
topics/config-file
topics/smart-plugins
topics/scheduling
topics/auto-auth
topics/session-settings
topics/tgcrypto

View File

@ -0,0 +1,73 @@
Scheduling tasks
================
Pyrogram itself as Telegram MTProto API Framework contains only stuff
related to Telegram. Scheduling is out of it's scope.
But it is easy to integrate pyrogram with your favourite scheduler.
schedule
--------
Note that schedule is not suitable for async version of pyrogram.
.. code-block:: python
import time
import schedule
def job():
app.send_message("me", "Hi!")
schedule.every(10).minutes.do(job)
schedule.every().hour.do(job)
schedule.every().day.at("10:30").do(job)
schedule.every(5).to(10).minutes.do(job)
schedule.every().monday.do(job)
schedule.every().wednesday.at("13:15").do(job)
schedule.every().minute.at(":17").do(job)
with app:
while True:
schedule.run_pending()
time.sleep(1)
apscheduler
-----------
.. code-block:: python
import time
from apscheduler.schedulers.background import BackgroundScheduler
def job():
app.send_message("me", "Hi!")
scheduler = BackgroundScheduler()
scheduler.add_job(job, 'interval', seconds=3)
scheduler.start()
app.run()
Apscheduler supports async version of pyrogram too, here is async example:
.. code-block:: python
from apscheduler.schedulers.asyncio import AsyncIOScheduler
async def job():
await app.send_message("me", "Hi!")
scheduler = AsyncIOScheduler()
scheduler.add_job(job, 'interval', seconds=3)
scheduler.start()
app.run()