fix: Patch TeamMember.permissions deserialization KeyError and use TeamMember.role instead

Co-Authored-By: plun1331 <plun1331@gmail.com>
Co-Authored-By: ffouqueray <flavien.fouqueray@icloud.com>
Co-Authored-By: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lala Sabathil <lala@pycord.dev>

Author: 4 people

CHANGELOG.md

@@ -17,6 +17,9 @@ These changes are available on the `master` branch, but have not yet been releas
 
 ### Changed
 
+- `read_only` team members aren't considered as owners anymore when checking for app
+  ownership permissions.
+
 ### Fixed
 
 - Fixed internal use of deprecated role type methods.
@@ -29,6 +32,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#3189](https://github.com/Pycord-Development/pycord/pull/3189))
 - Fixed incorrect type hints for `MessagePinIterator`.
   ([#3178](https://github.com/Pycord-Development/pycord/pull/3178))
+- Fixed a `KeyError` when fetching an app's information or checking for app ownership
+  with `is_owner`.
 
 ### Deprecated
 

discord/bot.py

@@ -57,7 +57,7 @@
     UserCommand,
     command,
 )
-from .enums import IntegrationType, InteractionContextType, InteractionType
+from .enums import IntegrationType, InteractionContextType, InteractionType, TeamRole
 from .errors import CheckFailure, DiscordException
 from .interactions import Interaction
 from .shard import AutoShardedClient
@@ -1441,7 +1441,8 @@ async def is_owner(self, user: User | Member) -> bool:
         this bot.
 
         If an :attr:`owner_id` is not set, it is fetched automatically
-        through the use of :meth:`~.Bot.application_info`.
+        through the use of :meth:`~.Bot.application_info`, returning
+        the application owner, or all non read-only team members.
 
         .. versionchanged:: 1.3
             The function also checks if the application is team-owned if
@@ -1465,7 +1466,9 @@ async def is_owner(self, user: User | Member) -> bool:
         else:
             app = await self.application_info()  # type: ignore
             if app.team:
-                self.owner_ids = ids = {m.id for m in app.team.members}
+                self.owner_ids = ids = {
+                    m.id for m in app.team.members if m.role is not TeamRole.read_only
+                }
                 return user.id in ids
             else:
                 self.owner_id = owner_id = app.owner.id
@@ -1491,11 +1494,12 @@ class Bot(BotBase, Client):
     owner_id: Optional[:class:`int`]
         The user ID that owns the bot. If this is not set and is then queried via
         :meth:`.is_owner` then it is fetched automatically using
-        :meth:`~.Bot.application_info`.
+        :meth:`~.Bot.application_info`, returning the application owner.
     owner_ids: Optional[Collection[:class:`int`]]
         The user IDs that owns the bot. This is similar to :attr:`owner_id`.
         If this is not set and the application is team based, then it is
-        fetched automatically using :meth:`~.Bot.application_info`.
+        fetched automatically using :meth:`~.Bot.application_info`,
+        returning all non read-only team members.
         For performance reasons it is recommended to use a :class:`set`
         for the collection. You cannot set both ``owner_id`` and ``owner_ids``.
 

discord/enums.py

@@ -45,6 +45,7 @@
     "ActivityType",
     "NotificationLevel",
     "TeamMembershipState",
+    "TeamRole",
     "WebhookType",
     "ExpireBehaviour",
     "ExpireBehavior",
@@ -629,6 +630,15 @@ class TeamMembershipState(Enum):
     accepted = 2
 
 
+class TeamRole(Enum):
+    """Role of a team member."""
+
+    owner = "owner"
+    admin = "admin"
+    developer = "developer"
+    read_only = "read_only"
+
+
 class WebhookType(Enum):
     """Webhook Type"""
 

discord/team.py

@@ -27,9 +27,11 @@
 
 from typing import TYPE_CHECKING
 
+from typing_extensions import deprecated
+
 from . import utils
 from .asset import Asset
-from .enums import TeamMembershipState, try_enum
+from .enums import TeamMembershipState, TeamRole, try_enum
 from .user import BaseUser
 
 if TYPE_CHECKING:
@@ -136,16 +138,22 @@ class TeamMember(BaseUser):
         The team that the member is from.
     membership_state: :class:`TeamMembershipState`
         The membership state of the member (e.g. invited or accepted)
+    role: :class:`TeamRole`
+        The role of the team member (e.g. admin, developer, read_only).
     """
 
-    __slots__ = ("team", "membership_state", "permissions")
+    __slots__ = ("team", "membership_state", "role")
 
     def __init__(self, team: Team, state: ConnectionState, data: TeamMemberPayload):
         self.team: Team = team
         self.membership_state: TeamMembershipState = try_enum(
             TeamMembershipState, data["membership_state"]
         )
-        self.permissions: list[str] = data["permissions"]
+        self.role: TeamRole = (
+            TeamRole.owner
+            if team.owner_id == int(data["user"]["id"])
+            else try_enum(TeamRole, data["role"])
+        )
         super().__init__(state=state, data=data["user"])
 
     def __repr__(self) -> str:
@@ -163,3 +171,10 @@ def __repr__(self) -> str:
             f"<{self.__class__.__name__} id={self.id} name={self.name!r} "
             f"discriminator={self.discriminator!r} membership_state={self.membership_state!r}>"
         )
+
+    @property
+    @deprecated(
+        "TeamMember.permissions is deprecated and will return an empty list. Use TeamMember.role instead."
+    )
+    def permissions(self) -> list[str]:
+        return []

discord/types/team.py

@@ -34,7 +34,7 @@
 class TeamMember(TypedDict):
     user: PartialUser
     membership_state: int
-    permissions: list[str]
+    role: str
     team_id: Snowflake
 
 

docs/api/enums.rst

@@ -2681,3 +2681,24 @@ of :class:`enum.Enum`.
 
     .. attribute:: disabled_by_discord
         The application webhook is disabled by Discord.
+
+.. class:: TeamRole
+    Represents a app team role.
+
+    .. versionadded:: 2.8
+
+    .. attribute:: owner
+
+        Represents the team owner role.
+
+    .. attribute:: admin
+
+        Represents the team admin role.
+
+    .. attribute:: developer
+
+        Represents the team developer role.
+
+    .. attribute:: read_only
+
+        Represents the team read only role.