mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-04 17:06:21 +00:00
Code Issues Projects Releases Wiki Activity

Implement Embed.__eq__ and EmbedProxy.__eq__

Browse Source
This commit is contained in:
Vioshim
2022-07-26 23:28:10 -05:00
committed by GitHub
parent 9f1c511b47
commit b80cb47caf
2 changed files with 34 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/migrating.rst
View File

@ -883,22 +883,28 @@ The following properties were changed to return a sequence instead of a list:
This change should be transparent, unless you are modifying the sequence by doing things such as ``list.append``.
Removal of ``Embed.Empty``
---------------------------
Embed Changes
--------------
Originally, embeds used a special sentinel to denote emptiness or remove an attribute from display. The ``Embed.Empty`` sentinel was made when Discord's embed design was in a nebulous state of flux. Since then, the embed design has stabilised and thus the sentinel is seen as legacy.
Therefore, ``Embed.Empty`` has been removed in favour of ``None``.
Additionally, ``Embed.__eq__`` has been implemented thus embeds becoming unhashable (e.g. using them in sets or dict keys).
.. code-block:: python
# before
embed = discord.Embed(title='foo')
embed.title = discord.Embed.Empty
embed == embed.copy() # False
# after
embed = discord.Embed(title='foo')
embed.title = None
embed == embed.copy() # True
{embed, embed} # Raises TypeError
Removal of ``InvalidArgument`` Exception