EG
920 lines
30 KiB
Python
920 lines
30 KiB
Python
"""
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2015-2021 Rapptz
|
|
Copyright (c) 2021-present Pycord Development
|
|
|
|
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 contextlib import suppress
|
|
from typing import TYPE_CHECKING, Any, TypeVar
|
|
|
|
from typing_extensions import Self, deprecated
|
|
|
|
from .asset import Asset
|
|
from .colour import Colour
|
|
from .enums import RoleType
|
|
from .errors import InvalidArgument
|
|
from .flags import RoleFlags
|
|
from .mixins import Hashable
|
|
from .permissions import Permissions
|
|
from .utils import (
|
|
MISSING,
|
|
_bytes_to_base64_data,
|
|
cached_slot_property,
|
|
snowflake_time,
|
|
warn_deprecated,
|
|
)
|
|
|
|
__all__ = ("RoleTags", "Role", "RoleColours")
|
|
|
|
if TYPE_CHECKING:
|
|
import datetime
|
|
|
|
from .guild import Guild
|
|
from .member import Member
|
|
from .state import ConnectionState
|
|
from .types.guild import RolePositionUpdate
|
|
from .types.role import Role as RolePayload
|
|
from .types.role import RoleColours as RoleColoursPayload
|
|
from .types.role import RoleTags as RoleTagPayload
|
|
|
|
|
|
def _parse_tag_bool(data: RoleTagPayload, key: str) -> bool | None:
|
|
"""Parse a boolean from a role tag payload.
|
|
|
|
None is returned if the key is not present.
|
|
True is returned if the key is present and the value is None.
|
|
False is returned for any other cases, but this should allegedly not happen.
|
|
|
|
Parameters
|
|
----------
|
|
data: :class:`RoleTagPayload`
|
|
The role tag payload to parse from.
|
|
key: :class:`str`
|
|
The key to parse from.
|
|
|
|
Returns
|
|
-------
|
|
:class:`bool` | :class:`None`
|
|
The parsed boolean value or None if the key is not present.
|
|
"""
|
|
# if it is False, False is not None -> False
|
|
# if it is None, None is None -> True
|
|
# if the key is not present, None
|
|
return data[key] is None if key in data else None
|
|
|
|
|
|
def _parse_tag_int(data: RoleTagPayload, key: str) -> int | None:
|
|
"""Parse an integer from a role tag payload.
|
|
|
|
An integer is returned if the key is present and the value is an integer string.
|
|
None is returned if the key is not present or the value is not an integer string.
|
|
|
|
Parameters
|
|
----------
|
|
data: :class:`RoleTagPayload`
|
|
The role tag payload to parse from.
|
|
key: :class:`str`
|
|
The key to parse from.
|
|
|
|
Returns
|
|
-------
|
|
:class:`int` | :class:`None`
|
|
The parsed integer value or None if the key is not present or the value is not an integer string.
|
|
"""
|
|
if value := data.get(key):
|
|
with suppress(ValueError):
|
|
# value error means it's not an number string (None or "")
|
|
return int(value) # pyright: ignore[reportUnknownArgumentType]
|
|
return None
|
|
|
|
|
|
class RoleTags:
|
|
"""Represents tags on a role.
|
|
|
|
A role tag is a piece of extra information attached to a managed role
|
|
that gives it context for the reason the role is managed.
|
|
|
|
Role tags are a fairly complex topic, since it's usually hard to determine which role tag combination represents which role type.
|
|
In order to make your life easier, pycord provides a :attr:`RoleTags.type` attribute that attempts to determine the role type based on the role tags. Its value is not provided by Discord but is rather computed based on the role tags.
|
|
If you find an issue, please report it on `GitHub <https://github.com/Pycord-Development/pycord/issues/new?template=bug_report.yml>`_.
|
|
Read `this <https://lulalaby.notion.site/special-roles-role-tags>`_ if you need detailed information about how role tags work.
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
.. versionchanged:: 2.8
|
|
The type of the role is now determined by the :attr:`RoleTags.type` attribute.
|
|
|
|
Attributes
|
|
----------
|
|
bot_id: Optional[:class:`int`]
|
|
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 SKU and listing ID of the role.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
|
|
__slots__ = (
|
|
"integration_id",
|
|
"subscription_listing_id",
|
|
"_premium_subscriber",
|
|
"_available_for_purchase",
|
|
"_guild_connections",
|
|
"_is_guild_product_role",
|
|
"bot_id",
|
|
"_data",
|
|
"_type",
|
|
)
|
|
|
|
_type: RoleType
|
|
|
|
def __init__(self, data: RoleTagPayload):
|
|
self._data: RoleTagPayload = data
|
|
self.integration_id: int | None = _parse_tag_int(data, "integration_id")
|
|
self.subscription_listing_id: int | None = _parse_tag_int(
|
|
data, "subscription_listing_id"
|
|
)
|
|
self.bot_id: int | None = _parse_tag_int(data, "bot_id")
|
|
self._guild_connections: bool | None = _parse_tag_bool(
|
|
data, "guild_connections"
|
|
)
|
|
self._premium_subscriber: bool | None = _parse_tag_bool(
|
|
data, "premium_subscriber"
|
|
)
|
|
self._available_for_purchase: bool | None = _parse_tag_bool(
|
|
data, "available_for_purchase"
|
|
)
|
|
# here discord did things in a normal and logical way for once so we don't have to use _parse_tag_bool
|
|
self._is_guild_product_role: bool | None = data.get("is_guild_product_role")
|
|
|
|
@cached_slot_property("_type")
|
|
def type(self) -> RoleType:
|
|
""":class:`RoleType`: The type of the role.
|
|
|
|
Role tags are a fairly complex topic, since it's usually hard to determine which role tag combination represents which role type.
|
|
In order to make your life easier, pycord provides a :attr:`RoleTags.type` attribute that attempts to determine the role type based on the role tags. Its value is not provided by Discord but is rather computed based on the role tags.
|
|
If you find an issue, please report it on `GitHub <https://github.com/Pycord-Development/pycord/issues/new?template=bug_report.yml>`_.
|
|
Read `this <https://lulalaby.notion.site/special-roles-role-tags>`_ if you need detailed information about how role tags work.
|
|
"""
|
|
# Bot role
|
|
if self.bot_id is not None:
|
|
return RoleType.APPLICATION
|
|
|
|
# Role connection
|
|
if self._guild_connections is True:
|
|
return RoleType.CONNECTION
|
|
|
|
# Paid roles
|
|
if self._is_guild_product_role is True:
|
|
return RoleType.GUILD_PRODUCT
|
|
|
|
# Booster role
|
|
if self._premium_subscriber is True:
|
|
return RoleType.BOOSTER
|
|
|
|
# Subscription roles
|
|
if (
|
|
self.integration_id is not None
|
|
and self._premium_subscriber is None
|
|
and self.subscription_listing_id is not None
|
|
):
|
|
if self._available_for_purchase is True:
|
|
return RoleType.PREMIUM_SUBSCRIPTION_TIER
|
|
return RoleType.DRAFT_PREMIUM_SUBSCRIPTION_TIER
|
|
|
|
# Integration role (Twitch/YouTube)
|
|
if self.integration_id is not None:
|
|
return RoleType.INTEGRATION
|
|
|
|
# Seeing how messed up this is it wouldn't be a surprise if this happened
|
|
return RoleType.UNKNOWN
|
|
|
|
@deprecated(
|
|
"RoleTags.is_bot_managed is deprecated since version 2.8,"
|
|
+ " consider using RoleTags.type == RoleType.APPLICATION instead."
|
|
)
|
|
def is_bot_managed(self) -> bool:
|
|
"""Whether the role is associated with a bot.
|
|
|
|
.. deprecated:: 2.8
|
|
Use ``RoleTags.type == RoleType.APPLICATION`` instead.
|
|
"""
|
|
return self.bot_id is not None
|
|
|
|
@deprecated(
|
|
"RoleTags.is_premium_subscriber is deprecated since version 2.8,"
|
|
+ " consider using RoleTags.type == RoleType.BOOSTER instead."
|
|
)
|
|
def is_premium_subscriber(self) -> bool:
|
|
"""Whether the role is the premium subscriber, AKA "boost", role for the guild.
|
|
|
|
.. deprecated:: 2.8
|
|
Use ``RoleTags.type == RoleType.BOOSTER`` instead.
|
|
"""
|
|
return self._premium_subscriber is True
|
|
|
|
@deprecated(
|
|
"RoleTags.is_integration is deprecated since version 2.8,"
|
|
+ " consider using RoleTags.type in"
|
|
+ " (RoleType.INTEGRATION, RoleType.PREMIUM_SUBSCRIPTION_TIER,"
|
|
+ " RoleType.DRAFT_PREMIUM_SUBSCRIPTION_TIER) instead."
|
|
)
|
|
def is_integration(self) -> bool:
|
|
"""Whether the guild manages the role through some form of
|
|
integrations such as Twitch or through guild subscriptions.
|
|
|
|
.. deprecated:: 2.8
|
|
Use ``RoleTags.type in (RoleType.INTEGRATION,
|
|
RoleType.PREMIUM_SUBSCRIPTION_TIER,
|
|
RoleType.DRAFT_PREMIUM_SUBSCRIPTION_TIER)`` instead.
|
|
"""
|
|
return self.integration_id is not None
|
|
|
|
@deprecated(
|
|
"RoleTags.is_available_for_purchase is deprecated since version 2.8,"
|
|
+ " consider using RoleTags.type == RoleType.PREMIUM_SUBSCRIPTION_TIER instead."
|
|
)
|
|
def is_available_for_purchase(self) -> bool:
|
|
"""Whether the role is available for purchase.
|
|
|
|
Returns ``True`` if the role is available for purchase, and
|
|
``False`` if it is not available for purchase or if the role
|
|
is not linked to a guild subscription.
|
|
|
|
.. deprecated:: 2.8
|
|
Use ``RoleTags.type == RoleType.PREMIUM_SUBSCRIPTION_TIER`` instead.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
return self._available_for_purchase is True
|
|
|
|
@deprecated(
|
|
"RoleTags.is_guild_connections_role is deprecated since version 2.8,"
|
|
+ " consider using RoleTags.type == RoleType.CONNECTION instead."
|
|
)
|
|
def is_guild_connections_role(self) -> bool:
|
|
"""Whether the role is a guild connections role.
|
|
|
|
.. deprecated:: 2.8
|
|
Use ``RoleTags.type == RoleType.CONNECTION`` instead.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
return self._guild_connections is True
|
|
|
|
def __repr__(self) -> str:
|
|
return (
|
|
f"<RoleTags bot_id={self.bot_id} integration_id={self.integration_id} "
|
|
+ f"subscription_listing_id={self.subscription_listing_id} "
|
|
+ f"type={self.type!r}>"
|
|
)
|
|
|
|
|
|
R = TypeVar("R", bound="Role")
|
|
|
|
|
|
class RoleColours:
|
|
"""Represents a role's gradient colours.
|
|
|
|
.. versionadded:: 2.7
|
|
|
|
Attributes
|
|
----------
|
|
primary: :class:`Colour`
|
|
The primary colour of the role.
|
|
secondary: Optional[:class:`Colour`]
|
|
The secondary colour of the role.
|
|
tertiary: Optional[:class:`Colour`]
|
|
The tertiary colour of the role. At the moment, only `16761760` is allowed.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
primary: Colour,
|
|
secondary: Colour | None = None,
|
|
tertiary: Colour | None = None,
|
|
):
|
|
"""Initialises a :class:`RoleColours` object.
|
|
|
|
.. versionadded:: 2.7
|
|
|
|
Parameters
|
|
----------
|
|
primary: :class:`Colour`
|
|
The primary colour of the role.
|
|
secondary: Optional[:class:`Colour`]
|
|
The secondary colour of the role.
|
|
tertiary: Optional[:class:`Colour`]
|
|
The tertiary colour of the role.
|
|
"""
|
|
self.primary: Colour = primary
|
|
self.secondary: Colour | None = secondary
|
|
self.tertiary: Colour | None = tertiary
|
|
|
|
@classmethod
|
|
def _from_payload(cls, data: RoleColoursPayload) -> Self:
|
|
primary = Colour(data["primary_color"])
|
|
secondary = (
|
|
Colour(data["secondary_color"]) if data.get("secondary_color") else None
|
|
)
|
|
tertiary = (
|
|
Colour(data["tertiary_color"]) if data.get("tertiary_color") else None
|
|
)
|
|
return cls(primary, secondary, tertiary)
|
|
|
|
def _to_dict(self) -> RoleColoursPayload:
|
|
"""Converts the role colours to a dictionary."""
|
|
return {
|
|
"primary_color": self.primary.value,
|
|
"secondary_color": self.secondary.value if self.secondary else None,
|
|
"tertiary_color": self.tertiary.value if self.tertiary else None,
|
|
} # type: ignore
|
|
|
|
@classmethod
|
|
def default(cls) -> RoleColours:
|
|
"""Returns a default :class:`RoleColours` object with no colours set."""
|
|
return cls(Colour.default(), None, None)
|
|
|
|
@classmethod
|
|
def holographic(cls) -> RoleColours:
|
|
"""Returns a :class:`RoleColours` that makes the role look holographic.
|
|
|
|
Currently holographic roles are only supported with colours 11127295, 16759788, and 16761760.
|
|
"""
|
|
return cls(Colour(11127295), Colour(16759788), Colour(16761760))
|
|
|
|
@property
|
|
def is_holographic(self) -> bool:
|
|
"""Whether the role is holographic.
|
|
|
|
Currently roles are holographic when colours are set to 11127295, 16759788, and 16761760.
|
|
"""
|
|
return (
|
|
self.primary.value == 11127295
|
|
and self.secondary.value == 16759788
|
|
and self.tertiary.value == 16761760
|
|
)
|
|
|
|
def __repr__(self) -> str:
|
|
return (
|
|
f"<RoleColours primary={self.primary!r} "
|
|
f"secondary={self.secondary!r} "
|
|
f"tertiary={self.tertiary!r}>"
|
|
)
|
|
|
|
|
|
class Role(Hashable):
|
|
"""Represents a Discord role in a :class:`Guild`.
|
|
|
|
.. container:: operations
|
|
|
|
.. describe:: x == y
|
|
|
|
Checks if two roles are equal.
|
|
|
|
.. describe:: x != y
|
|
|
|
Checks if two roles are not equal.
|
|
|
|
.. describe:: x > y
|
|
|
|
Checks if a role is higher than another in the hierarchy.
|
|
|
|
.. describe:: x < y
|
|
|
|
Checks if a role is lower than another in the hierarchy.
|
|
|
|
.. describe:: x >= y
|
|
|
|
Checks if a role is higher or equal to another in the hierarchy.
|
|
|
|
.. describe:: x <= y
|
|
|
|
Checks if a role is lower or equal to another in the hierarchy.
|
|
|
|
.. describe:: hash(x)
|
|
|
|
Return the role's hash.
|
|
|
|
.. describe:: str(x)
|
|
|
|
Returns the role's name.
|
|
|
|
Attributes
|
|
----------
|
|
id: :class:`int`
|
|
The ID for the role.
|
|
name: :class:`str`
|
|
The name of the role.
|
|
guild: :class:`Guild`
|
|
The guild the role belongs to.
|
|
hoist: :class:`bool`
|
|
Indicates if the role will be displayed separately from other members.
|
|
position: :class:`int`
|
|
The position of the role. This number is usually positive. The bottom
|
|
role has a position of 0.
|
|
|
|
.. warning::
|
|
|
|
Multiple roles can have the same position number. As a consequence
|
|
of this, comparing via role position is prone to subtle bugs if
|
|
checking for role hierarchy. The recommended and correct way to
|
|
compare for roles in the hierarchy is using the comparison
|
|
operators on the role objects themselves.
|
|
|
|
managed: :class:`bool`
|
|
Indicates if the role is managed by the guild.
|
|
This is true if any of :meth:`Role.is_integration`, :meth:`Role.is_premium_subscriber`,
|
|
:meth:`Role.is_bot_managed` or :meth:`Role.is_guild_connections_role`
|
|
is ``True``.
|
|
mentionable: :class:`bool`
|
|
Indicates if the role can be mentioned by users.
|
|
tags: Optional[:class:`RoleTags`]
|
|
The role tags associated with this role. Tags indicate whether the role is a special role,
|
|
such as but not limited to a bot role or the booster role.
|
|
unicode_emoji: Optional[:class:`str`]
|
|
The role's unicode emoji.
|
|
Only available to guilds that contain ``ROLE_ICONS`` in :attr:`Guild.features`.
|
|
|
|
.. versionadded:: 2.0
|
|
|
|
flags: :class:`RoleFlags`
|
|
Extra attributes of the role.
|
|
|
|
.. versionadded:: 2.6
|
|
|
|
colours: :class:`RoleColours`
|
|
The role's colours.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
|
|
__slots__ = (
|
|
"id",
|
|
"name",
|
|
"_permissions",
|
|
"_colour",
|
|
"colours",
|
|
"position",
|
|
"managed",
|
|
"mentionable",
|
|
"hoist",
|
|
"guild",
|
|
"tags",
|
|
"unicode_emoji",
|
|
"_icon",
|
|
"_state",
|
|
"flags",
|
|
)
|
|
|
|
def __init__(self, *, guild: Guild, state: ConnectionState, data: RolePayload):
|
|
self.guild: Guild = guild
|
|
self._state: ConnectionState = state
|
|
self.id: int = int(data["id"])
|
|
self._update(data)
|
|
|
|
def __str__(self) -> str:
|
|
return self.name
|
|
|
|
def __repr__(self) -> str:
|
|
return f"<Role id={self.id} name={self.name!r}>"
|
|
|
|
def __lt__(self: R, other: R) -> bool:
|
|
if not isinstance(other, Role) or not isinstance(self, Role):
|
|
return NotImplemented
|
|
|
|
if self.guild != other.guild:
|
|
raise RuntimeError("cannot compare roles from two different guilds.")
|
|
|
|
# the @everyone role is always the lowest role in hierarchy
|
|
guild_id = self.guild.id
|
|
if self.id == guild_id:
|
|
# everyone_role < everyone_role -> False
|
|
return other.id != guild_id
|
|
|
|
if self.position < other.position:
|
|
return True
|
|
|
|
if self.position == other.position:
|
|
return int(self.id) > int(other.id)
|
|
|
|
return False
|
|
|
|
def __le__(self: R, other: R) -> bool:
|
|
r = Role.__lt__(other, self)
|
|
if r is NotImplemented:
|
|
return NotImplemented
|
|
return not r
|
|
|
|
def __gt__(self: R, other: R) -> bool:
|
|
return Role.__lt__(other, self)
|
|
|
|
def __ge__(self: R, other: R) -> bool:
|
|
r = Role.__lt__(self, other)
|
|
if r is NotImplemented:
|
|
return NotImplemented
|
|
return not r
|
|
|
|
def _update(self, data: RolePayload):
|
|
self.name: str = data["name"]
|
|
self._permissions: int = int(data.get("permissions", 0))
|
|
self.position: int = data.get("position", 0)
|
|
self._colour: int = data.get("color", 0)
|
|
self.colours: RoleColours = RoleColours._from_payload(data["colors"])
|
|
self.hoist: bool = data.get("hoist", False)
|
|
self.managed: bool = data.get("managed", False)
|
|
self.mentionable: bool = data.get("mentionable", False)
|
|
self._icon: str | None = data.get("icon")
|
|
self.unicode_emoji: str | None = data.get("unicode_emoji")
|
|
self.flags: RoleFlags = RoleFlags._from_value(data.get("flags", 0))
|
|
self.tags: RoleTags | None
|
|
|
|
try:
|
|
self.tags = RoleTags(data["tags"])
|
|
except KeyError:
|
|
self.tags = None
|
|
|
|
def is_default(self) -> bool:
|
|
"""Checks if the role is the default role."""
|
|
return self.guild.id == self.id
|
|
|
|
@deprecated(
|
|
"Role.is_bot_managed is deprecated since version 2.8, consider using Role.type instead."
|
|
)
|
|
def is_bot_managed(self) -> bool:
|
|
"""Whether the role is associated with a bot.
|
|
|
|
.. deprecated:: 2.8
|
|
Use :attr:`Role.type` instead.
|
|
|
|
.. versionadded:: 1.6
|
|
"""
|
|
return self.type is RoleType.APPLICATION
|
|
|
|
@deprecated(
|
|
"Role.is_premium_subscriber is deprecated since version 2.8, consider using Role.type instead."
|
|
)
|
|
def is_premium_subscriber(self) -> bool:
|
|
"""Whether the role is the premium subscriber, AKA "boost", role for the guild.
|
|
|
|
.. deprecated:: 2.8
|
|
Use :attr:`Role.type` instead.
|
|
|
|
.. versionadded:: 1.6
|
|
"""
|
|
return self.type is RoleType.BOOSTER
|
|
|
|
@deprecated(
|
|
"Role.is_integration is deprecated since version 2.8, consider using Role.type instead."
|
|
)
|
|
def is_integration(self) -> bool:
|
|
"""Whether the guild manages the role through some form of
|
|
integrations such as Twitch or through guild subscriptions.
|
|
|
|
.. deprecated:: 2.8
|
|
Use :attr:`Role.type` instead.
|
|
|
|
.. versionadded:: 1.6
|
|
"""
|
|
return self.type in (
|
|
RoleType.INTEGRATION,
|
|
RoleType.PREMIUM_SUBSCRIPTION_TIER,
|
|
RoleType.DRAFT_PREMIUM_SUBSCRIPTION_TIER,
|
|
)
|
|
|
|
def is_assignable(self) -> bool:
|
|
"""Whether the role is able to be assigned or removed by the bot. This checks whether all of the following conditions are true:
|
|
|
|
- The role is not the guild's :attr:`Guild.default_role`
|
|
|
|
- The role is not managed
|
|
|
|
- The bot has the :attr:`~Permissions.manage_roles` permission
|
|
|
|
- The bot's top role is above this role
|
|
|
|
.. versionadded:: 2.0
|
|
.. versionchanged:: 2.7.1
|
|
Added check for :attr:`~Permissions.manage_roles` permission
|
|
"""
|
|
me = self.guild.me
|
|
return (
|
|
not self.is_default()
|
|
and not self.managed
|
|
and me.guild_permissions.manage_roles
|
|
and me.top_role > self
|
|
)
|
|
|
|
@deprecated(
|
|
"Role.is_available_for_purchase is deprecated since version 2.8, consider using Role.type instead."
|
|
)
|
|
def is_available_for_purchase(self) -> bool:
|
|
"""Whether the role is available for purchase.
|
|
|
|
Returns ``True`` if the role is available for purchase, and
|
|
``False`` if it is not available for purchase or if the
|
|
role is not linked to a guild subscription.
|
|
|
|
.. deprecated:: 2.8
|
|
Use :attr:`Role.type` instead.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
return self.type is RoleType.PREMIUM_SUBSCRIPTION_TIER
|
|
|
|
@deprecated(
|
|
"Role.is_guild_connections_role is deprecated since version 2.8, consider using Role.type instead."
|
|
)
|
|
def is_guild_connections_role(self) -> bool:
|
|
"""Whether the role is a guild connections role.
|
|
|
|
.. deprecated:: 2.8
|
|
Use :attr:`Role.type` instead.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
return self.type is RoleType.CONNECTION
|
|
|
|
@property
|
|
def permissions(self) -> Permissions:
|
|
"""Returns the role's permissions."""
|
|
return Permissions(self._permissions)
|
|
|
|
@property
|
|
@deprecated(
|
|
"Role.colour is deprecated since version 2.7, consider using colours.primary instead."
|
|
)
|
|
def colour(self) -> Colour:
|
|
"""Returns the role colour. Equivalent to :attr:`colours.primary`.
|
|
An alias exists under ``color``.
|
|
|
|
.. versionchanged:: 2.7
|
|
"""
|
|
return self.colours.primary
|
|
|
|
@property
|
|
@deprecated(
|
|
"Role.color is deprecated since version 2.7, consider using colors.primary instead."
|
|
)
|
|
def color(self) -> Colour:
|
|
"""Returns the role's primary color. Equivalent to :attr:`colors.primary`.
|
|
An alias exists under ``colour``.
|
|
|
|
.. versionchanged:: 2.7
|
|
"""
|
|
return self.colours.primary
|
|
|
|
@property
|
|
def colors(self) -> RoleColours:
|
|
"""Returns the role's colours. Equivalent to :attr:`colours`.
|
|
|
|
.. versionadded:: 2.7
|
|
"""
|
|
return self.colours
|
|
|
|
@property
|
|
def created_at(self) -> datetime.datetime:
|
|
"""Returns the role's creation time in UTC."""
|
|
return snowflake_time(self.id)
|
|
|
|
@property
|
|
def mention(self) -> str:
|
|
"""Returns a string that allows you to mention a role."""
|
|
return f"<@&{self.id}>"
|
|
|
|
@property
|
|
def members(self) -> list[Member]:
|
|
"""Returns all the members with this role."""
|
|
all_members = self.guild.members
|
|
if self.is_default():
|
|
return all_members
|
|
|
|
role_id = self.id
|
|
return [member for member in all_members if member._roles.has(role_id)]
|
|
|
|
@property
|
|
def icon(self) -> Asset | None:
|
|
"""Returns the role's icon asset, if available.
|
|
|
|
.. versionadded:: 2.0
|
|
"""
|
|
if self._icon is None:
|
|
return None
|
|
|
|
return Asset._from_icon(self._state, self.id, self._icon, "role")
|
|
|
|
@property
|
|
def type(self) -> RoleType:
|
|
"""The type of the role.
|
|
|
|
This is an alias for :attr:`RoleTags.type`.
|
|
|
|
.. versionadded:: 2.8
|
|
"""
|
|
return self.tags.type if self.tags is not None else RoleType.NORMAL
|
|
|
|
async def _move(self, position: int, reason: str | None) -> None:
|
|
if position <= 0:
|
|
raise InvalidArgument("Cannot move role to position 0 or below")
|
|
|
|
if self.is_default():
|
|
raise InvalidArgument("Cannot move default role")
|
|
|
|
if self.position == position:
|
|
return # Save discord the extra request.
|
|
|
|
http = self._state.http
|
|
|
|
change_range = range(
|
|
min(self.position, position), max(self.position, position) + 1
|
|
)
|
|
roles = [
|
|
r.id
|
|
for r in self.guild.roles[1:]
|
|
if r.position in change_range and r.id != self.id
|
|
]
|
|
|
|
if self.position > position:
|
|
roles.insert(0, self.id)
|
|
else:
|
|
roles.append(self.id)
|
|
|
|
payload: list[RolePositionUpdate] = [
|
|
{"id": z[0], "position": z[1]} for z in zip(roles, change_range)
|
|
]
|
|
await http.move_role_position(self.guild.id, payload, reason=reason)
|
|
|
|
async def edit(
|
|
self,
|
|
*,
|
|
name: str = MISSING,
|
|
permissions: Permissions = MISSING,
|
|
colour: Colour | int = MISSING,
|
|
color: Colour | int = MISSING,
|
|
colours: RoleColours = MISSING,
|
|
colors: RoleColours = MISSING,
|
|
holographic: bool = MISSING,
|
|
hoist: bool = MISSING,
|
|
mentionable: bool = MISSING,
|
|
position: int = MISSING,
|
|
reason: str | None = MISSING,
|
|
icon: bytes | None = MISSING,
|
|
unicode_emoji: str | None = MISSING,
|
|
) -> Role:
|
|
"""|coro|
|
|
|
|
Edits the role.
|
|
|
|
You must have the :attr:`~Permissions.manage_roles` permission to
|
|
use this.
|
|
|
|
All fields are optional.
|
|
|
|
.. versionchanged:: 1.4
|
|
Can now pass ``int`` to ``colour`` keyword-only parameter.
|
|
|
|
.. versionchanged:: 2.0
|
|
Edits are no longer in-place, the newly edited role is returned instead.
|
|
Added ``icon`` and ``unicode_emoji``.
|
|
|
|
Parameters
|
|
----------
|
|
name: :class:`str`
|
|
The new role name to change to.
|
|
permissions: :class:`Permissions`
|
|
The new permissions to change to.
|
|
colour: Union[:class:`Colour`, :class:`int`]
|
|
The new colour to change to. (aliased to color as well)
|
|
hoist: :class:`bool`
|
|
Indicates if the role should be shown separately in the member list.
|
|
mentionable: :class:`bool`
|
|
Indicates if the role should be mentionable by others.
|
|
position: :class:`int`
|
|
The new role's position. This must be below your top role's
|
|
position, or it will fail.
|
|
reason: Optional[:class:`str`]
|
|
The reason for editing this role. Shows up on the audit log.
|
|
icon: Optional[:class:`bytes`]
|
|
A :term:`py:bytes-like object` representing the icon. Only PNG/JPEG/WebP is supported.
|
|
If this argument is passed, ``unicode_emoji`` is set to None.
|
|
Only available to guilds that contain ``ROLE_ICONS`` in :attr:`Guild.features`.
|
|
Could be ``None`` to denote removal of the icon.
|
|
unicode_emoji: Optional[:class:`str`]
|
|
The role's unicode emoji. If this argument is passed, ``icon`` is set to None.
|
|
Only available to guilds that contain ``ROLE_ICONS`` in :attr:`Guild.features`.
|
|
|
|
Returns
|
|
-------
|
|
:class:`Role`
|
|
The newly edited role.
|
|
|
|
Raises
|
|
------
|
|
Forbidden
|
|
You do not have permissions to change the role.
|
|
HTTPException
|
|
Editing the role failed.
|
|
InvalidArgument
|
|
An invalid position was given or the default
|
|
role was asked to be moved.
|
|
"""
|
|
if position is not MISSING:
|
|
await self._move(position, reason=reason)
|
|
|
|
payload: dict[str, Any] = {}
|
|
if color is not MISSING:
|
|
colour = color
|
|
|
|
if colors is not MISSING:
|
|
colours = colors
|
|
|
|
if colour is not MISSING:
|
|
warn_deprecated("colour", "colours", "2.7")
|
|
if isinstance(colour, int):
|
|
colour = Colour(colour)
|
|
colours = RoleColours(primary=colour)
|
|
if holographic:
|
|
colours = RoleColours.holographic()
|
|
if colours is not MISSING:
|
|
if not isinstance(colours, RoleColours):
|
|
raise InvalidArgument("colours must be a RoleColours object")
|
|
if "ENHANCED_ROLE_COLORS" not in self.guild.features:
|
|
colours.secondary = None
|
|
colours.tertiary = None
|
|
|
|
payload["colors"] = colours._to_dict()
|
|
|
|
if name is not MISSING:
|
|
payload["name"] = name
|
|
|
|
if permissions is not MISSING:
|
|
payload["permissions"] = permissions.value
|
|
|
|
if hoist is not MISSING:
|
|
payload["hoist"] = hoist
|
|
|
|
if mentionable is not MISSING:
|
|
payload["mentionable"] = mentionable
|
|
|
|
if icon is not MISSING:
|
|
if icon is None:
|
|
payload["icon"] = None
|
|
else:
|
|
payload["icon"] = _bytes_to_base64_data(icon)
|
|
payload["unicode_emoji"] = None
|
|
|
|
if unicode_emoji is not MISSING:
|
|
payload["unicode_emoji"] = unicode_emoji
|
|
payload["icon"] = None
|
|
|
|
data = await self._state.http.edit_role(
|
|
self.guild.id, self.id, reason=reason, **payload
|
|
)
|
|
return Role(guild=self.guild, data=data, state=self._state)
|
|
|
|
async def delete(self, *, reason: str | None = None) -> None:
|
|
"""|coro|
|
|
|
|
Deletes the role.
|
|
|
|
You must have the :attr:`~Permissions.manage_roles` permission to
|
|
use this.
|
|
|
|
Parameters
|
|
----------
|
|
reason: Optional[:class:`str`]
|
|
The reason for deleting this role. Shows up on the audit log.
|
|
|
|
Raises
|
|
------
|
|
Forbidden
|
|
You do not have permissions to delete the role.
|
|
HTTPException
|
|
Deleting the role failed.
|
|
"""
|
|
|
|
await self._state.http.delete_role(self.guild.id, self.id, reason=reason)
|