feat(loop): add optional overlap support to allow concurrent loop executions

[Lumabots]

Summary

Information

• This PR fixes an issue.
• This PR adds something new (e.g. new method or parameters).
• This PR is a breaking change (e.g. methods or parameters removed/renamed).
• This PR is not a code change (e.g. documentation, README, typehinting,
  examples, ...).

Checklist

• I have searched the open pull requests for duplicates.
• If code changes were made then they have been tested.
  • I have updated the documentation to reflect the changes.
• If type: ignore comments were used, a comment is also left explaining why.
• I have updated the changelog to include these changes.

[Lumabots]

sorry i renamed the branch and it deleted the other one

[plun1331]

We should probably add an additional parameter for limiting the number of active tasks

[Lumabots]

We should probably add an additional parameter for limiting the number of active tasks

maybe:
def init(self, ..., overlap: bool | int = True):

If overlap is:

True: allow overlapping tasks with no limit (default).

False: do not allow overlapping (wait for task to finish).

An int: allow overlapping up to n concurrent tasks.

[Lumabots]

so i did some change but i'll debug that tonight + if someone can tell me about my implementation in case overlap if false, should i stick with await coro ? or else its good like so

[Lumabots]

not ready for review

[Lumabots]

well my new fix breaks a bit the current_loop number, if anyone has an idea

[Lumabots]

    @tasks.loop(seconds=5, overlap=2)
    async def test_loop(self):
        logger.debug(
            f"test loop {self.test_loop.current_loop}, Next loop {self.test_loop.next_iteration}, tasks {self.test_loop.get_task()}"
        )
        await asyncio.sleep(15)
        logger.debug(f"test loop done {self.test_loop.current_loop}")

[plun1331]

well my new fix breaks a bit the current_loop number, if anyone has an idea

probably because all the loops have the same state, so after 3 loops run they'll all thing they're on 3

[plun1331]

Oh, one extra thing, tasks should be removed from _tasks after they complete (otherwise the list will just grow infinitely)

[Lumabots]

i mean i dont really think thats an issue, since its overlapping there is no way to keep the current loop inside the same thing, and if i do make that for inside the loop the current loop doesnt update then in every other usage than the loop it itself the number will not be accurate.

well my new fix breaks a bit the current_loop number, if anyone has an idea

probably because all the loops have the same state, so after 3 loops run they'll all thing they're on 3

yep ik that, but im working on something for inside the loop we do have the same current loop and outside we have the general index. If not needed i can just let this behavour

[plun1331]

I think we just change the docs to specify that it represents the number of loops that have been started

[Lumabots]

so i did that inside the loop it continue to give the same one, but if you use another command it return the real one, what do you think about that

[plun1331]

if you can get that to work then that would be fine

[Lumabots]

so this is the result inside the loop for @tasks.loop(seconds=5, overlap=True) async def test_loop(self): logger.debug( f"test loop {self.test_loop.current_loop}, Next loop {self.test_loop.next_iteration}, tasks {self.test_loop.get_task()}" ) await asyncio.sleep(15) logger.debug(f"test loop done {self.test_loop.current_loop}")

but inside my command if i do
await ctx.respond(f"test, {self.test_loop.current_loop}")

it will return the number of loop totals like before

[Lumabots]

Oh, one extra thing, tasks should be removed from _tasks after they complete (otherwise the list will just grow infinitely)

is this enough ?

task = asyncio.create_task(
    (
        self.coro(*args, **kwargs)
        if self.overlap is True
        else run_with_semaphore()
    ),
    name=f"pycord-loop-{self.coro.__name__}-{self._current_loop}",
)
task.add_done_callback(self._tasks.remove)
self._tasks.append(task)

[Lumabots]

should be ready for review