Skip to content

Commit

Permalink
✨ Add new role tags and methods
Browse files Browse the repository at this point in the history
  • Loading branch information
Paillat-dev committed Oct 13, 2024
1 parent 64313a8 commit e593485
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions discord/role.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,32 @@ class RoleTags:
The bot's user ID that manages this role.
integration_id: Optional[:class:`int`]
The integration ID that manages the role.
subscription_listing_id: Optional[:class:`int`]
The subscription listing ID for the role.
.. versionadded:: 2.7
"""

__slots__ = (
"bot_id",
"integration_id",
"subscription_listing_id",
"_premium_subscriber",
"_available_for_purchase",
"_guild_connections"
)

def __init__(self, data: RoleTagPayload):
self.bot_id: int | None = _get_as_snowflake(data, "bot_id")
self.integration_id: int | None = _get_as_snowflake(data, "integration_id")
# NOTE: The API returns "null" for this if it's valid, which corresponds to None.
self.subscription_listing_id: int | None = _get_as_snowflake(data, "subscription_listing_id")
# NOTE: The API returns "null" for this if the following tags True, and doesn't return them at all if False.
# However, "null" corresponds to None.
# This is different from other fields where "null" means "not there".
# So in this case, a value of None is the same as True.
# Which means we would need a different sentinel.
self._premium_subscriber: Any | None = data.get("premium_subscriber", MISSING)
self._available_for_purchase: Any | None = data.get("available_for_purchase", MISSING)
self._guild_connections: Any | None = data.get("guild_connections", MISSING)

def is_bot_managed(self) -> bool:
"""Whether the role is associated with a bot."""
Expand All @@ -97,10 +107,27 @@ def is_integration(self) -> bool:
"""Whether the role is managed by an integration."""
return self.integration_id is not None

def is_available_for_purchase(self) -> bool:
"""Whether the role is available for purchase.
.. versionadded:: 2.7
"""
return self._available_for_purchase is None

def is_guild_connections_role(self) -> bool:
"""Whether the role is a guild connections role.
.. versionadded:: 2.7
"""
return self._guild_connections is None

def __repr__(self) -> str:
return (
f"<RoleTags bot_id={self.bot_id} integration_id={self.integration_id} "
f"premium_subscriber={self.is_premium_subscriber()}>"
f"subscription_listing_id={self.subscription_listing_id} "
f"premium_subscriber={self.is_premium_subscriber()} "
f"available_for_purchase={self.is_available_for_purchase()} "
f"guild_connections={self.is_guild_connections_role()}>"
)


Expand Down Expand Up @@ -305,6 +332,21 @@ def is_assignable(self) -> bool:
and (me.top_role > self or me.id == self.guild.owner_id)
)

def is_available_for_purchase(self) -> bool:
"""Whether the role is available for purchase.
.. versionadded:: 2.7
"""
return self.tags is not None and self.tags.is_available_for_purchase()

def is_guild_connections_role(self) -> bool:
"""Whether the role is a guild connections role.
.. versionadded:: 2.7
"""
return self.tags is not None and self.tags.is_guild_connections_role()


@property
def permissions(self) -> Permissions:
"""Returns the role's permissions."""
Expand Down

0 comments on commit e593485

Please sign in to comment.