refactor: Update `Client.run` to have a better async I/O usage #2645

DA-344 · 2024-11-11T19:42:52Z

Summary

This PR refactors the Client.run logic to fix problems involving asyncio due to how the library used the loop:

Needs testing

Exception

  File "/home/container/main.py", line 23, in <module>
    bot.run(BOT_TOKEN)

  File "/home/container/.local/lib/python3.11/site-packages/discord/client.py", line 772, in run
    loop.run_forever()

  File "/usr/local/lib/python3.11/asyncio/base_events.py", line 608, in run_forever
    self._run_once()

  File "/usr/local/lib/python3.11/asyncio/base_events.py", line 1936, in _run_once
    handle._run()

  File "/usr/local/lib/python3.11/asyncio/events.py", line 84, in _run
    self._context.run(self._callback, *self._args)

  File "/usr/local/lib/python3.11/asyncio/selector_events.py", line 956, in _read_ready
    self._read_ready_cb()

  File "/usr/local/lib/python3.11/asyncio/selector_events.py", line 988, in _read_ready__get_buffer
    self._protocol.buffer_updated(nbytes)

  File "/usr/local/lib/python3.11/asyncio/sslproto.py", line 439, in buffer_updated
    self._do_handshake()

  File "/usr/local/lib/python3.11/asyncio/sslproto.py", line 560, in _do_handshake
    self._sslobj.do_handshake()

  File "/usr/local/lib/python3.11/ssl.py", line 979, in do_handshake
    self._sslobj.do_handshake()

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.

discord/client.py

Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

DA-344 · 2024-11-19T15:17:38Z

Applied all the changes Dorukyum requested.

Before merging, I would like some feedback on this discussion message

Signed-off-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com>

…se Client._closed asyncio.Event object

Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Lulalaby · 2025-03-23T17:41:23Z

@DA-344 can u fix merge conflicts for the changelog?
@Pycord-Development/contributors can we get some testing here :D

…into fix/client-run

DA-344 · 2025-03-23T17:47:56Z

@DA-344 can u fix merge conflicts for the changelog?

Okay, it should be fixed now. 👍

Lumabots · 2025-05-10T11:09:53Z

i tested this pr on my prod bot for some hours and nothing to issue to signal

Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

discord/client.py

DA-344 · 2025-05-27T20:43:41Z

I've done some testing and it has been working as expected. Can this pr get any review more/merge ?

Paillat-dev · 2025-05-27T20:45:04Z

This is required if we ever want py 3.14 support, see my pr about that

DA-344 · 2025-05-27T20:46:42Z

Not just for 3.14 support, but to fix all asyncio related issues that can be presented in any version due to how the AbstractEventLoop is currently handled.

VincentRPS

LGTM

Dorukyum · 2025-05-28T04:14:31Z

discord/client.py

@@ -221,14 +226,12 @@ class Client:
    def __init__(
        self,
        *,
-        loop: asyncio.AbstractEventLoop | None = None,
+        loop: asyncio.AbstractEventLoop = MISSING,


I feel like I've said this before, but I can't find my comment.

MISSING has a very specific use case, None should work fine here. (Haven't tested.)

It's MISSING because the loop is empty, and not null, empty because it is set later on the code, and will always have a value after start.
Also, this is more user friendly, instead of them having to do if bot.loop checks or assert bot.loop

I'm also not certain I get this. MISSING is (as far as I'm concerned) used when there is a need to differentiate None from another singleton. Here, that is not the case. But I might be missing something, tell me if that's the case.

To clarify my reasoning a lil bit more: MISSING is used because a loop is not null in a async context, just not initialized. The idea of it is that it will always hold a valid event loop once the bot has started, but if not, then it is just not available.

And as I said, this also simplifies the user interface so they dont need to do if/assert X checks, because it is safe to assume that after start a loop will always be available, and will never be None.

But if using None is preferred then yeah i could revert the change

If that's your reasoning, I understand but I think None's usage shouldn't be limited to representing literally nothing. As for the loop being always available and not None or MISSING, the only way of doing it in a typesafe manner afaik is something like:

class Foo: def __init__(self): self._bar_: Type | None = None @property def bar(self) -> Type: if not self._bar: raise ValueError("Foo.bar is not initialized") return self._bar @bar.setter def bar(self, val: Type): self._bar = val

Currently, with your change to MISSING, Client.loop's type hints are not representative of its actual value anymore, which shouldn't be the case.

If you want, you could implement the @property solution to make the API easier for users, or just leave the | None

You could also pull a dpy and make it raise a special error when someone tries to access something from the loop instead of the literal attribute:
https://github.com/Rapptz/discord.py/blob/26855160f8a8f0dfade609cce6b1bc97f8b8fa14/discord/client.py#L138-L152

But that's a bit overkill imo.

That is indeed overkill imo

Yeah I will change it to be a property, that would be better.

@DA-344 Could you also change it to None ? Thx

Paillat-dev · 2025-05-29T11:00:27Z

CHANGELOG.md

@@ -107,6 +107,8 @@ These changes are available on the `master` branch, but have not yet been releas
  ([#2767])(https://github.com/Pycord-Development/pycord/pull/2767)
 - Fixed `Webhook.edit` not working with `attachments=[]`.
  ([#2779])(https://github.com/Pycord-Development/pycord/pull/2779)
+- Fixed Async I/O errors that could be raised when using `Client.run`.


Idk if this is the best wording, the scope of this pr seems to be broader than just fixing errors. But idk this is also probably good enough.

Paillat-dev

lgtm as long as that MISSING comment is resolved in some way or another, nice pr

…o fix/client-run

Paillat-dev · 2025-06-07T12:23:38Z

discord/client.py

-        _cleanup_loop(self.loop)
+        # asyncio.run automatically does the cleanup tasks, so if we use
+        # it we don't need to clean up the tasks.
+        if requires_cleanup:


Couldn't you just do if run == asyncio.run ?

DA-344 added 3 commits November 11, 2024 18:25

fix: client.run not allowing bots to start

de49cf5

chore: Update more things

4fe559f

chore: Move the loop update to .start

74863c5

DA-344 requested a review from a team as a code owner November 11, 2024 19:42

pullapprove4 bot requested a review from ChickenDevs November 11, 2024 19:42

pullapprove4 bot added PA: All Contributors pending PA: Maintainers pending labels Nov 11, 2024

DA-344 and others added 7 commits November 11, 2024 21:31

chore: Added logging and updated run to specify the arguments

72f904c

style(pre-commit): auto fixes from pre-commit.com hooks

7e7f1e9

chore: Updated CHANGELOG

f289f74

Merge changes from remote

2195dc6

style(pre-commit): auto fixes from pre-commit.com hooks

3d235ee

dot

07ccbc9

Merge branch 'master' into fix/client-run

ef835dc

Lulalaby requested review from NeloBlivion, plun1331 and Dorukyum and removed request for ChickenDevs November 11, 2024 23:03

Dorukyum requested changes Nov 18, 2024

View reviewed changes

discord/client.py Outdated Show resolved Hide resolved

discord/client.py Outdated Show resolved Hide resolved

pullapprove4 bot removed PA: All Contributors pending PA: Maintainers pending labels Nov 18, 2024

DA-344 and others added 2 commits November 19, 2024 08:23

Update docstrings

5e8a322

Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Update docstrings

de5156c

Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

DA-344 added 6 commits November 19, 2024 16:25

merge 'master' from https://github.com/Pycord-Development/pycord

b830a94

chore: Update Client.__aenter__ and Client.run

88484e2

feat: Add operations container to Client docstring

ba81ebe

chore: merge branch 'master' from Pycord-Development/pycord

f5f0085

chore: Update Client.close to prevent double closing and race conditions

28fab35

fix: Indentation error

c378d41

Dorukyum and others added 3 commits January 31, 2025 22:47

Merge branch 'master' into fix/client-run

e818a1c

Signed-off-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com>

chore: Update Client.close and Client.clear to correctly update and u…

e963341

…se Client._closed asyncio.Event object

Merge branch 'master' into fix/client-run

e19e029

Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Merge branch 'master' of https://github.com/Pycord-Development/pycord …

abf0ca0

…into fix/client-run

Dorukyum added the hold: testing This pull request requires further testing label Mar 31, 2025

Paillat-dev mentioned this pull request Apr 17, 2025

feat: ✨ Update to support python 3.14 #2764

Draft

9 tasks

Merge branch 'master' into fix/client-run

81541a3

Lumabots approved these changes May 10, 2025

View reviewed changes

Merge branch 'master' into fix/client-run

2735849

Signed-off-by: DA344 <108473820+DA-344@users.noreply.github.com>

Dorukyum requested changes May 11, 2025

View reviewed changes

discord/client.py Show resolved Hide resolved

discord/client.py Show resolved Hide resolved

VincentRPS previously approved these changes May 27, 2025

View reviewed changes

Dorukyum requested changes May 28, 2025

View reviewed changes

Paillat-dev reviewed May 29, 2025

View reviewed changes

Paillat-dev approved these changes May 29, 2025

View reviewed changes

DA-344 added 2 commits June 7, 2025 13:50

merge master

c88cac8

chore: make loop a property

0bc5014

DA-344 dismissed VincentRPS’s stale review via 0bc5014 June 7, 2025 11:52

pre-commit-ci bot and others added 3 commits June 7, 2025 11:53

style(pre-commit): auto fixes from pre-commit.com hooks

e60bda3

chore: make cleanup be done only when necessary

cb05d05

Merge branch 'fix/client-run' of https://github.com/DA-344/pycord int…

81e61b8

…o fix/client-run

Paillat-dev reviewed Jun 7, 2025

View reviewed changes

Uh oh!

refactor: Update Client.run to have a better async I/O usage #2645

Are you sure you want to change the base?

refactor: Update Client.run to have a better async I/O usage #2645

Uh oh!

Conversation

DA-344 commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Information

Checklist

Uh oh!

Uh oh!

Uh oh!

DA-344 commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Lulalaby commented Mar 23, 2025

Uh oh!

DA-344 commented Mar 23, 2025

Uh oh!

Lumabots commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DA-344 commented May 27, 2025

Uh oh!

Paillat-dev commented May 27, 2025

Uh oh!

DA-344 commented May 27, 2025

Uh oh!

VincentRPS left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Paillat-dev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

refactor: Update `Client.run` to have a better async I/O usage #2645

refactor: Update `Client.run` to have a better async I/O usage #2645

DA-344 commented Nov 11, 2024 •

edited

Loading

DA-344 commented Nov 19, 2024 •

edited

Loading

Lumabots commented May 10, 2025 •

edited

Loading

Paillat-dev left a comment •

edited

Loading