mirror
/
Rapptz.discord.py
mirror of https://github.com/Rapptz/discord.py
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4446 Commits
17 Branches
80 Tags
121 MiB
 
Tree: ffe8f53bd9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ffe8f53bd9'
${ noResults }
Rapptz.discord.py/discord/flags.py

2238 lines
69 KiB
Raw Blame History

"""
The MIT License (MIT)
Copyright (c) 2015-present Rapptz
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 functools import reduce
from typing import TYPE_CHECKING, Any, Callable, ClassVar, Dict, Iterator, List, Optional, Tuple, Type, TypeVar, overload
from .enums import UserFlags
if TYPE_CHECKING:
from typing_extensions import Self
__all__ = (
'Capabilities',
'SystemChannelFlags',
'MessageFlags',
'PublicUserFlags',
'PrivateUserFlags',
'MemberCacheFlags',
'ApplicationFlags',
'ChannelFlags',
'PremiumUsageFlags',
'PurchasedFlags',
'PaymentSourceFlags',
'SKUFlags',
'PaymentFlags',
'PromotionFlags',
'GiftFlags',
'LibraryApplicationFlags',
'ApplicationDiscoveryFlags',
'FriendSourceFlags',
'FriendDiscoveryFlags',
'HubProgressFlags',
'OnboardingProgressFlags',
'AutoModPresets',
)
BF = TypeVar('BF', bound='BaseFlags')
class flag_value:
def __init__(self, func: Callable[[Any], int]):
self.flag: int = func(None)
self.__doc__: Optional[str] = func.__doc__
@overload
def __get__(self, instance: None, owner: Type[BF]) -> Self:
...
@overload
def __get__(self, instance: BF, owner: Type[BF]) -> bool:
...
def __get__(self, instance: Optional[BF], owner: Type[BF]) -> Any:
if instance is None:
return self
return instance._has_flag(self.flag)
def __set__(self, instance: BaseFlags, value: bool) -> None:
instance._set_flag(self.flag, value)
def __repr__(self) -> str:
return f'<flag_value flag={self.flag!r}>'
class alias_flag_value(flag_value):
pass
def fill_with_flags(*, inverted: bool = False) -> Callable[[Type[BF]], Type[BF]]:
def decorator(cls: Type[BF]) -> Type[BF]:
# fmt: off
cls.VALID_FLAGS = {
name: value.flag
for name, value in cls.__dict__.items()
if isinstance(value, flag_value)
}
# fmt: on
if inverted:
max_bits = max(cls.VALID_FLAGS.values()).bit_length()
cls.DEFAULT_VALUE = -1 + (2**max_bits)
else:
cls.DEFAULT_VALUE = 0
return cls
return decorator
# Flags must inherit from this and use the decorator above
class BaseFlags:
VALID_FLAGS: ClassVar[Dict[str, int]]
DEFAULT_VALUE: ClassVar[int]
value: int
__slots__ = ('value',)
def __init__(self, **kwargs: bool):
self.value = self.DEFAULT_VALUE
for key, value in kwargs.items():
if key not in self.VALID_FLAGS:
raise TypeError(f'{key!r} is not a valid flag name.')
setattr(self, key, value)
@classmethod
def _from_value(cls, value):
self = cls.__new__(cls)
self.value = value
return self
def __or__(self, other: Self) -> Self:
return self._from_value(self.value | other.value)
def __and__(self, other: Self) -> Self:
return self._from_value(self.value & other.value)
def __xor__(self, other: Self) -> Self:
return self._from_value(self.value ^ other.value)
def __ior__(self, other: Self) -> Self:
self.value |= other.value
return self
def __iand__(self, other: Self) -> Self:
self.value &= other.value
return self
def __ixor__(self, other: Self) -> Self:
self.value ^= other.value
return self
def __invert__(self) -> Self:
max_bits = max(self.VALID_FLAGS.values()).bit_length()
max_value = -1 + (2**max_bits)
return self._from_value(self.value ^ max_value)
def __eq__(self, other: object) -> bool:
return isinstance(other, self.__class__) and self.value == other.value
def __ne__(self, other: object) -> bool:
return not self.__eq__(other)
def __hash__(self) -> int:
return hash(self.value)
def __repr__(self) -> str:
return f'<{self.__class__.__name__} value={self.value}>'
def __iter__(self) -> Iterator[Tuple[str, bool]]:
for name, value in self.__class__.__dict__.items():
if isinstance(value, alias_flag_value):
continue
if isinstance(value, flag_value):
yield (name, self._has_flag(value.flag))
def _has_flag(self, o: int) -> bool:
return (self.value & o) == o
def _set_flag(self, o: int, toggle: bool) -> None:
if toggle is True:
self.value |= o
elif toggle is False:
self.value &= ~o
else:
raise TypeError(f'Value to set for {self.__class__.__name__} must be a bool.')
class ArrayFlags(BaseFlags):
@classmethod
def _from_value(cls: Type[Self], value: List[int]) -> Self:
self = cls.__new__(cls)
self.value = reduce(lambda a, b: a | (1 << b - 1), value, 0)
return self
def to_array(self) -> List[int]:
return [i + 1 for i in range(self.value.bit_length()) if self.value & (1 << i)]
@fill_with_flags()
class Capabilities(BaseFlags):
"""Wraps up the Discord gateway capabilities.
Capabilities are used to determine what gateway features a client support.
This is meant to be used internally by the library.
.. container:: operations
.. describe:: x == y
Checks if two capabilities are equal.
.. describe:: x != y
Checks if two capabilities are not equal.
.. describe:: x | y, x |= y
Returns a capabilities instance with all enabled flags from
both x and y.
.. versionadded:: 2.0
.. describe:: x & y, x &= y
Returns a capabilities instance with only flags enabled on
both x and y.
.. versionadded:: 2.0
.. describe:: x ^ y, x ^= y
Returns a capabilities instance with only flags enabled on
only one of x or y, not on both.
.. versionadded:: 2.0
.. describe:: ~x
Returns a capabilities instance with all flags inverted from x.
.. versionadded:: 2.0
.. describe:: hash(x)
Return the capability'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.
.. versionadded:: 2.0
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__ = ()
# The unfortunate thing about capabilities is that while a lot of these options
# may be useful to the library (i.e. to expose to users for customization),
# we match the official client's values for anti-spam purposes :(
@classmethod
def default(cls: Type[Self]) -> Self:
"""Returns a :class:`Capabilities` with the current value used by the library."""
return cls._from_value(2045)
@flag_value
def lazy_user_notes(self):
""":class:`bool`: Disable preloading of user notes in READY."""
return 1 << 0
@flag_value
def no_affine_user_ids(self):
""":class:`bool`: Disable implicit relationship updates."""
return 1 << 1
@flag_value
def versioned_read_states(self):
""":class:`bool`: Enable versioned read states (change READY ``read_state`` to an object with ``version``/``partial``)."""
return 1 << 2
@flag_value
def versioned_user_guild_settings(self):
""":class:`bool`: Enable versioned user guild settings (change READY ``user_guild_settings`` to an object with ``version``/``partial``)."""
return 1 << 3
@flag_value
def dedupe_user_objects(self):
""":class:`bool`: Enable dehydration of the READY payload (move all user objects to a ``users`` array and replace them in various places in the READY payload with ``user_id`` or ``recipient_id``, move member object(s) from initial guild objects to ``merged_members``)."""
return 1 << 4
@flag_value
def prioritized_ready_payload(self):
""":class:`bool`: Enable prioritized READY payload (enable READY_SUPPLEMENTAL, move ``voice_states`` and ``embedded_activities`` from initial guild objects and ``merged_presences`` from READY, as well as split ``merged_members`` and (sometimes) ``private_channels``/``lazy_private_channels`` between the events)."""
# Requires self.dedupe_user_objects
return 1 << 5 | 1 << 4
@flag_value
def multiple_guild_experiment_populations(self):
""":class:`bool`: Handle multiple guild experiment populations (change the fourth entry of arrays in the ``guild_experiments`` array in READY to have an array of population arrays)."""
return 1 << 6
@flag_value
def non_channel_read_states(self):
""":class:`bool`: Handle non-channel read states (change READY ``read_state`` to include read states tied to server events, server home, and the mobile notification center)."""
return 1 << 7
@flag_value
def auth_token_refresh(self):
""":class:`bool`: Enable auth token refresh (add ``auth_token?`` to READY; this is sent when Discord wants to change the client's token, and was used for the mfa. token migration)."""
return 1 << 8
@flag_value
def user_settings_proto(self):
""":class:`bool`: Disable legacy user settings (remove ``user_settings`` from READY and stop sending USER_SETTINGS_UPDATE)."""
return 1 << 9
@flag_value
def client_state_v2(self):
""":class:`bool`: Enable client caching v2 (move guild properties in guild objects to a ``properties`` subkey and add ``data_mode`` and ``version`` to the objects, as well as change ``client_state`` in IDENTIFY)."""
return 1 << 10
@flag_value
def passive_guild_update(self):
""":class:`bool`: Enable passive guild update (replace ``CHANNEL_UNREADS_UPDATE`` with ``PASSIVE_UPDATE_V1``, a similar event that includes a ``voice_states`` array and a ``members`` array that includes the members of aforementioned voice states)."""
return 1 << 11
@fill_with_flags(inverted=True)
class SystemChannelFlags(BaseFlags):
r"""Wraps up a Discord system channel flag value.
Similar to :class:`Permissions`\, 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 the system flags easily.
To construct an object you can pass keyword arguments denoting the flags
to enable or disable.
.. container:: operations
.. describe:: x == y
Checks if two SystemChannelFlags are equal.
.. describe:: x != y
Checks if two SystemChannelFlags are not equal.
.. describe:: x | y, x |= y
Returns a SystemChannelFlags instance with all enabled flags from
both x and y.
.. versionadded:: 2.0
.. describe:: x & y, x &= y
Returns a SystemChannelFlags instance with only flags enabled on
both x and y.
.. versionadded:: 2.0
.. describe:: x ^ y, x ^= y
Returns a SystemChannelFlags instance with only flags enabled on
only one of x or y, not on both.
.. versionadded:: 2.0
.. describe:: ~x
Returns a SystemChannelFlags instance with all flags inverted from x.
.. versionadded:: 2.0
.. 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.
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__ = ()
# For some reason the flags for system channels are "inverted"
# Ergo, if they're set then it means "suppress" (off in the GUI toggle)
# Since this is counter-intuitive from an API perspective and annoying
# these will be inverted automatically
def _has_flag(self, o: int) -> bool:
return (self.value & o) != o
def _set_flag(self, o: int, toggle: bool) -> None:
if toggle is True:
self.value &= ~o
elif toggle is False:
self.value |= o
else:
raise TypeError('Value to set for SystemChannelFlags must be a bool')
@flag_value
def join_notifications(self):
""":class:`bool`: Returns ``True`` if the system channel is used for member join notifications."""
return 1
@flag_value
def premium_subscriptions(self):
""":class:`bool`: Returns ``True`` if the system channel is used for "Nitro boosting" notifications."""
return 2
@flag_value
def guild_reminder_notifications(self):
""":class:`bool`: Returns ``True`` if the system channel is used for server setup helpful tips notifications.
.. versionadded:: 2.0
"""
return 4
@flag_value
def join_notification_replies(self):
""":class:`bool`: Returns ``True`` if sticker reply button ("Wave to say hi!") is
shown for member join notifications.
.. versionadded:: 2.0
"""
return 8
@fill_with_flags()
class MessageFlags(BaseFlags):
r"""Wraps up a Discord Message flag value.
See :class:`SystemChannelFlags`.
.. container:: operations
.. describe:: x == y
Checks if two MessageFlags are equal.
.. describe:: x != y
Checks if two MessageFlags are not equal.
.. describe:: x | y, x |= y
Returns a MessageFlags instance with all enabled flags from
both x and y.
.. versionadded:: 2.0
.. describe:: x & y, x &= y
Returns a MessageFlags instance with only flags enabled on
both x and y.
.. versionadded:: 2.0
.. describe:: x ^ y, x ^= y
Returns a MessageFlags instance with only flags enabled on
only one of x or y, not on both.
.. versionadded:: 2.0
.. describe:: ~x
Returns a MessageFlags instance with all flags inverted from x.
.. versionadded:: 2.0
.. 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.
.. versionadded:: 1.3
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 crossposted(self):
""":class:`bool`: Returns ``True`` if the message is the original crossposted message."""
return 1
@flag_value
def is_crossposted(self):
""":class:`bool`: Returns ``True`` if the message was crossposted from another channel."""
return 2
@flag_value
def suppress_embeds(self):
""":class:`bool`: Returns ``True`` if the message's embeds have been suppressed."""
return 4
@flag_value
def source_message_deleted(self):
""":class:`bool`: Returns ``True`` if the source message for this crosspost has been deleted."""
return 8
@flag_value
def urgent(self):
""":class:`bool`: Returns ``True`` if the message is an urgent message.
An urgent message is one sent by Discord Trust and Safety.
"""
return 16
@flag_value
def has_thread(self):
""":class:`bool`: Returns ``True`` if the message is associated with a thread.
.. versionadded:: 2.0
"""
return 32
@flag_value
def ephemeral(self):
""":class:`bool`: Returns ``True`` if the message is ephemeral.
.. versionadded:: 2.0
"""
return 64
@flag_value
def loading(self):
""":class:`bool`: Returns ``True`` if the message is an interaction response and the bot
is "thinking".
.. versionadded:: 2.0
"""
return 128
@flag_value
def failed_to_mention_some_roles_in_thread(self):
""":class:`bool`: Returns ``True`` if the message failed to mention some roles in a thread
and add their members to the thread.
.. versionadded:: 2.0
"""
return 256
@fill_with_flags()
class PublicUserFlags(BaseFlags):
r"""Wraps up the Discord User Public flags.
.. container:: operations
.. describe:: x == y
Checks if two PublicUserFlags are equal.
.. describe:: x != y
Checks if two PublicUserFlags are not equal.
.. describe:: x | y, x |= y
Returns a PublicUserFlags instance with all enabled flags from
both x and y.
.. versionadded:: 2.0
.. describe:: x & y, x &= y
Returns a PublicUserFlags instance with only flags enabled on
both x and y.
.. versionadded:: 2.0
.. describe:: x ^ y, x ^= y
Returns a PublicUserFlags instance with only flags enabled on
only one of x or y, not on both.
.. versionadded:: 2.0
.. describe:: ~x
Returns a PublicUserFlags instance with all flags inverted from x.
.. versionadded:: 2.0
.. 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:: 1.4
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 staff(self):
""":class:`bool`: Returns ``True`` if the user is a Discord Employee."""
return UserFlags.staff.value
@flag_value
def partner(self):
""":class:`bool`: Returns ``True`` if the user is a Discord Partner."""
return UserFlags.partner.value
@flag_value
def hypesquad(self):
""":class:`bool`: Returns ``True`` if the user is a HypeSquad Events member."""
return UserFlags.hypesquad.value
@flag_value
def bug_hunter(self):
""":class:`bool`: Returns ``True`` if the user is a level 1 Bug Hunter."""
return UserFlags.bug_hunter.value
@alias_flag_value
def bug_hunter_level_1(self):
""":class:`bool`: An alias for :attr:`bug_hunter`.
.. versionadded:: 2.0
"""
return UserFlags.bug_hunter_level_1.value
@flag_value
def hypesquad_bravery(self):
""":class:`bool`: Returns ``True`` if the user is a HypeSquad Bravery member."""
return UserFlags.hypesquad_bravery.value
@flag_value
def hypesquad_brilliance(self):
""":class:`bool`: Returns ``True`` if the user is a HypeSquad Brilliance member."""
return UserFlags.hypesquad_brilliance.value
@flag_value
def hypesquad_balance(self):
""":class:`bool`: Returns ``True`` if the user is a HypeSquad Balance member."""
return UserFlags.hypesquad_balance.value
@flag_value
def early_supporter(self):
""":class:`bool`: Returns ``True`` if the user is an Early Supporter."""
return UserFlags.early_supporter.value
@flag_value
def team_user(self):
""":class:`bool`: Returns ``True`` if the user is a Team User."""
return UserFlags.team_user.value
@flag_value
def system(self):
""":class:`bool`: Returns ``True`` if the user is a system user (i.e. represents Discord officially)."""
return UserFlags.system.value
@flag_value
def bug_hunter_level_2(self):
""":class:`bool`: Returns ``True`` if the user is a level 2 Bug Hunter"""
return UserFlags.bug_hunter_level_2.value
@flag_value
def verified_bot(self):
""":class:`bool`: Returns ``True`` if the user is a Verified Bot."""
return UserFlags.verified_bot.value
@flag_value
def verified_bot_developer(self):
""":class:`bool`: Returns ``True`` if the user is an Early Verified Bot Developer."""
return UserFlags.verified_bot_developer.value
@alias_flag_value
def early_verified_bot_developer(self):
""":class:`bool`: An alias for :attr:`verified_bot_developer`.
.. versionadded:: 1.5
"""
return UserFlags.verified_bot_developer.value
@flag_value
def discord_certified_moderator(self):
""":class:`bool`: Returns ``True`` if the user is a Discord Certified Moderator.
.. versionadded:: 2.0
"""
return UserFlags.discord_certified_moderator.value
@flag_value
def bot_http_interactions(self):
""":class:`bool`: Returns ``True`` if the user is a bot that only uses HTTP interactions
and is shown in the online member list.
.. versionadded:: 2.0
"""
return UserFlags.bot_http_interactions.value
@flag_value
def spammer(self):
""":class:`bool`: Returns ``True`` if the user is flagged as a spammer by Discord.
.. versionadded:: 2.0
"""
return UserFlags.spammer.value
def all(self) -> List[UserFlags]:
"""List[:class:`UserFlags`]: Returns all flags the user has."""
return [public_flag for public_flag in UserFlags if self._has_flag(public_flag.value)]
@fill_with_flags()
class PrivateUserFlags(PublicUserFlags):
r"""Wraps up the Discord User flags.
.. container:: operations
.. describe:: x == y
Checks if two PrivateUserFlags are equal.
.. describe:: x != y
Checks if two PrivateUserFlags are not equal.
.. describe:: x | y, x |= y
Returns a PrivateUserFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PrivateUserFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PrivateUserFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PrivateUserFlags instance with all flags inverted from x.
.. 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 or inherited flags are not shown.
.. versionadded:: 2.0
.. note::
These are only available on your own user flags.
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 premium_promo_dismissed(self):
""":class:`bool`: Returns ``True`` if the user has dismissed the current premium promotion."""
return UserFlags.premium_promo_dismissed.value
@flag_value
def has_unread_urgent_messages(self):
""":class:`bool`: Returns ``True`` if the user has unread urgent system messages."""
return UserFlags.has_unread_urgent_messages.value
@flag_value
def mfa_sms(self):
""":class:`bool`: Returns ``True`` if the user has SMS recovery for MFA enabled."""
return UserFlags.mfa_sms.value
@flag_value
def underage_deleted(self):
""":class:`bool`: Returns ``True`` if the user has been flagged for deletion for being underage."""
return UserFlags.underage_deleted.value
@flag_value
def partner_or_verification_application(self):
""":class:`bool`: Returns ``True`` if the user has a partner or a verification application."""
return UserFlags.partner_or_verification_application.value
@flag_value
def disable_premium(self):
""":class:`bool`: Returns ``True`` if the user bought premium but has it manually disabled."""
return UserFlags.disable_premium.value
@flag_value
def quarantined(self):
""":class:`bool`: Returns ``True`` if the user is quarantined."""
return UserFlags.quarantined.value
@fill_with_flags()
class PremiumUsageFlags(BaseFlags):
r"""Wraps up the Discord premium usage flags.
.. container:: operations
.. describe:: x == y
Checks if two PremiumUsageFlags are equal.
.. describe:: x != y
Checks if two PremiumUsageFlags are not equal.
.. describe:: x | y, x |= y
Returns a PremiumUsageFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PremiumUsageFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PremiumUsageFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PremiumUsageFlags instance with all flags inverted from x.
.. 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.0
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 premium_discriminator(self):
""":class:`bool`: Returns ``True`` if the user has utilized premium discriminators."""
return 1 << 0
@flag_value
def animated_avatar(self):
""":class:`bool`: Returns ``True`` if the user has utilized animated avatars."""
return 1 << 1
@flag_value
def profile_banner(self):
""":class:`bool`: Returns ``True`` if the user has utilized profile banners."""
return 1 << 2
@fill_with_flags()
class PurchasedFlags(BaseFlags):
r"""Wraps up the Discord purchased flags.
.. container:: operations
.. describe:: x == y
Checks if two PurchasedFlags are equal.
.. describe:: x != y
Checks if two PurchasedFlags are not equal.
.. describe:: x | y, x |= y
Returns a PurchasedFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PurchasedFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PurchasedFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PurchasedFlags instance with all flags inverted from x.
.. 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.0
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 nitro_classic(self):
""":class:`bool`: Returns ``True`` if the user has purchased Nitro classic."""
return 1 << 0
@flag_value
def nitro(self):
""":class:`bool`: Returns ``True`` if the user has purchased Nitro."""
return 1 << 1
@flag_value
def guild_boost(self):
""":class:`bool`: Returns ``True`` if the user has purchased a guild boost."""
return 1 << 2
@flag_value
def nitro_basic(self):
""":class:`bool`: Returns ``True`` if the user has purchased Nitro basic."""
return 1 << 3
@fill_with_flags()
class MemberCacheFlags(BaseFlags):
"""Controls the library's cache policy when it comes to members.
This allows for finer grained control over what members are cached.
Note that the bot's own member is always cached. This class is passed
to the ``member_cache_flags`` parameter in :class:`Client`.
To construct an object you can pass keyword arguments denoting the flags
to enable or disable.
The default value is all flags enabled.
.. versionadded:: 1.5
.. container:: operations
.. describe:: x == y
Checks if two flags are equal.
.. describe:: x != y
Checks if two flags are not equal.
.. describe:: x | y, x |= y
Returns a MemberCacheFlags instance with all enabled flags from
both x and y.
.. versionadded:: 2.0
.. describe:: x & y, x &= y
Returns a MemberCacheFlags instance with only flags enabled on
both x and y.
.. versionadded:: 2.0
.. describe:: x ^ y, x ^= y
Returns a MemberCacheFlags instance with only flags enabled on
only one of x or y, not on both.
.. versionadded:: 2.0
.. describe:: ~x
Returns a MemberCacheFlags instance with all flags inverted from x.
.. versionadded:: 2.0
.. 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.
Attributes
-----------
value: :class:`int`
The raw value. You should query flags via the properties
rather than using this raw value.
"""
__slots__ = ()
def __init__(self, **kwargs: bool):
bits = max(self.VALID_FLAGS.values()).bit_length()
self.value: int = (1 << bits) - 1
for key, value in kwargs.items():
if key not in self.VALID_FLAGS:
raise TypeError(f'{key!r} is not a valid flag name.')
setattr(self, key, value)
@classmethod
def all(cls: Type[MemberCacheFlags]) -> MemberCacheFlags:
"""A factory method that creates a :class:`MemberCacheFlags` with everything enabled."""
bits = max(cls.VALID_FLAGS.values()).bit_length()
value = (1 << bits) - 1
self = cls.__new__(cls)
self.value = value
return self
@classmethod
def none(cls: Type[MemberCacheFlags]) -> MemberCacheFlags:
"""A factory method that creates a :class:`MemberCacheFlags` with everything disabled."""
self = cls.__new__(cls)
self.value = self.DEFAULT_VALUE
return self
@property
def _empty(self):
return self.value == self.DEFAULT_VALUE
@flag_value
def voice(self):
""":class:`bool`: Whether to cache members that are in voice.
Members that leave voice are no longer cached.
"""
return 1
@flag_value
def other(self):
""":class:`bool`: Whether to cache members that are collected from other means.
This does not apply to members explicitly cached (e.g. :attr:`Guild.chunk`, :attr:`Guild.fetch_members`).
There is an alias for this called :attr:`joined`.
"""
return 2
@alias_flag_value
def joined(self):
""":class:`bool`: Whether to cache members that are collected from other means.
This does not apply to members explicitly cached (e.g. :attr:`Guild.chunk`, :attr:`Guild.fetch_members`).
This is an alias for :attr:`other`.
"""
return 2
@property
def _voice_only(self):
return self.value == 1
@fill_with_flags()
class ApplicationFlags(BaseFlags):
r"""Wraps up the Discord Application flags.
.. container:: operations
.. describe:: x == y
Checks if two ApplicationFlags are equal.
.. describe:: x != y
Checks if two ApplicationFlags are not equal.
.. describe:: x | y, x |= y
Returns an ApplicationFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns an ApplicationFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns an ApplicationFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns an ApplicationFlags instance with all flags inverted from x.
.. 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.0
Attributes
-----------
value: :class:`int`
The raw value. You should query flags via the properties
rather than using this raw value.
"""
__slots__ = ()
@flag_value
def embedded_released(self):
""":class:`bool`: Returns ``True`` if the embedded application is released to the public."""
return 1 << 1
@flag_value
def managed_emoji(self):
""":class:`bool`: Returns ``True`` if the application has the ability to create Twitch-style emotes."""
return 1 << 2
@flag_value
def embedded_iap(self):
""":class:`bool`: Returns ``True`` if the application has the ability to use embedded in-app purchases."""
return 1 << 3
@flag_value
def group_dm_create(self):
""":class:`bool`: Returns ``True`` if the application has the ability to create group DMs."""
return 1 << 4
@flag_value
def rpc_private_beta(self):
""":class:`bool`: Returns ``True`` if the application has the ability to access the client RPC server."""
return 1 << 5
@flag_value
def allow_assets(self):
""":class:`bool`: Returns ``True`` if the application has the ability to use activity assets."""
return 1 << 8
@flag_value
def allow_activity_action_spectate(self):
""":class:`bool`: Returns ``True`` if the application has the ability to enable spectating activities."""
return 1 << 9
@flag_value
def allow_activity_action_join_request(self):
""":class:`bool`: Returns ``True`` if the application has the ability to enable activity join requests."""
return 1 << 10
@flag_value
def rpc_has_connected(self):
""":class:`bool`: Returns ``True`` if the application has accessed the client RPC server before."""
return 1 << 11
@flag_value
def gateway_presence(self):
""":class:`bool`: Returns ``True`` if the application is verified and is allowed to
receive presence information over the gateway.
"""
return 1 << 12
@flag_value
def gateway_presence_limited(self):
""":class:`bool`: Returns ``True`` if the application is allowed to receive
presence information over the gateway.
"""
return 1 << 13
@flag_value
def gateway_guild_members(self):
""":class:`bool`: Returns ``True`` if the application is verified and is allowed to
receive full guild member lists.
"""
return 1 << 14
@flag_value
def gateway_guild_members_limited(self):
""":class:`bool`: Returns ``True`` if the application is allowed to receive full
guild member lists.
"""
return 1 << 15
@flag_value
def verification_pending_guild_limit(self):
""":class:`bool`: Returns ``True`` if the application is currently pending verification
and has hit the guild limit.
"""
return 1 << 16
@flag_value
def embedded(self):
""":class:`bool`: Returns ``True`` if the application is embedded within the Discord client."""
return 1 << 17
@flag_value
def gateway_message_content(self):
""":class:`bool`: Returns ``True`` if the application is verified and is allowed to
receive message content."""
return 1 << 18
@flag_value
def gateway_message_content_limited(self):
""":class:`bool`: Returns ``True`` if the application is allowed to
read message content in guilds."""
return 1 << 19
@flag_value
def embedded_first_party(self):
""":class:`bool`: Returns ``True`` if the embedded application is published by Discord."""
return 1 << 20
@flag_value
def application_command_badge(self):
""":class:`bool`: Returns ``True`` if the application has registered global application commands."""
return 1 << 23
@flag_value
def active(self):
""":class:`bool`: Returns ``True`` if the application is considered active.
This means that it has had any global command executed in the past 30 days.
"""
return 1 << 24
@fill_with_flags()
class ChannelFlags(BaseFlags):
r"""Wraps up the Discord :class:`~discord.abc.GuildChannel` or :class:`Thread` flags.
.. container:: operations
.. describe:: x == y
Checks if two ChannelFlags are equal.
.. describe:: x | y, x |= y
Returns a ChannelFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a ChannelFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a ChannelFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a ChannelFlags instance with all flags inverted from x.
.. 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.0
Attributes
-----------
value: :class:`int`
The raw value. You should query flags via the properties
rather than using this raw value.
"""
__slots__ = ()
@flag_value
def pinned(self):
""":class:`bool`: Returns ``True`` if the thread is pinned to the forum channel."""
return 1 << 1
@fill_with_flags()
class PaymentSourceFlags(BaseFlags):
r"""Wraps up the Discord payment source flags.
.. container:: operations
.. describe:: x == y
Checks if two PaymentSourceFlags are equal.
.. describe:: x != y
Checks if two PaymentSourceFlags are not equal.
.. describe:: x | y, x |= y
Returns a PaymentSourceFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PaymentSourceFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PaymentSourceFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PaymentSourceFlags instance with all flags inverted from x.
.. 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.0
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 new(self):
""":class:`bool`: Returns ``True`` if the payment source is new."""
return 1 << 0
@flag_value
def unknown(self):
return 1 << 1
@fill_with_flags()
class SKUFlags(BaseFlags):
r"""Wraps up the Discord SKU flags.
.. container:: operations
.. describe:: x == y
Checks if two SKUFlags are equal.
.. describe:: x != y
Checks if two SKUFlags are not equal.
.. describe:: x | y, x |= y
Returns a SKUFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a SKUFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a SKUFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a SKUFlags instance with all flags inverted from x.
.. 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.0
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 premium_purchase(self):
""":class:`bool`: Returns ``True`` if the SKU is a premium purchase."""
return 1 << 0
@flag_value
def free_premium_content(self):
""":class:`bool`: Returns ``True`` if the SKU is free premium content."""
return 1 << 1
@flag_value
def available(self):
""":class:`bool`: Returns ``True`` if the SKU is available for purchase."""
return 1 << 2
@flag_value
def premium_and_distribution(self):
""":class:`bool`: Returns ``True`` if the SKU is a premium or distribution product."""
return 1 << 3
@flag_value
def sticker_pack(self):
""":class:`bool`: Returns ``True`` if the SKU is a premium sticker pack."""
return 1 << 4
@flag_value
def guild_role_subscription(self):
""":class:`bool`: Returns ``True`` if the SKU is a guild role subscription. These are subscriptions made to guilds for premium perks."""
return 1 << 5
@flag_value
def premium_subscription(self):
""":class:`bool`: Returns ``True`` if the SKU is a Discord premium subscription or related first-party product.
These are subscriptions like Nitro and Server Boosts. These are the only giftable subscriptions.
"""
return 1 << 6
@flag_value
def application_guild_subscription(self):
""":class:`bool`: Returns ``True`` if the SKU is a application subscription. These are subscriptions made to applications for premium perks bound to a guild."""
return 1 << 7
@flag_value
def application_user_subscription(self):
""":class:`bool`: Returns ``True`` if the SKU is a application subscription. These are subscriptions made to applications for premium perks bound to a user."""
return 1 << 8
@fill_with_flags()
class PaymentFlags(BaseFlags):
r"""Wraps up the Discord payment flags.
.. container:: operations
.. describe:: x == y
Checks if two PaymentFlags are equal.
.. describe:: x != y
Checks if two PaymentFlags are not equal.
.. describe:: x | y, x |= y
Returns a PaymentFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PaymentFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PaymentFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PaymentFlags instance with all flags inverted from x.
.. 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.0
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 gift(self):
""":class:`bool`: Returns ``True`` if the payment is for a gift."""
return 1 << 0
@flag_value
def preorder(self):
""":class:`bool`: Returns ``True`` if the payment is a preorder."""
return 1 << 3
# TODO: The below are assumptions
@flag_value
def temporary_authorization(self):
""":class:`bool`: Returns ``True`` if the payment is a temporary authorization."""
return 1 << 5
@flag_value
def unknown(self):
return 1 << 6
@fill_with_flags()
class PromotionFlags(BaseFlags):
r"""Wraps up the Discord promotion flags.
.. container:: operations
.. describe:: x == y
Checks if two PromotionFlags are equal.
.. describe:: x != y
Checks if two PromotionFlags are not equal.
.. describe:: x | y, x |= y
Returns a PromotionFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a PromotionFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a PromotionFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a PromotionFlags instance with all flags inverted from x.
.. 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.0
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 unknown_0(self):
return 1 << 0
@flag_value
def unknown_1(self):
# Possibly one month duration?
return 1 << 1
@flag_value
def unknown_2(self):
return 1 << 2
@flag_value
def unknown_3(self):
return 1 << 3
@flag_value
def unknown_4(self):
# Possibly unavailable/ended/inactive
# Maybe also direct link
# Maybe also available for existing users
return 1 << 4
@flag_value
def blocked_ios(self):
""":class:`bool`: Returns ``True`` if the promotion is blocked on iOS."""
return 1 << 5
@flag_value
def outbound_redeemable_by_trial_users(self):
""":class:`bool`: Returns ``True`` if the promotion is redeemable by trial users."""
return 1 << 6
@fill_with_flags()
class GiftFlags(BaseFlags):
r"""Wraps up the Discord payment flags.
.. container:: operations
.. describe:: x == y
Checks if two GiftFlags are equal.
.. describe:: x != y
Checks if two GiftFlags are not equal.
.. describe:: x | y, x |= y
Returns a GiftFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a GiftFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a GiftFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a GiftFlags instance with all flags inverted from x.
.. 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.0
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 payment_source_required(self):
""":class:`bool`: Returns ``True`` if the gift requires a payment source to redeem."""
return 1 << 0
@flag_value
def existing_subscription_disallowed(self):
""":class:`bool`: Returns ``True`` if the gift cannot be redeemed by users with existing premium subscriptions."""
return 1 << 1
@flag_value
def not_self_redeemable(self):
""":class:`bool`: Returns ``True`` if the gift cannot be redeemed by the gifter."""
return 1 << 2
# TODO: The below are assumptions
@flag_value
def promotion(self):
""":class:`bool`: Returns ``True`` if the gift is from a promotion."""
return 1 << 3
@fill_with_flags()
class LibraryApplicationFlags(BaseFlags):
r"""Wraps up the Discord library application flags.
.. container:: operations
.. describe:: x == y
Checks if two LibraryApplicationFlags are equal.
.. describe:: x != y
Checks if two LibraryApplicationFlags are not equal.
.. describe:: x | y, x |= y
Returns a LibraryApplicationFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a LibraryApplicationFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a LibraryApplicationFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a LibraryApplicationFlags instance with all flags inverted from x.
.. 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.0
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 hidden(self):
""":class:`bool`: Returns ``True`` if the library application is hidden."""
return 1 << 0
@flag_value
def private(self):
""":class:`bool`: Returns ``True`` if the library application is not shown in playing status."""
return 1 << 1
@flag_value
def overlay_disabled(self):
""":class:`bool`: Returns ``True`` if the library application has the Discord overlay disabled."""
return 1 << 2
@flag_value
def entitled(self):
""":class:`bool`: Returns ``True`` if the library application is entitled to the user."""
return 1 << 3
@flag_value
def premium(self):
""":class:`bool`: Returns ``True`` if the library application is free for premium users."""
return 1 << 4
@fill_with_flags()
class ApplicationDiscoveryFlags(BaseFlags):
r"""Wraps up the Discord application discovery eligibility flags.
.. container:: operations
.. describe:: x == y
Checks if two LibraryApplicationFlags are equal.
.. describe:: x != y
Checks if two LibraryApplicationFlags are not equal.
.. describe:: x | y, x |= y
Returns a LibraryApplicationFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a LibraryApplicationFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a LibraryApplicationFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a LibraryApplicationFlags instance with all flags inverted from x.
.. 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.0
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 verified(self):
""":class:`bool`: Returns ``True`` if the application is verified."""
return 1 << 0
@flag_value
def tag(self):
""":class:`bool`: Returns ``True`` if the application has at least one tag set."""
return 1 << 1
@flag_value
def description(self):
""":class:`bool`: Returns ``True`` if the application has a description."""
return 1 << 2
@flag_value
def terms_of_service(self):
""":class:`bool`: Returns ``True`` if the application has a terms of service."""
return 1 << 3
@flag_value
def privacy_policy(self):
""":class:`bool`: Returns ``True`` if the application has a privacy policy."""
return 1 << 4
@flag_value
def install_params(self):
""":class:`bool`: Returns ``True`` if the application has a custom install URL or install parameters."""
return 1 << 5
@flag_value
def safe_name(self):
""":class:`bool`: Returns ``True`` if the application name is safe for work."""
return 1 << 6
@flag_value
def safe_description(self):
""":class:`bool`: Returns ``True`` if the application description is safe for work."""
return 1 << 7
@flag_value
def approved_commands(self):
""":class:`bool`: Returns ``True`` if the application has the message content intent approved or utilizes application commands."""
return 1 << 8
@flag_value
def support_guild(self):
""":class:`bool`: Returns ``True`` if the application has a support guild set."""
return 1 << 9
@flag_value
def safe_commands(self):
""":class:`bool`: Returns ``True`` if the application's commands are safe for work."""
return 1 << 10
@flag_value
def mfa(self):
""":class:`bool`: Returns ``True`` if the application's owner has MFA enabled."""
return 1 << 11
@flag_value
def safe_directory_overview(self):
""":class:`bool`: Returns ``True`` if the application's directory long description is safe for work."""
return 1 << 12
@flag_value
def supported_locales(self):
""":class:`bool`: Returns ``True`` if the application has at least one supported locale set."""
return 1 << 13
@flag_value
def safe_short_description(self):
""":class:`bool`: Returns ``True`` if the application's directory short description is safe for work."""
return 1 << 14
@flag_value
def safe_role_connections(self):
""":class:`bool`: Returns ``True`` if the application's role connections metadata is safe for work."""
return 1 << 15
@flag_value
def eligible(self):
""":class:`bool`: Returns ``True`` if the application has met all the above criteria and is eligible for discovery."""
return 1 << 16
class FriendSourceFlags(BaseFlags):
r"""Wraps up the Discord friend source flags.
These are used in user settings to control who can add you as a friend.
.. container:: operations
.. describe:: x == y
Checks if two FriendSourceFlags are equal.
.. describe:: x != y
Checks if two FriendSourceFlags are not equal.
.. describe:: x | y, x |= y
Returns a FriendSourceFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a FriendSourceFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a FriendSourceFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a FriendSourceFlags instance with all flags inverted from x.
.. 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.0
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__ = ()
@classmethod
def _from_dict(cls, data: dict) -> Self:
self = cls()
if data.get('mutual_friends'):
self.mutual_friends = True
if data.get('mutual_guilds'):
self.mutual_guilds = True
if data.get('all'):
self.no_relation = True
return self
def _to_dict(self) -> dict:
return {
'mutual_friends': self.mutual_friends,
'mutual_guilds': self.mutual_guilds,
'all': self.no_relation,
}
@classmethod
def none(cls) -> Self:
"""A factory method that creates a :class:`FriendSourceFlags` that allows no friend request."""
return cls()
@classmethod
def all(cls) -> Self:
"""A factory method that creates a :class:`FriendSourceFlags` that allows any friend requests."""
self = cls()
self.no_relation = True
return self
@flag_value
def mutual_friends(self):
""":class:`bool`: Returns ``True`` if a user can add you as a friend if you have mutual friends."""
return 1 << 1
@flag_value
def mutual_guilds(self):
""":class:`bool`: Returns ``True`` if a user can add you as a friend if you are in the same guild."""
return 1 << 2
@flag_value
def no_relation(self):
""":class:`bool`: Returns ``True`` if a user can always add you as a friend."""
# Requires all of the above
return 1 << 3 | 1 << 2 | 1 << 1
@fill_with_flags()
class FriendDiscoveryFlags(BaseFlags):
r"""Wraps up the Discord friend discovery flags.
These are used in user settings to control how you get recommended friends.
.. container:: operations
.. describe:: x == y
Checks if two FriendDiscoveryFlags are equal.
.. describe:: x != y
Checks if two FriendDiscoveryFlags are not equal.
.. describe:: x | y, x |= y
Returns a FriendDiscoveryFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a FriendDiscoveryFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a FriendDiscoveryFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a FriendDiscoveryFlags instance with all flags inverted from x.
.. 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.0
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__ = ()
@classmethod
def none(cls) -> Self:
"""A factory method that creates a :class:`FriendDiscoveryFlags` that allows no friend discovery."""
return cls()
@classmethod
def all(cls) -> Self:
"""A factory method that creates a :class:`FriendDiscoveryFlags` that allows all friend discovery."""
self = cls()
self.find_by_email = True
self.find_by_phone = True
return self
@flag_value
def find_by_phone(self):
""":class:`bool`: Returns ``True`` if a user can add you as a friend if they have your phone number."""
return 1 << 1
@flag_value
def find_by_email(self):
""":class:`bool`: Returns ``True`` if a user can add you as a friend if they have your email address."""
return 1 << 2
@fill_with_flags()
class HubProgressFlags(BaseFlags):
"""Wraps up the Discord hub progress flags.
These are used in user settings, specifically guild progress, to track engagement and feature usage in hubs.
.. container:: operations
.. describe:: x == y
Checks if two HubProgressFlags are equal.
.. describe:: x != y
Checks if two HubProgressFlags are not equal.
.. describe:: x | y, x |= y
Returns a HubProgressFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a HubProgressFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a HubProgressFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a HubProgressFlags instance with all flags inverted from x.
.. 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.0
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 join_guild(self):
""":class:`bool`: Returns ``True`` if the user has joined a guild in the hub."""
return 1 << 0
@flag_value
def invite_user(self):
""":class:`bool`: Returns ``True`` if the user has sent an invite for the hub."""
return 1 << 1
@flag_value
def contact_sync(self):
""":class:`bool`: Returns ``True`` if the user has accepted the contact sync modal."""
return 1 << 2
@fill_with_flags()
class OnboardingProgressFlags(BaseFlags):
"""Wraps up the Discord guild onboarding progress flags.
These are used in user settings, specifically guild progress, to track engagement and feature usage in guild onboarding.
.. container:: operations
.. describe:: x == y
Checks if two OnboardingProgressFlags are equal.
.. describe:: x != y
Checks if two OnboardingProgressFlags are not equal.
.. describe:: x | y, x |= y
Returns a OnboardingProgressFlags instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns a OnboardingProgressFlags instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns a OnboardingProgressFlags instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns a OnboardingProgressFlags instance with all flags inverted from x.
.. 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.0
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 notice_shown(self):
""":class:`bool`: Returns ``True`` if the user has been shown the onboarding notice."""
return 1 << 0
@flag_value
def notice_cleared(self):
""":class:`bool`: Returns ``True`` if the user has cleared the onboarding notice."""
return 1 << 1
@fill_with_flags()
class AutoModPresets(ArrayFlags):
r"""Wraps up the Discord :class:`AutoModRule` presets.
.. container:: operations
.. describe:: x == y
Checks if two AutoModPresets flags are equal.
.. describe:: x != y
Checks if two AutoModPresets flags are not equal.
.. describe:: x | y, x |= y
Returns an AutoModPresets instance with all enabled flags from
both x and y.
.. describe:: x & y, x &= y
Returns an AutoModPresets instance with only flags enabled on
both x and y.
.. describe:: x ^ y, x ^= y
Returns an AutoModPresets instance with only flags enabled on
only one of x or y, not on both.
.. describe:: ~x
Returns an AutoModPresets instance with all flags inverted from x.
.. 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.
.. versionadded:: 2.0
Attributes
-----------
value: :class:`int`
The raw value. You should query flags via the properties
rather than using this raw value.
"""
@classmethod
def all(cls: Type[Self]) -> Self:
"""A factory method that creates a :class:`AutoModPresets` with everything enabled."""
bits = max(cls.VALID_FLAGS.values()).bit_length()
value = (1 << bits) - 1
self = cls.__new__(cls)
self.value = value
return self
@classmethod
def none(cls: Type[Self]) -> Self:
"""A factory method that creates a :class:`AutoModPresets` with everything disabled."""
self = cls.__new__(cls)
self.value = self.DEFAULT_VALUE
return self
@flag_value
def profanity(self):
""":class:`bool`: Whether to use the preset profanity filter."""
return 1 << 0
@flag_value
def sexual_content(self):
""":class:`bool`: Whether to use the preset sexual content filter."""
return 1 << 1
@flag_value
def slurs(self):
""":class:`bool`: Whether to use the preset slurs filter."""
return 1 << 2