How to loop a task in discord.py

Question

I am experimenting with making my own little discord bot that can get information from Twitch, but I'm stumped on how to make the bot loop and check for a condition.

I want the bot to loop a section of code every few seconds that checks if the specified twitch channel is live.

Code

import discord
from discord.ext import commands, tasks
from twitch import TwitchClient
from pprint import pformat


client = TwitchClient(client_id='<twitch token>')

bot = commands.Bot(command_prefix='$')

@bot.event
async def on_ready():
    print('We have logged in as {0.user}'.format(bot))

@bot.command()
async def info(ctx, username):
    response = await ctx.send("Querying twitch database...")
    try:
        users = client.users.translate_usernames_to_ids(username)
        for user in users:
            print(user.id)
            userid = user.id
        twitchinfo = client.users.get_by_id(userid)
        status = client.streams.get_stream_by_user(userid)
        if status == None:
            print("Not live")
            livestat = twitchinfo.display_name + "is not live"
        else:
            livestat = twitchinfo.display_name + " is " + status.stream_type
        responsemsg = pformat(twitchinfo) + "\n" + livestat
        await response.edit(content=responsemsg)
    except:
        await response.edit(content="Invalid username")

bot.run("<discord token>")

I want the bot to run the following code every 10 seconds, for example:

status = client.streams.get_stream_by_user(<channel id>)
if status == None:
     print("Not live")
     livestat = twitchinfo.display_name + "is not live"
else:
     livestat = twitchinfo.display_name + " is " + status.stream_type

I've tried using @tasks.loop(seconds=10) to try and make a custom async def repeat every 10 seconds but it didn't seem to work.

Any ideas?

score 24 · Answer 1 · answered Mar 22 '21 at 20:32

24

The newer version of discord.py doesn't support client.command()

To achieve the same I used the following snippet

import discord
from discord.ext import tasks

client = discord.Client()

@tasks.loop(seconds = 10) # repeat after every 10 seconds
async def myLoop():
    # work


myLoop.start()

client.run('<your token>')

answered Mar 22 '21 at 20:32

Lovesh Dongre

1,294
8
23

4

for the myLoop.start() line I get the error : `RuntimeError: no running event loop` `sys:1: RuntimeWarning: coroutine 'Loop._loop' was never awaited` – bbrendon Dec 04 '22 at 22:28
1

@Brendon this is because all awaits need to happen inside an async function. Put `myLoop.start()` inside the async `on_ready` function and it'll work. – David Maness Feb 15 '23 at 23:03

score 8 · Accepted Answer · answered May 20 '20 at 19:18

8

This can be done like so:

async def my_task(ctx, username):
    while True:
        # do something
        await asyncio.sleep(10)

@client.command()
async def info(ctx, username):
    client.loop.create_task(my_task(ctx, username))

References:

answered May 20 '20 at 19:18

Diggy.

6,744
3
19
38

How would i go about breaking this loop? – sanguine Oct 07 '20 at 18:35
1

[loop.stop()](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.stop) could do the trick. – Diggy. Oct 07 '20 at 19:52

score 5 · Answer 3 · answered Mar 22 '22 at 07:34

5

This is the most proper way to implement background tasks.

from discord.ext import commands, tasks

bot = commands.Bot(...)

@bot.listen()
async def on_ready():
    task_loop.start() # important to start the loop

@tasks.loop(seconds=10)
async def task_loop():
    ... # this code will be executed every 10 seconds after the bot is ready

Check this for more info

answered Mar 22 '22 at 07:34

Exenifix

71
1
7

You know why this happens? AttributeError: 'function' object has no attribute 'start' – OldSport Jun 20 '22 at 17:11
Seems like you didn't decorate your function or decorated it in a wrong way @OldSport – Exenifix Jun 21 '22 at 19:42

bbrendon · Answer 4 · 2022-12-04T22:50:39.777

I struggled with this as well. The problem I ran into is that none of the examples online were complete. Here is one I came up with that uses @tasks.loop(seconds=10).


import discord
import os
from discord.ext import tasks
from dotenv import load_dotenv

intents = discord.Intents.all()
client = discord.Client(command_prefix="!", intents=intents)

load_dotenv()
token = os.getenv("DISCORD_TOKEN")
CHANNEL_ID = 1234

@client.event
async def on_ready():
    print(f"We have logged in as {client.user}")
    myloop.start()

@client.event
async def on_message(message):
    if message.author == client.user: 
        return

    if message.content.startswith("hi"):
        await message.channel.send("Hello!")

@tasks.loop(seconds=10)
async def myloop():
    channel = client.get_channel(CHANNEL_ID)
    await channel.send("Message")

client.run(token)

How to loop a task in discord.py

4 Answers4

Linked

Related