From 106ad77cc2737dd15aa094c64076376e87c383a9 Mon Sep 17 00:00:00 2001 From: blord0 Date: Wed, 18 Jun 2025 13:05:11 +0100 Subject: [PATCH] Rename all clan references to primary_guild --- discord/asset.py | 2 +- discord/{clan.py => primary_guild.py} | 16 +++++++-------- discord/types/{clan.py => primary_guild.py} | 2 +- discord/user.py | 22 ++++++++++----------- 4 files changed, 20 insertions(+), 22 deletions(-) rename discord/{clan.py => primary_guild.py} (82%) rename discord/types/{clan.py => primary_guild.py} (96%) diff --git a/discord/asset.py b/discord/asset.py index fbe2ae71f..8cdc00ed9 100644 --- a/discord/asset.py +++ b/discord/asset.py @@ -347,7 +347,7 @@ class Asset(AssetMixin): ) @classmethod - def _from_clan(cls, state: _State, guild_id: int, icon_hash: str) -> Self: + def _from_primary_guild(cls, state: _State, guild_id: int, icon_hash: str) -> Self: return cls( state, url=f'{cls.BASE}/clan-badges/{guild_id}/{icon_hash}.png?size=16', diff --git a/discord/clan.py b/discord/primary_guild.py similarity index 82% rename from discord/clan.py rename to discord/primary_guild.py index 6d0c01f87..6c87efb01 100644 --- a/discord/clan.py +++ b/discord/primary_guild.py @@ -27,13 +27,13 @@ from datetime import datetime from .asset import Asset from .utils import snowflake_time -from .types.clan import Clan as ClanPayload +from .types.primary_guild import PrimaryGuild as PrimaryGuildPayload if TYPE_CHECKING: from .state import ConnectionState -class Clan: +class PrimaryGuild: __slots__ = ( 'guild_id', 'identity_enabled', @@ -49,11 +49,11 @@ class Clan: _badge: str _state: ConnectionState - def __init__(self, *, state, data: ClanPayload) -> None: + def __init__(self, *, state, data: PrimaryGuildPayload) -> None: self._state = state self._update(data) - def _update(self, data: ClanPayload): + def _update(self, data: PrimaryGuildPayload): self.guild_id = data["identity_guild_id"] self.identity_enabled = data['identity_enabled'] self.tag = data['tag'] @@ -61,14 +61,12 @@ class Clan: @property def badge(self) -> Asset: - """:class:`Asset`: Returns the clan's asset""" - return Asset._from_clan(self._state, self.guild_id, self._badge) + """:class:`Asset`: Returns the primary guild's asset""" + return Asset._from_primary_guild(self._state, self.guild_id, self._badge) @property def created_at(self) -> datetime: - """:class:`datetime.datetime`: Returns the clan's guild creation time in UTC. - - This is when the guild, of that clan tag, was created. + """:class:`datetime.datetime`: Returns the primary guild's creation time in UTC. """ return snowflake_time(self.guild_id) diff --git a/discord/types/clan.py b/discord/types/primary_guild.py similarity index 96% rename from discord/types/clan.py rename to discord/types/primary_guild.py index e21e30189..b99f52641 100644 --- a/discord/types/clan.py +++ b/discord/types/primary_guild.py @@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE. from typing import TypedDict -class Clan(TypedDict): +class PrimaryGuild(TypedDict): identity_guild_id: int identity_enabled: bool tag: str diff --git a/discord/user.py b/discord/user.py index 921bdcce6..9dddefeac 100644 --- a/discord/user.py +++ b/discord/user.py @@ -32,7 +32,7 @@ from .colour import Colour from .enums import DefaultAvatar from .flags import PublicUserFlags from .utils import snowflake_time, _bytes_to_base64_data, MISSING, _get_as_snowflake -from .clan import Clan +from .primary_guild import PrimaryGuild if TYPE_CHECKING: from typing_extensions import Self @@ -43,7 +43,7 @@ if TYPE_CHECKING: from .guild import Guild from .message import Message from .state import ConnectionState - from .types.clan import Clan as ClanPayload + from .types.primary_guild import PrimaryGuild as PrimaryGuildPayload from .types.channel import DMChannel as DMChannelPayload from .types.user import PartialUser as PartialUserPayload, User as UserPayload, AvatarDecorationData @@ -73,7 +73,7 @@ class BaseUser(_UserTag): '_public_flags', '_state', '_avatar_decoration_data', - '_clan' + '_primary_guild' ) if TYPE_CHECKING: @@ -89,7 +89,7 @@ class BaseUser(_UserTag): _accent_colour: Optional[int] _public_flags: int _avatar_decoration_data: Optional[AvatarDecorationData] - _clan: Optional[ClanPayload] + _primary_guild: Optional[PrimaryGuildPayload] def __init__(self, *, state: ConnectionState, data: Union[UserPayload, PartialUserPayload]) -> None: self._state = state @@ -127,7 +127,7 @@ class BaseUser(_UserTag): self.bot = data.get('bot', False) self.system = data.get('system', False) self._avatar_decoration_data = data.get('avatar_decoration_data') - self._clan = data.get('clan', None) + self._primary_guild = data.get('primary_guild', None) @classmethod def _copy(cls, user: Self) -> Self: @@ -144,7 +144,7 @@ class BaseUser(_UserTag): self._state = user._state self._public_flags = user._public_flags self._avatar_decoration_data = user._avatar_decoration_data - self._clan = user._clan + self._primary_guild = user._primary_guild return self @@ -312,12 +312,12 @@ class BaseUser(_UserTag): return self.name @property - def clan(self) -> Optional[Clan]: - """:class:`Clan`: Returns the user's clan, if applicable. + def primary_guild(self) -> Optional[PrimaryGuild]: + """:class:`PrimaryGuild`: Returns the user's primary guild, if applicable. - If the user has not set a clan, ``None`` is returned.""" - if self._clan: - return Clan(state=self._state, data=self._clan) + \nIf the user has not set a primary guild, ``None`` is returned.""" + if self._primary_guild: + return PrimaryGuild(state=self._state, data=self._primary_guild) return None def mentioned_in(self, message: Message) -> bool: