Skip to content

Commit 4498ae5

Browse files
RevnoplexPaillat-devpre-commit-ci[bot]
authored
fix: remove internal use of deprecated suppress (#3154)
* fix: remove internal use of deprecated suppress * Update discord/ext/pages/pagination.py Co-authored-by: Paillat <jeremiecotti@ik.me> Signed-off-by: Revnoplex <62947003+Revnoplex@users.noreply.github.com> * changelog entry for #3154 * style(pre-commit): auto fixes from pre-commit.com hooks * revert changelog --------- Signed-off-by: Revnoplex <62947003+Revnoplex@users.noreply.github.com> Co-authored-by: Paillat <jeremiecotti@ik.me> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 201fd29 commit 4498ae5

File tree

4 files changed

+101
-16
lines changed

4 files changed

+101
-16
lines changed

discord/ext/pages/pagination.py

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@
4343
"Page",
4444
)
4545

46+
from ...utils import warn_deprecated
47+
4648

4749
class PaginatorButton(discord.ui.Button):
4850
"""Creates a button used to navigate the paginator.
@@ -1065,6 +1067,7 @@ async def edit(
10651067
self,
10661068
message: discord.Message,
10671069
suppress: bool | None = None,
1070+
suppress_embeds: bool = None,
10681071
allowed_mentions: discord.AllowedMentions | None = None,
10691072
delete_after: float | None = None,
10701073
user: User | Member | None = None,
@@ -1084,6 +1087,15 @@ async def edit(
10841087
all the embeds if set to ``True``. If set to ``False``
10851088
this brings the embeds back if they were suppressed.
10861089
Using this parameter requires :attr:`~.Permissions.manage_messages`.
1090+
1091+
.. deprecated:: 2.8
1092+
suppress_embeds: :class:`bool`
1093+
Whether to suppress embeds for the message. This removes
1094+
all the embeds if set to ``True``. If set to ``False``
1095+
this brings the embeds back if they were suppressed.
1096+
Using this parameter requires :attr:`~.Permissions.manage_messages`.
1097+
1098+
.. versionadded:: 2.8
10871099
allowed_mentions: Optional[:class:`~discord.AllowedMentions`]
10881100
Controls the mentions being processed in this message. If this is
10891101
passed, then the object is merged with :attr:`~discord.Client.allowed_mentions`.
@@ -1119,14 +1131,19 @@ async def edit(
11191131
if not self.user:
11201132
self.usercheck = False
11211133

1134+
if suppress is not None:
1135+
warn_deprecated("suppress", "suppress_embeds", "2.8")
1136+
if suppress_embeds is None:
1137+
suppress_embeds = suppress
1138+
11221139
try:
11231140
self.message = await message.edit(
11241141
content=page_content.content,
11251142
embeds=page_content.embeds,
11261143
files=page_content.files,
11271144
attachments=[],
11281145
view=self,
1129-
suppress=suppress,
1146+
suppress_embeds=suppress_embeds,
11301147
allowed_mentions=allowed_mentions,
11311148
delete_after=delete_after,
11321149
)

discord/interactions.py

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ async def edit_original_response(
619619
view=view,
620620
allowed_mentions=allowed_mentions,
621621
previous_allowed_mentions=previous_mentions,
622-
suppress=suppress_embeds,
622+
suppress_embeds=suppress_embeds,
623623
)
624624
if view and self.message:
625625
self._state.prevent_view_updates_for(self.message.id)
@@ -1622,6 +1622,7 @@ async def edit(
16221622
allowed_mentions: AllowedMentions | None = None,
16231623
delete_after: float | None = None,
16241624
suppress: bool | None = MISSING,
1625+
suppress_embeds: bool | None = MISSING,
16251626
) -> InteractionMessage:
16261627
"""|coro|
16271628
@@ -1657,6 +1658,12 @@ async def edit(
16571658
suppress: Optional[:class:`bool`]
16581659
Whether to suppress embeds for the message.
16591660
1661+
.. deprecated:: 2.8
1662+
suppress_embeds: Optional[:class:`bool`]
1663+
Whether to suppress embeds for the message.
1664+
1665+
.. versionadded:: 2.8
1666+
16601667
Returns
16611668
-------
16621669
:class:`InteractionMessage`
@@ -1675,8 +1682,15 @@ async def edit(
16751682
"""
16761683
if attachments is MISSING:
16771684
attachments = self.attachments or MISSING
1678-
if suppress is MISSING:
1679-
suppress = self.flags.suppress_embeds
1685+
1686+
if suppress is not MISSING:
1687+
warn_deprecated("suppress", "suppress_embeds", "2.8")
1688+
if suppress_embeds is MISSING:
1689+
suppress_embeds = suppress
1690+
1691+
if suppress_embeds is MISSING:
1692+
suppress_embeds = self.flags.suppress_embeds
1693+
16801694
return await self._state._interaction.edit_original_response(
16811695
content=content,
16821696
embeds=embeds,
@@ -1687,7 +1701,7 @@ async def edit(
16871701
view=view,
16881702
allowed_mentions=allowed_mentions,
16891703
delete_after=delete_after,
1690-
suppress=suppress,
1704+
suppress_embeds=suppress_embeds,
16911705
)
16921706

16931707
async def delete(self, *, delay: float | None = None) -> None:

discord/webhook/async_.py

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -901,6 +901,7 @@ async def edit(
901901
view: BaseView | None = MISSING,
902902
allowed_mentions: AllowedMentions | None = None,
903903
suppress: bool | None = MISSING,
904+
suppress_embeds: bool | None = MISSING,
904905
) -> WebhookMessage:
905906
"""|coro|
906907
@@ -945,6 +946,12 @@ async def edit(
945946
suppress: Optional[:class:`bool`]
946947
Whether to suppress embeds for the message.
947948
949+
.. deprecated:: 2.8
950+
suppress_embeds: Optional[:class:`bool`]
951+
Whether to suppress embeds for the message.
952+
953+
.. versionadded:: 2.8
954+
948955
Returns
949956
-------
950957
:class:`WebhookMessage`
@@ -974,8 +981,13 @@ async def edit(
974981
if attachments is MISSING:
975982
attachments = self.attachments or MISSING
976983

977-
if suppress is MISSING:
978-
suppress = self.flags.suppress_embeds
984+
if suppress is not MISSING:
985+
warn_deprecated("suppress", "suppress_embeds", "2.8")
986+
if suppress_embeds is MISSING:
987+
suppress_embeds = suppress
988+
989+
if suppress_embeds is MISSING:
990+
suppress_embeds = self.flags.suppress_embeds
979991

980992
return await self._state._webhook.edit_message(
981993
self.id,
@@ -988,7 +1000,7 @@ async def edit(
9881000
view=view,
9891001
allowed_mentions=allowed_mentions,
9901002
thread=thread,
991-
suppress=suppress,
1003+
suppress_embeds=suppress_embeds,
9921004
)
9931005

9941006
async def delete(self, *, delay: float | None = None) -> None:
@@ -1897,7 +1909,7 @@ async def send(
18971909
previous_allowed_mentions=previous_mentions,
18981910
thread_name=thread_name,
18991911
silent=silent,
1900-
suppress=suppress_embeds,
1912+
suppress_embeds=suppress_embeds,
19011913
)
19021914
adapter = async_context.get()
19031915
thread_id: int | None = None
@@ -2009,7 +2021,8 @@ async def edit_message(
20092021
view: BaseView | None = MISSING,
20102022
allowed_mentions: AllowedMentions | None = None,
20112023
thread: Snowflake | None = MISSING,
2012-
suppress: bool = False,
2024+
suppress: bool | None = None,
2025+
suppress_embeds: bool = None,
20132026
) -> WebhookMessage:
20142027
"""|coro|
20152028
@@ -2060,6 +2073,12 @@ async def edit_message(
20602073
suppress: :class:`bool`
20612074
Whether to suppress embeds for the message.
20622075
2076+
.. deprecated:: 2.8
2077+
suppress_embeds: :class:`bool`
2078+
Whether to suppress embeds for the message.
2079+
2080+
.. versionadded:: 2.8
2081+
20632082
Returns
20642083
-------
20652084
:class:`WebhookMessage`
@@ -2104,6 +2123,12 @@ async def edit_message(
21042123
previous_mentions: AllowedMentions | None = getattr(
21052124
self._state, "allowed_mentions", None
21062125
)
2126+
if suppress is not None:
2127+
warn_deprecated("suppress", "suppress_embeds", "2.8")
2128+
if suppress_embeds is None:
2129+
suppress_embeds = suppress
2130+
elif suppress_embeds is None:
2131+
suppress_embeds = False
21072132
params = handle_message_parameters(
21082133
content=content,
21092134
file=file,
@@ -2114,7 +2139,7 @@ async def edit_message(
21142139
view=view,
21152140
allowed_mentions=allowed_mentions,
21162141
previous_allowed_mentions=previous_mentions,
2117-
suppress=suppress,
2142+
suppress_embeds=suppress_embeds,
21182143
)
21192144

21202145
thread_id: int | None = None

discord/webhook/sync.py

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@ def edit(
542542
files=files,
543543
allowed_mentions=allowed_mentions,
544544
thread=thread,
545-
suppress=suppress_embeds,
545+
suppress_embeds=suppress_embeds,
546546
)
547547

548548
def delete(self, *, delay: float | None = None) -> None:
@@ -986,7 +986,8 @@ def send(
986986
thread: Snowflake = MISSING,
987987
thread_name: str | None = None,
988988
wait: bool = False,
989-
suppress: bool = False,
989+
suppress: bool | None = None,
990+
suppress_embeds: bool = None,
990991
) -> SyncWebhookMessage | None:
991992
"""Sends a message using the webhook.
992993
@@ -1042,6 +1043,12 @@ def send(
10421043
suppress: :class:`bool`
10431044
Whether to suppress embeds for the message.
10441045
1046+
.. deprecated:: 2.8
1047+
suppress_embeds: :class:`bool`
1048+
Whether to suppress embeds for the message.
1049+
1050+
.. versionadded:: 2.8
1051+
10451052
Returns
10461053
-------
10471054
Optional[:class:`SyncWebhookMessage`]
@@ -1078,6 +1085,13 @@ def send(
10781085
if thread and thread_name:
10791086
raise InvalidArgument("You cannot specify both a thread and a thread name")
10801087

1088+
if suppress is not None:
1089+
warn_deprecated("suppress", "suppress_embeds", "2.8")
1090+
if suppress_embeds is None:
1091+
suppress_embeds = suppress
1092+
elif suppress_embeds is None:
1093+
suppress_embeds = False
1094+
10811095
params = handle_message_parameters(
10821096
content=content,
10831097
username=username,
@@ -1089,7 +1103,7 @@ def send(
10891103
embeds=embeds,
10901104
allowed_mentions=allowed_mentions,
10911105
previous_allowed_mentions=previous_mentions,
1092-
suppress=suppress,
1106+
suppress_embeds=suppress_embeds,
10931107
thread_name=thread_name,
10941108
)
10951109
adapter: WebhookAdapter = _get_webhook_adapter()
@@ -1171,7 +1185,8 @@ def edit_message(
11711185
files: list[File] = MISSING,
11721186
allowed_mentions: AllowedMentions | None = None,
11731187
thread: Snowflake | None = MISSING,
1174-
suppress: bool = False,
1188+
suppress: bool | None = None,
1189+
suppress_embeds: bool = None,
11751190
) -> SyncWebhookMessage:
11761191
"""Edits a message owned by this webhook.
11771192
@@ -1201,6 +1216,14 @@ def edit_message(
12011216
See :meth:`.abc.Messageable.send` for more information.
12021217
thread: Optional[:class:`~discord.abc.Snowflake`]
12031218
The thread that contains the message.
1219+
suppress: :class:`bool`
1220+
Whether to suppress embeds for the message.
1221+
1222+
.. deprecated:: 2.8
1223+
suppress_embeds: :class:`bool`
1224+
Whether to suppress embeds for the message.
1225+
1226+
.. versionadded:: 2.8
12041227
12051228
Raises
12061229
------
@@ -1224,6 +1247,12 @@ def edit_message(
12241247
previous_mentions: AllowedMentions | None = getattr(
12251248
self._state, "allowed_mentions", None
12261249
)
1250+
if suppress is not None:
1251+
warn_deprecated("suppress", "suppress_embeds", "2.8")
1252+
if suppress_embeds is None:
1253+
suppress_embeds = suppress
1254+
elif suppress_embeds is None:
1255+
suppress_embeds = False
12271256
params = handle_message_parameters(
12281257
content=content,
12291258
file=file,
@@ -1232,7 +1261,7 @@ def edit_message(
12321261
embeds=embeds,
12331262
allowed_mentions=allowed_mentions,
12341263
previous_allowed_mentions=previous_mentions,
1235-
suppress=suppress,
1264+
suppress_embeds=suppress_embeds,
12361265
)
12371266
adapter: WebhookAdapter = _get_webhook_adapter()
12381267

0 commit comments

Comments
 (0)