Changelog¶

v0.5.0¶

Full Changelog: https://github.com/thegamecracks/discord-ws/compare/v0.4.0…v0.5.0

Fixes¶

Fix py.typed marker not being included in the package
Use if __name__ == "__main__": condition in discord_ws/__main__.py to prevent side effects when imported

Documentation¶

Add this documentation site

If you found me from the repository, 👋 hello!

v0.4.0¶

Full Changelog: https://github.com/thegamecracks/discord-ws/compare/v0.3.0…v0.4.0

Breaking Changes¶

Significantly refactor Client internal methods for improved extensibility
Client.run(reconnect=False) may now raise GatewayReconnect and SessionInvalidated
Client.run() is now expected to raise an exception group
Remove Heart(client) dependency in favour of directly accepting a stream in Heart.stay_alive()
Remove client attribute from Stream protocol in favour of ws interface

New Features¶

Add Client.presence and Client.set_presence() for setting bot presence
Add Client.large_threshold to specify the desired threshold for offline members to not be sent

Fixes¶

Correct typo causing seq to be missing when sending RESUME event

v0.3.0¶

Full Changelog: https://github.com/thegamecracks/discord-ws/compare/v0.2.0…v0.3.0

Breaking Changes¶

Potentially raise HeartbeatLostError when using Client.run(reconnect=False) rather than cleanly exiting
Remove Client.create() classmethod in favour of constructing Client directly
Replace on_dispatch parameter from Client() with Client.on_dispatch() method

Fixes¶

Prevent potential race condition with session ID being unset
Use local Random instance in heartbeat to avoid affecting user state

v0.2.0¶

Full Changelog: https://github.com/thegamecracks/discord-ws/compare/v0.1.0…v0.2.0

New Features¶

Improve logging of connection closures
Implement exponential backoff to avoid spamming Discord with connections

Fixes¶

Prevent full write buffer from causing double heartbeats
Fix client reconnecting after calling Client.close()

Documentation¶

Indicate that bot tokens should be prefixed with Bot

v0.1.0¶

This marks the first release of the discord-ws library! 🎉

$ python -m discord_ws --env-token TOKEN --no-intents
      discord_ws.client.client (   DEBUG) => Requesting gateway URL
      discord_ws.client.client (   DEBUG) => Starting connection loop
      discord_ws.client.client (   DEBUG) => Creating websocket connection
      discord_ws.client.stream (   DEBUG) => Received 124 chars
      discord_ws.client.client (   DEBUG) => Received hello from gateway
   discord_ws.client.heartbeat (   DEBUG) => Waiting 42.17s for heartbeat
      discord_ws.client.client (   DEBUG) => Sending identify payload
      discord_ws.client.stream (   DEBUG) => Received 1855 chars
      discord_ws.client.client (   DEBUG) => Received READY event