From ef7b886fbe8a3cf24e953780a1997a6254898318 Mon Sep 17 00:00:00 2001 From: GoogleGenius <81032623+GoogleGenius@users.noreply.github.com> Date: Fri, 8 Jul 2022 22:49:40 -0500 Subject: [PATCH 1/4] Remove `!` from `Member.mention` property --- changes/1207.breaking.md | 2 ++ hikari/guilds.py | 10 ++-------- tests/hikari/test_guilds.py | 6 +----- 3 files changed, 5 insertions(+), 13 deletions(-) create mode 100644 changes/1207.breaking.md diff --git a/changes/1207.breaking.md b/changes/1207.breaking.md new file mode 100644 index 0000000000..f7de9ae8f8 --- /dev/null +++ b/changes/1207.breaking.md @@ -0,0 +1,2 @@ +`Member.mention` now returns a mention string without the `!` bang regardless of nickname setting. + - Example: `<@1234567890>` instead of `<@!1234567890>` diff --git a/hikari/guilds.py b/hikari/guilds.py index 0155f078af..77211c0108 100644 --- a/hikari/guilds.py +++ b/hikari/guilds.py @@ -486,18 +486,12 @@ def is_system(self) -> bool: def mention(self) -> str: """Return a raw mention string for the given member. - If the member has a known nickname, we always return - a bang ("`!`") before the ID part of the mention string. This - mimics the behaviour Discord clients tend to provide. - Example ------- ```py - >>> some_member_without_nickname.mention + >>> some_member.mention '<@123456789123456789>' - >>> some_member_with_nickname.mention - '<@!123456789123456789>' ``` Returns @@ -505,7 +499,7 @@ def mention(self) -> str: builtins.str The mention string to use. """ - return f"<@!{self.id}>" if self.nickname is not None else self.user.mention + return self.user.mention def communication_disabled_until(self) -> typing.Optional[datetime.datetime]: """Return when the timeout for this member ends. diff --git a/tests/hikari/test_guilds.py b/tests/hikari/test_guilds.py index 551481e1a3..b3ff77c311 100644 --- a/tests/hikari/test_guilds.py +++ b/tests/hikari/test_guilds.py @@ -485,11 +485,7 @@ def test_display_name_property_when_no_nickname(self, model, mock_user): model.nickname = None assert model.display_name is mock_user.username - def test_mention_property_when_nickname(self, model): - assert model.mention == "<@!123>" - - def test_mention_property_when_no_nickname(self, model, mock_user): - model.nickname = None + def test_mention_property(self, model, mock_user): assert model.mention == mock_user.mention def test_get_guild(self, model): From c53695350a9d979cc14d3c97e03081db55992cb7 Mon Sep 17 00:00:00 2001 From: GoogleGenius <81032623+GoogleGenius@users.noreply.github.com> Date: Tue, 12 Jul 2022 12:46:04 -0500 Subject: [PATCH 2/4] Update fragment message --- changes/1207.breaking.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/changes/1207.breaking.md b/changes/1207.breaking.md index f7de9ae8f8..480e45e1d9 100644 --- a/changes/1207.breaking.md +++ b/changes/1207.breaking.md @@ -1,2 +1 @@ -`Member.mention` now returns a mention string without the `!` bang regardless of nickname setting. - - Example: `<@1234567890>` instead of `<@!1234567890>` +Removed case of `Member.mention` returning bang (!) mention, as it is deprecated by Discord. From b56b79c0a2c4ccfa10dab51ff169cb926c518307 Mon Sep 17 00:00:00 2001 From: GoogleGenius <81032623+GoogleGenius@users.noreply.github.com> Date: Wed, 13 Jul 2022 23:07:05 -0500 Subject: [PATCH 3/4] Update 1207.breaking.md --- changes/1207.breaking.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changes/1207.breaking.md b/changes/1207.breaking.md index 480e45e1d9..3b72d74143 100644 --- a/changes/1207.breaking.md +++ b/changes/1207.breaking.md @@ -1 +1 @@ -Removed case of `Member.mention` returning bang (!) mention, as it is deprecated by Discord. +Removed case of `Member.mention` returning bang (`!`) mention, as it is deprecated by Discord. From c671dd8028cce81452d26d3d1a425d01f68b2bfb Mon Sep 17 00:00:00 2001 From: GoogleGenius <81032623+GoogleGenius@users.noreply.github.com> Date: Thu, 14 Jul 2022 09:42:32 -0500 Subject: [PATCH 4/4] Resolve review --- hikari/guilds.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/hikari/guilds.py b/hikari/guilds.py index 77211c0108..fa75c4ed6f 100644 --- a/hikari/guilds.py +++ b/hikari/guilds.py @@ -484,21 +484,6 @@ def is_system(self) -> bool: @property def mention(self) -> str: - """Return a raw mention string for the given member. - - Example - ------- - - ```py - >>> some_member.mention - '<@123456789123456789>' - ``` - - Returns - ------- - builtins.str - The mention string to use. - """ return self.user.mention def communication_disabled_until(self) -> typing.Optional[datetime.datetime]: