Source code for discord.permissions

"""
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 typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterator, TypeVar

from .flags import BaseFlags, alias_flag_value, fill_with_flags, flag_value

__all__ = (
    "Permissions",
    "PermissionOverwrite",
)


# A permission alias works like a regular flag but is marked
# So the PermissionOverwrite knows to work with it
class permission_alias(alias_flag_value):
    alias: str


def make_permission_alias(
    alias: str,
) -> Callable[[Callable[[Any], int]], permission_alias]:
    def decorator(func: Callable[[Any], int]) -> permission_alias:
        ret = permission_alias(func)
        ret.alias = alias
        return ret

    return decorator


P = TypeVar("P", bound="Permissions")


[docs]@fill_with_flags() class Permissions(BaseFlags): """Wraps up the Discord permission value. The properties provided are two way. You can set and retrieve individual bits using the properties as if they were regular bools. This allows you to edit permissions. .. versionchanged:: 1.3 You can now use keyword arguments to initialize :class:`Permissions` similar to :meth:`update`. .. container:: operations .. describe:: x == y Checks if two permissions are equal. .. describe:: x != y Checks if two permissions are not equal. .. describe:: x <= y Checks if a permission is a subset of another permission. .. describe:: x >= y Checks if a permission is a superset of another permission. .. describe:: x < y Checks if a permission is a strict subset of another permission. .. describe:: x > y .. describe:: x + y Adds two permissions together. Equivalent to ``x | y``. .. describe:: x - y Subtracts two permissions from each other. .. describe:: x | y Returns the union of two permissions. Equivalent to ``x + y``. .. describe:: x & y Returns the intersection of two permissions. .. describe:: ~x Returns the inverse of a permission. Checks if a permission is a strict superset of another permission. .. describe:: hash(x) Return the permission's hash. .. describe:: iter(x) Returns an iterator of ``(perm, value)`` pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown. Attributes ---------- value: :class:`int` The raw value. This value is a bit array field of a 53-bit integer representing the currently available permissions. You should query permissions via the properties rather than using this raw value. """ __slots__ = () def __init__(self, permissions: int = 0, **kwargs: bool): if not isinstance(permissions, int): raise TypeError( "Expected int parameter, received" f" {permissions.__class__.__name__} instead." ) self.value = permissions for key, value in kwargs.items(): if key not in self.VALID_FLAGS: raise TypeError(f"{key!r} is not a valid permission name.") setattr(self, key, value)
[docs] def is_subset(self, other: Permissions) -> bool: """Returns ``True`` if self has the same or fewer permissions as other.""" if isinstance(other, Permissions): return (self.value & other.value) == self.value else: raise TypeError( f"cannot compare {self.__class__.__name__} with" f" {other.__class__.__name__}" )
[docs] def is_superset(self, other: Permissions) -> bool: """Returns ``True`` if self has the same or more permissions as other.""" if isinstance(other, Permissions): return (self.value | other.value) == self.value else: raise TypeError( f"cannot compare {self.__class__.__name__} with" f" {other.__class__.__name__}" )
[docs] def is_strict_subset(self, other: Permissions) -> bool: """Returns ``True`` if the permissions on other are a strict subset of those on self.""" return self.is_subset(other) and self != other
[docs] def is_strict_superset(self, other: Permissions) -> bool: """Returns ``True`` if the permissions on other are a strict superset of those on self.""" return self.is_superset(other) and self != other
__le__: Callable[[Permissions], bool] = is_subset __ge__: Callable[[Permissions], bool] = is_superset __lt__: Callable[[Permissions], bool] = is_strict_subset __gt__: Callable[[Permissions], bool] = is_strict_superset
[docs] @classmethod def none(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all permissions set to ``False``. """ return cls(0)
[docs] @classmethod def all(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all permissions set to ``True``. """ return cls(0b11111111111111111111111111111111111111111)
[docs] @classmethod def all_channel(cls: type[P]) -> P: """A :class:`Permissions` with all channel-specific permissions set to ``True`` and the guild-specific ones set to ``False``. The guild-specific permissions are currently: - :attr:`manage_emojis` - :attr:`view_audit_log` - :attr:`view_guild_insights` - :attr:`manage_guild` - :attr:`change_nickname` - :attr:`manage_nicknames` - :attr:`kick_members` - :attr:`ban_members` - :attr:`administrator` .. versionchanged:: 1.7 Added :attr:`stream`, :attr:`priority_speaker` and :attr:`use_slash_commands` permissions. .. versionchanged:: 2.0 Added :attr:`create_public_threads`, :attr:`create_private_threads`, :attr:`manage_threads`, :attr:`use_external_stickers`, :attr:`send_messages_in_threads` and :attr:`request_to_speak` permissions. """ return cls(0b111110110110011111101111111111101010001)
[docs] @classmethod def general(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "General" permissions from the official Discord UI set to ``True``. .. versionchanged:: 1.7 Permission :attr:`read_messages` is now included in the general permissions, but permissions :attr:`administrator`, :attr:`create_instant_invite`, :attr:`kick_members`, :attr:`ban_members`, :attr:`change_nickname` and :attr:`manage_nicknames` are no longer part of the general permissions. """ return cls(0b01110000000010000000010010110000)
[docs] @classmethod def membership(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Membership" permissions from the official Discord UI set to ``True``. .. versionadded:: 1.7 """ return cls(0b00001100000000000000000000000111)
[docs] @classmethod def text(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Text" permissions from the official Discord UI set to ``True``. .. versionchanged:: 1.7 Permission :attr:`read_messages` is no longer part of the text permissions. Added :attr:`use_slash_commands` permission. .. versionchanged:: 2.0 Added :attr:`create_public_threads`, :attr:`create_private_threads`, :attr:`manage_threads`, :attr:`send_messages_in_threads` and :attr:`use_external_stickers` permissions. """ return cls(0b111110010000000000001111111100001000000)
[docs] @classmethod def voice(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Voice" permissions from the official Discord UI set to ``True``. """ return cls(0b00000011111100000000001100000000)
[docs] @classmethod def stage(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Stage Channel" permissions from the official Discord UI set to ``True``. .. versionadded:: 1.7 """ return cls(1 << 32)
[docs] @classmethod def stage_moderator(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Stage Moderator" permissions from the official Discord UI set to ``True``. .. versionadded:: 1.7 """ return cls(0b100000001010000000000000000000000)
[docs] @classmethod def advanced(cls: type[P]) -> P: """A factory method that creates a :class:`Permissions` with all "Advanced" permissions from the official Discord UI set to ``True``. .. versionadded:: 1.7 """ return cls(1 << 3)
[docs] def update(self, **kwargs: bool) -> None: r"""Bulk updates this permission object. Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored. Parameters ------------ \*\*kwargs A list of key/value pairs to bulk update permissions with. """ for key, value in kwargs.items(): if key in self.VALID_FLAGS: setattr(self, key, value)
def handle_overwrite(self, allow: int, deny: int) -> None: # Basically this is what's happening here. # We have an original bit array, e.g. 1010 # Then we have another bit array that is 'denied', e.g. 1111 # And then we have the last one which is 'allowed', e.g. 0101 # We want original OP denied to end up resulting in # whatever is in denied to be set to 0. # So 1010 OP 1111 -> 0000 # Then we take this value and look at the allowed values. # And whatever is allowed is set to 1. # So 0000 OP2 0101 -> 0101 # The OP is base & ~denied. # The OP2 is base | allowed. self.value = (self.value & ~deny) | allow @flag_value def create_instant_invite(self) -> int: """:class:`bool`: Returns ``True`` if the user can create instant invites.""" return 1 << 0 @flag_value def kick_members(self) -> int: """:class:`bool`: Returns ``True`` if the user can kick users from the guild.""" return 1 << 1 @flag_value def ban_members(self) -> int: """:class:`bool`: Returns ``True`` if a user can ban users from the guild.""" return 1 << 2 @flag_value def administrator(self) -> int: """:class:`bool`: Returns ``True`` if a user is an administrator. This role overrides all other permissions. This also bypasses all channel-specific overrides. """ return 1 << 3 @flag_value def manage_channels(self) -> int: """:class:`bool`: Returns ``True`` if a user can edit, delete, or create channels in the guild. This also corresponds to the "Manage Channel" channel-specific override. """ return 1 << 4 @flag_value def manage_guild(self) -> int: """:class:`bool`: Returns ``True`` if a user can edit guild properties.""" return 1 << 5 @flag_value def add_reactions(self) -> int: """:class:`bool`: Returns ``True`` if a user can add reactions to messages.""" return 1 << 6 @flag_value def view_audit_log(self) -> int: """:class:`bool`: Returns ``True`` if a user can view the guild's audit log.""" return 1 << 7 @flag_value def priority_speaker(self) -> int: """:class:`bool`: Returns ``True`` if a user can be more easily heard while talking.""" return 1 << 8 @flag_value def stream(self) -> int: """:class:`bool`: Returns ``True`` if a user can stream in a voice channel.""" return 1 << 9 @flag_value def view_channel(self) -> int: """:class:`bool`: Returns ``True`` if a user can view all or specific channels.""" return 1 << 10
[docs] @make_permission_alias("view_channel") def read_messages(self) -> int: """:class:`bool`: An alias for :attr:`view_channel`. .. versionadded:: 1.3 """ return 1 << 10
@flag_value def send_messages(self) -> int: """:class:`bool`: Returns ``True`` if a user can send messages from all or specific text channels.""" return 1 << 11 @flag_value def send_tts_messages(self) -> int: """:class:`bool`: Returns ``True`` if a user can send TTS messages from all or specific text channels.""" return 1 << 12 @flag_value def manage_messages(self) -> int: """:class:`bool`: Returns ``True`` if a user can delete or pin messages in a text channel. .. note:: Note that there are currently no ways to edit other people's messages. """ return 1 << 13 @flag_value def embed_links(self) -> int: """:class:`bool`: Returns ``True`` if a user's messages will automatically be embedded by Discord.""" return 1 << 14 @flag_value def attach_files(self) -> int: """:class:`bool`: Returns ``True`` if a user can send files in their messages.""" return 1 << 15 @flag_value def read_message_history(self) -> int: """:class:`bool`: Returns ``True`` if a user can read a text channel's previous messages.""" return 1 << 16 @flag_value def mention_everyone(self) -> int: """:class:`bool`: Returns ``True`` if a user's @everyone or @here will mention everyone in the text channel.""" return 1 << 17 @flag_value def external_emojis(self) -> int: """:class:`bool`: Returns ``True`` if a user can use emojis from other guilds.""" return 1 << 18
[docs] @make_permission_alias("external_emojis") def use_external_emojis(self) -> int: """:class:`bool`: An alias for :attr:`external_emojis`. .. versionadded:: 1.3 """ return 1 << 18
@flag_value def view_guild_insights(self) -> int: """:class:`bool`: Returns ``True`` if a user can view the guild's insights. .. versionadded:: 1.3 """ return 1 << 19 @flag_value def connect(self) -> int: """:class:`bool`: Returns ``True`` if a user can connect to a voice channel.""" return 1 << 20 @flag_value def speak(self) -> int: """:class:`bool`: Returns ``True`` if a user can speak in a voice channel.""" return 1 << 21 @flag_value def mute_members(self) -> int: """:class:`bool`: Returns ``True`` if a user can mute other users.""" return 1 << 22 @flag_value def deafen_members(self) -> int: """:class:`bool`: Returns ``True`` if a user can deafen other users.""" return 1 << 23 @flag_value def move_members(self) -> int: """:class:`bool`: Returns ``True`` if a user can move users between other voice channels.""" return 1 << 24 @flag_value def use_voice_activation(self) -> int: """:class:`bool`: Returns ``True`` if a user can use voice activation in voice channels.""" return 1 << 25 @flag_value def change_nickname(self) -> int: """:class:`bool`: Returns ``True`` if a user can change their nickname in the guild.""" return 1 << 26 @flag_value def manage_nicknames(self) -> int: """:class:`bool`: Returns ``True`` if a user can change other user's nickname in the guild.""" return 1 << 27 @flag_value def manage_roles(self) -> int: """:class:`bool`: Returns ``True`` if a user can create or edit roles less than their role's position. This also corresponds to the "Manage Permissions" channel-specific override. """ return 1 << 28
[docs] @make_permission_alias("manage_roles") def manage_permissions(self) -> int: """:class:`bool`: An alias for :attr:`manage_roles`. .. versionadded:: 1.3 """ return 1 << 28
@flag_value def manage_webhooks(self) -> int: """:class:`bool`: Returns ``True`` if a user can create, edit, or delete webhooks.""" return 1 << 29 @flag_value def manage_emojis(self) -> int: """:class:`bool`: Returns ``True`` if a user can create, edit, or delete emojis.""" return 1 << 30
[docs] @make_permission_alias("manage_emojis") def manage_emojis_and_stickers(self) -> int: """:class:`bool`: An alias for :attr:`manage_emojis`. .. versionadded:: 2.0 """ return 1 << 30
@flag_value def use_slash_commands(self) -> int: """:class:`bool`: Returns ``True`` if a user can use slash commands. .. versionadded:: 1.7 """ return 1 << 31
[docs] @make_permission_alias("use_slash_commands") def use_application_commands(self) -> int: """:class:`bool`: An alias for :attr:`use_slash_commands`. .. versionadded:: 2.0 """ return 1 << 31
@flag_value def request_to_speak(self) -> int: """:class:`bool`: Returns ``True`` if a user can request to speak in a stage channel. .. versionadded:: 1.7 """ return 1 << 32 @flag_value def manage_events(self) -> int: """:class:`bool`: Returns ``True`` if a user can manage guild events. .. versionadded:: 2.0 """ return 1 << 33 @flag_value def manage_threads(self) -> int: """:class:`bool`: Returns ``True`` if a user can manage threads. .. versionadded:: 2.0 """ return 1 << 34 @flag_value def create_public_threads(self) -> int: """:class:`bool`: Returns ``True`` if a user can create public threads. .. versionadded:: 2.0 """ return 1 << 35 @flag_value def create_private_threads(self) -> int: """:class:`bool`: Returns ``True`` if a user can create private threads. .. versionadded:: 2.0 """ return 1 << 36 @flag_value def external_stickers(self) -> int: """:class:`bool`: Returns ``True`` if a user can use stickers from other guilds. .. versionadded:: 2.0 """ return 1 << 37
[docs] @make_permission_alias("external_stickers") def use_external_stickers(self) -> int: """:class:`bool`: An alias for :attr:`external_stickers`. .. versionadded:: 2.0 """ return 1 << 37
@flag_value def send_messages_in_threads(self) -> int: """:class:`bool`: Returns ``True`` if a user can send messages in threads. .. versionadded:: 2.0 """ return 1 << 38 @flag_value def start_embedded_activities(self) -> int: """:class:`bool`: Returns ``True`` if a user can launch an activity flagged 'EMBEDDED' in a voice channel. .. versionadded:: 2.0 """ return 1 << 39 @flag_value def moderate_members(self) -> int: """:class:`bool`: Returns ``True`` if a user can moderate members (timeout). .. versionadded:: 2.0 """ return 1 << 40 @flag_value def send_voice_messages(self) -> int: """:class:`bool`: Returns ``True`` if a member can send voice messages. .. versionadded:: 2.5 """ return 1 << 46
PO = TypeVar("PO", bound="PermissionOverwrite") def _augment_from_permissions(cls): cls.VALID_NAMES = set(Permissions.VALID_FLAGS) aliases = set() # make descriptors for all the valid names and aliases for name, value in Permissions.__dict__.items(): if isinstance(value, permission_alias): key = value.alias aliases.add(name) elif isinstance(value, flag_value): key = name else: continue # god bless Python def getter(self, x=key): return self._values.get(x) def setter(self, value, x=key): self._set(x, value) prop = property(getter, setter) setattr(cls, name, prop) cls.PURE_FLAGS = cls.VALID_NAMES - aliases return cls
[docs]@_augment_from_permissions class PermissionOverwrite: r"""A type that is used to represent a channel specific permission. Unlike a regular :class:`Permissions`\, the default value of a permission is equivalent to ``None`` and not ``False``. Setting a value to ``False`` is **explicitly** denying that permission, while setting a value to ``True`` is **explicitly** allowing that permission. The values supported by this are the same as :class:`Permissions` with the added possibility of it being set to ``None``. .. container:: operations .. describe:: x == y Checks if two overwrites are equal. .. describe:: x != y Checks if two overwrites are not equal. .. describe:: iter(x) Returns an iterator of ``(perm, value)`` pairs. This allows it to be, for example, constructed as a dict or a list of pairs. Note that aliases are not shown. Parameters ----------- \*\*kwargs Set the value of permissions by their name. """ __slots__ = ("_values",) if TYPE_CHECKING: VALID_NAMES: ClassVar[set[str]] PURE_FLAGS: ClassVar[set[str]] # I wish I didn't have to do this create_instant_invite: bool | None kick_members: bool | None ban_members: bool | None administrator: bool | None manage_channels: bool | None manage_guild: bool | None add_reactions: bool | None view_audit_log: bool | None priority_speaker: bool | None stream: bool | None read_messages: bool | None view_channel: bool | None send_messages: bool | None send_tts_messages: bool | None manage_messages: bool | None embed_links: bool | None attach_files: bool | None read_message_history: bool | None mention_everyone: bool | None external_emojis: bool | None use_external_emojis: bool | None view_guild_insights: bool | None connect: bool | None speak: bool | None mute_members: bool | None deafen_members: bool | None move_members: bool | None use_voice_activation: bool | None change_nickname: bool | None manage_nicknames: bool | None manage_roles: bool | None manage_permissions: bool | None manage_webhooks: bool | None manage_emojis: bool | None manage_emojis_and_stickers: bool | None use_slash_commands: bool | None request_to_speak: bool | None manage_events: bool | None manage_threads: bool | None create_public_threads: bool | None create_private_threads: bool | None send_messages_in_threads: bool | None external_stickers: bool | None use_external_stickers: bool | None start_embedded_activities: bool | None moderate_members: bool | None send_voice_messages: bool | None def __init__(self, **kwargs: bool | None): self._values: dict[str, bool | None] = {} for key, value in kwargs.items(): if key not in self.VALID_NAMES: raise ValueError(f"no permission called {key}.") setattr(self, key, value) def __eq__(self, other: Any) -> bool: return isinstance(other, PermissionOverwrite) and self._values == other._values def _set(self, key: str, value: bool | None) -> None: if value not in (True, None, False): raise TypeError( f"Expected bool or NoneType, received {value.__class__.__name__}" ) if value is None: self._values.pop(key, None) else: self._values[key] = value
[docs] def pair(self) -> tuple[Permissions, Permissions]: """Returns the (allow, deny) pair from this overwrite.""" allow = Permissions.none() deny = Permissions.none() for key, value in self._values.items(): if value is True: setattr(allow, key, True) elif value is False: setattr(deny, key, True) return allow, deny
[docs] @classmethod def from_pair(cls: type[PO], allow: Permissions, deny: Permissions) -> PO: """Creates an overwrite from an allow/deny pair of :class:`Permissions`.""" ret = cls() for key, value in allow: if value is True: setattr(ret, key, True) for key, value in deny: if value is True: setattr(ret, key, False) return ret
[docs] def is_empty(self) -> bool: """Checks if the permission overwrite is currently empty. An empty permission overwrite is one that has no overwrites set to ``True`` or ``False``. Returns ------- :class:`bool` Indicates if the overwrite is empty. """ return len(self._values) == 0
[docs] def update(self, **kwargs: bool) -> None: r"""Bulk updates this permission overwrite object. Allows you to set multiple attributes by using keyword arguments. The names must be equivalent to the properties listed. Extraneous key/value pairs will be silently ignored. Parameters ------------ \*\*kwargs A list of key/value pairs to bulk update with. """ for key, value in kwargs.items(): if key not in self.VALID_NAMES: continue setattr(self, key, value)
def __iter__(self) -> Iterator[tuple[str, bool | None]]: for key in self.PURE_FLAGS: yield key, self._values.get(key)