feat: implement RoleFlags (#2487)

* implement roleflags

* style(pre-commit): auto fixes from pre-commit.com hooks

* cl

* style(pre-commit): auto fixes from pre-commit.com hooks

* Update discord/flags.py

Signed-off-by: plun1331 <[email protected]>

* Update CHANGELOG.md

Co-authored-by: Dorukyum <[email protected]>
Signed-off-by: UK <[email protected]>

* fix docs

* again?

* better formatting

* flags.py aktualisieren

Signed-off-by: Dorukyum <[email protected]>

* test formatting fix

* resolve conflicts

* revert

---------

Signed-off-by: plun1331 <[email protected]>
Signed-off-by: UK <[email protected]>
Signed-off-by: Dorukyum <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: plun1331 <[email protected]>
Co-authored-by: Dorukyum <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -37,6 +37,7 @@ These changes are available on the `master` branch, but have not yet been releas
 - Added `MemberFlags`. ([#2489](https://github.com/Pycord-Development/pycord/pull/2489))
 - Added `bypass_verification` parameter to `Member.edit`.
   ([#2489](https://github.com/Pycord-Development/pycord/pull/2489))
+- Added `RoleFlags`. ([#2487](https://github.com/Pycord-Development/pycord/pull/2487))
 
 ### Fixed
 

discord/flags.py

@@ -39,6 +39,7 @@
     "ApplicationFlags",
     "ChannelFlags",
     "SKUFlags",
+    "RoleFlags",
     "MemberFlags",
 )
 
@@ -1758,3 +1759,57 @@ def bypasses_verification(self):
     def started_onboarding(self):
         """:class:`bool`: Returns ``True`` if the member has started onboarding."""
         return 1 << 3
+
+
+@fill_with_flags()
+class RoleFlags(BaseFlags):
+    r"""Wraps up the Discord Role flags.
+
+    .. container:: operations
+
+        .. describe:: x == y
+
+            Checks if two RoleFlags are equal.
+        .. describe:: x != y
+
+            Checks if two RoleFlags are not equal.
+        .. describe:: x + y
+
+            Adds two flags together. Equivalent to ``x | y``.
+        .. describe:: x - y
+
+            Subtracts two flags from each other.
+        .. describe:: x | y
+
+            Returns the union of two flags. Equivalent to ``x + y``.
+        .. describe:: x & y
+
+            Returns the intersection of two flags.
+        .. describe:: ~x
+
+            Returns the inverse of a flag.
+        .. describe:: hash(x)
+
+            Return the flag's hash.
+        .. describe:: iter(x)
+
+            Returns an iterator of ``(name, value)`` pairs. This allows it
+            to be, for example, constructed as a dict or a list of pairs.
+            Note that aliases are not shown.
+
+    .. versionadded:: 2.6
+
+    Attributes
+    -----------
+    value: :class:`int`
+        The raw value. This value is a bit array field of a 53-bit integer
+        representing the currently available flags. You should query
+        flags via the properties rather than using this raw value.
+    """
+
+    __slots__ = ()
+
+    @flag_value
+    def in_prompt(self):
+        """:class:`bool`: Returns ``True`` if the role is selectable in one of the guild's :class:`~discord.OnboardingPrompt`."""
+        return 1 << 0

discord/role.py

@@ -30,6 +30,7 @@
 from .asset import Asset
 from .colour import Colour
 from .errors import InvalidArgument
+from .flags import RoleFlags
 from .mixins import Hashable
 from .permissions import Permissions
 from .utils import MISSING, _bytes_to_base64_data, _get_as_snowflake, snowflake_time
@@ -177,6 +178,11 @@ class Role(Hashable):
         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
     """
 
     __slots__ = (
@@ -193,6 +199,7 @@ class Role(Hashable):
         "unicode_emoji",
         "_icon",
         "_state",
+        "flags",
     )
 
     def __init__(self, *, guild: Guild, state: ConnectionState, data: RolePayload):
@@ -253,6 +260,7 @@ def _update(self, data: RolePayload):
         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:

discord/types/role.py

@@ -39,6 +39,7 @@ class Role(TypedDict):
     permissions: str
     managed: bool
     mentionable: bool
+    flags: int
 
 
 class RoleTags(TypedDict, total=False):

docs/api/data_classes.rst

@@ -171,6 +171,11 @@ Flags
 .. autoclass:: MemberFlags()
     :members:
 
+.. attributetable:: RoleFlags
+
+.. autoclass:: RoleFlags()
+    :members:
+
 Colour
 ------