Skip to content

add support for clan/server tags #10190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions discord/clantag.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
"""
The MIT License (MIT)

Copyright (c) 2015-present Rapptz

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""

from __future__ import annotations
from typing import TypedDict, Optional
from .types.snowflake import Snowflake


class ClanTagPayload(TypedDict):
identity_guild_id: Snowflake
identity_enabled: bool
tag: str
badge: str
Comment on lines +26 to +34
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of this should be on its discord/types file, not here.



class ClanTag:
__slots__ = ("identity_guild_id", "identity_enabled", "tag", "badge")

def __init__(self, data: ClanTagPayload):
self.identity_guild_id: Optional[int] = (int(data["identity_guild_id"]) if data.get("identity_guild_id") is not None else None)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use utils._get_as_snowflake

self.identity_enabled: bool = data.get("identity_enabled", False)
self.tag: Optional[str] = data.get("tag", "null")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will not make this optional, just use data.get

self.badge: Optional[str] = data.get("badge", "null")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as mentioned on self.tag


def __repr__(self) -> str:
return f"<ClanTag tag={self.tag!r} identity_guild_id={self.identity_guild_id}>"
3 changes: 3 additions & 0 deletions discord/types/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from .snowflake import Snowflake
from typing import Literal, Optional, TypedDict
from typing_extensions import NotRequired
from ..clantag import ClanTagPayload
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as mentioned on the TypedDict



class AvatarDecorationData(TypedDict):
Expand All @@ -39,6 +40,8 @@ class PartialUser(TypedDict):
avatar: Optional[str]
global_name: Optional[str]
avatar_decoration_data: NotRequired[AvatarDecorationData]
clan: NotRequired[ClanTagPayload]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clan is deprecated, as dolphies said

primary_guild: NotRequired[ClanTagPayload]


PremiumType = Literal[0, 1, 2, 3]
Expand Down
9 changes: 9 additions & 0 deletions discord/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
from .enums import DefaultAvatar
from .flags import PublicUserFlags
from .utils import snowflake_time, _bytes_to_base64_data, MISSING, _get_as_snowflake
from .clantag import ClanTag


if TYPE_CHECKING:
from typing_extensions import Self
Expand Down Expand Up @@ -71,6 +73,7 @@ class BaseUser(_UserTag):
'_public_flags',
'_state',
'_avatar_decoration_data',
'clan_tag',
)

if TYPE_CHECKING:
Expand All @@ -86,6 +89,7 @@ class BaseUser(_UserTag):
_accent_colour: Optional[int]
_public_flags: int
_avatar_decoration_data: Optional[AvatarDecorationData]
clan_tag: Optional[ClanTag]

def __init__(self, *, state: ConnectionState, data: Union[UserPayload, PartialUserPayload]) -> None:
self._state = state
Expand Down Expand Up @@ -123,6 +127,11 @@ def _update(self, data: Union[UserPayload, PartialUserPayload]) -> None:
self.bot = data.get('bot', False)
self.system = data.get('system', False)
self._avatar_decoration_data = data.get('avatar_decoration_data')

clan_data = data.get("clan") or data.get("primary_guild")
if clan_data:
self.clan_tag: Optional[ClanTag] = ClanTag(clan_data)
Comment on lines +132 to +133
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will raise an attribute error if the clan data is None



@classmethod
def _copy(cls, user: Self) -> Self:
Expand Down
Loading