e965a675c1
Some checks failed
Deploy MkDocs / deploy (push) Has been cancelled
Makes commonly used classes, functions, and decorators from `disagreement.ext` and `disagreement.ui` submodules directly accessible under the `disagreement` namespace. This change simplifies import statements for users, leading to cleaner and more concise code. Documentation and examples have been updated to reflect these new, simplified import paths.
65 lines
1.2 KiB
Markdown
65 lines
1.2 KiB
Markdown
# Task Loops
|
|
|
|
The tasks extension allows you to run functions periodically. Decorate an async function with `@loop` and start it using `.start()`.
|
|
|
|
```python
|
|
from disagreement import loop
|
|
|
|
@loop(minutes=1.0)
|
|
async def announce():
|
|
print("Hello from a loop")
|
|
|
|
announce.start()
|
|
```
|
|
|
|
Stop the loop with `.stop()` when you no longer need it.
|
|
|
|
You can provide the interval in seconds, minutes, hours or as a `datetime.timedelta`:
|
|
|
|
```python
|
|
import datetime
|
|
|
|
@loop(delta=datetime.timedelta(seconds=30))
|
|
async def ping():
|
|
...
|
|
```
|
|
|
|
Handle exceptions raised by the looped coroutine using `on_error`:
|
|
|
|
```python
|
|
async def log_error(exc: Exception) -> None:
|
|
print("Loop failed:", exc)
|
|
|
|
@loop(seconds=5.0, on_error=log_error)
|
|
async def worker():
|
|
...
|
|
```
|
|
|
|
Run setup and teardown code using `before_loop` and `after_loop`:
|
|
|
|
```python
|
|
@loop(seconds=5.0)
|
|
async def worker():
|
|
...
|
|
|
|
@worker.before_loop
|
|
async def before_worker():
|
|
print("starting")
|
|
|
|
@worker.after_loop
|
|
async def after_worker():
|
|
print("stopped")
|
|
```
|
|
|
|
You can also schedule a task at a specific time of day:
|
|
|
|
```python
|
|
from datetime import datetime, timedelta
|
|
|
|
time_to_run = (datetime.now() + timedelta(seconds=5)).time()
|
|
|
|
@loop(time_of_day=time_to_run)
|
|
async def daily_task():
|
|
...
|
|
```
|