Include features within guild model

docs/api.rst

@@ -47,6 +47,14 @@ Utilities
 .. autodecorator:: flask_discord.requires_authorization
 
 
+Enums
+-----
+
+.. autoclass:: flask_discord.enums.GuildFeature
+    :members:
+    :inherited-members:
+
+
 Exceptions
 ----------
 

flask_discord/enums.py

@@ -0,0 +1,111 @@
+from .utils import StringEnum
+
+import enum
+
+
+@enum.unique
+class GuildFeature(StringEnum):
+    """Discord guild enabled features.
+
+    Attributes
+    ----------
+    ANIMATED_BANNER
+        Guild has access to set an animated guild banner image.
+    ANIMATED_ICON
+        Guild has access to set an animated guild icon.
+    AUTO_MODERATION
+        Guild has set up auto moderation rules.
+    BANNER
+        Guild has access to set a guild banner image.
+    COMMUNITY
+        Guild can enable welcome screen, Membership Screening, stage channels and discovery,
+        and receives community updates.
+    DISCOVERABLE
+        Guild is able to be discovered in the directory.
+    ENABLED_DISCOVERABLE_BEFORE
+        > No information available from Discord.
+    EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT
+        > No information available from Discord.
+    FEATURABLE
+        Guild is able to be featured in the directory.
+    GUILD_HOME_TEST
+        > No information available from Discord.
+    HAS_DIRECTORY_ENTRY
+        > No information available from Discord.
+    INVITE_SPLASH
+        Guild has access to set an invite splash background.
+    MEMBER_PROFILES
+        > No information available from Discord.
+    MEMBER_VERIFICATION_GATE_ENABLED
+        Guild has enabled Membership Screening.
+    MONETIZATION_ENABLED
+        Guild has enabled monetization.
+    MORE_STICKERS
+        Guild has increased custom sticker slots.
+    NEWS
+        Guild has access to create news channels.
+    NEW_THREAD_PERMISSIONS
+        > No information available from Discord.
+    PARTNERED
+        Guild is partnered.
+    PREVIEW_ENABLED
+        Guild can be previewed before joining via Membership Screening or the directory.
+    PRIVATE_THREADS
+        Guild has access to create private threads.
+    RELAY_ENABLED
+        > No information available from Discord.
+    ROLE_ICONS
+        Guild is able to set role icons.
+    SEVEN_DAY_THREAD_ARCHIVE
+        > No information available from Discord.
+    TEXT_IN_VOICE_ENABLED
+        > No information available from Discord.
+    TICKETED_EVENTS_ENABLED
+        Guild has enabled ticketed events.
+    THREADS_ENABLED
+        Guild has enabled threads.
+    THREE_DAY_THREAD_ARCHIVE
+        > No information available from Discord.
+    VANITY_URL
+        Guild has access to set a vanity URL.
+    VERIFIED
+        Guild is verified.
+    VIP_REGIONS
+        Guild has access to set 384kbps bitrate in voice (previously VIP voice servers).
+    WELCOME_SCREEN_ENABLED
+        Guild has enabled the welcome screen.
+
+    """
+
+    ANIMATED_BANNER = "ANIMATED_BANNER"
+    ANIMATED_ICON = "ANIMATED_ICON"
+    AUTO_MODERATION = "AUTO_MODERATION"
+    BANNER = "BANNER"
+    COMMUNITY = "COMMUNITY"
+    DISCOVERABLE = "DISCOVERABLE"
+    ENABLED_DISCOVERABLE_BEFORE = "ENABLED_DISCOVERABLE_BEFORE"
+    EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT = "EXPOSED_TO_ACTIVITIES_WTP_EXPERIMENT"
+    FEATURABLE = "FEATURABLE"
+    GUILD_HOME_TEST = "GUILD_HOME_TEST"
+    HAS_DIRECTORY_ENTRY = "HAS_DIRECTORY_ENTRY"
+    INVITE_SPLASH = "INVITE_SPLASH"
+    MEMBER_PROFILES = "MEMBER_PROFILES"
+    MEMBER_VERIFICATION_GATE_ENABLED = "MEMBER_VERIFICATION_GATE_ENABLED"
+    MONETIZATION_ENABLED = "MONETIZATION_ENABLED"
+    MORE_STICKERS = "MORE_STICKERS"
+    NEWS = "NEWS"
+    NEW_THREAD_PERMISSIONS = "NEW_THREAD_PERMISSIONS"
+    PARTNERED = "PARTNERED"
+    PREVIEW_ENABLED = "PREVIEW_ENABLED"
+    PRIVATE_THREADS = "PRIVATE_THREADS"
+    RELAY_ENABLED = "RELAY_ENABLED"
+    ROLE_ICONS = "ROLE_ICONS"
+    SEVEN_DAY_THREAD_ARCHIVE = "SEVEN_DAY_THREAD_ARCHIVE"
+    TEXT_IN_VOICE_ENABLED = "TEXT_IN_VOICE_ENABLED"
+    TICKETED_EVENTS_ENABLED = "TICKETED_EVENTS_ENABLED"
+    THREADS_ENABLED = "THREADS_ENABLED"
+    THREE_DAY_THREAD_ARCHIVE = "THREE_DAY_THREAD_ARCHIVE"
+    VANITY_URL = "VANITY_URL"
+    VERIFIED = "VERIFIED"
+    VIP_REGIONS = "VIP_REGIONS"
+    WELCOME_SCREEN_ENABLED = "WELCOME_SCREEN_ENABLED"

flask_discord/models/guild.py

@@ -2,7 +2,8 @@ from .base import DiscordModelsBase
 from flask import current_app
 
 import discord
-from .. import configs
+
+from .. import configs, enums
 
 
 class Guild(DiscordModelsBase):
@@ -29,6 +30,8 @@ class Guild(DiscordModelsBase):
         Boolean determining if current user is owner of the guild or not.
     permissions : discord.Permissions
         An instance of discord.Permissions representing permissions of current user in the guild.
+    features : list
+        A list of Discord guild features enumerations instances of type :py:class:`flask_discord.enums.GuildFeature`.
 
     """
 
@@ -42,6 +45,7 @@ class Guild(DiscordModelsBase):
         self.icon_hash = self._payload.get("icon")
         self.is_owner = self._payload.get("owner")
         self.permissions = self.__get_permissions(self._payload.get("permissions"))
+        self.features = [enums.GuildFeature(f.upper()) for f in self._payload["features"]]
 
     @staticmethod
     def __get_permissions(permissions_value):

flask_discord/scopes.py

@@ -1,8 +1,10 @@
+from .utils import StringEnum
+
 import enum
 
 
 @enum.unique
-class DiscordOAuth2Scope(enum.Enum):
+class DiscordOAuth2Scope(StringEnum):
     """These are a `list of all the OAuth2 scopes that Discord supports
     <https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes>`_. Some scopes require
     approval from Discord to use. Requesting them from a user without approval from Discord may cause

flask_discord/utils.py

@@ -1,6 +1,7 @@
 """Few utility functions and decorators."""
 
 import functools
+import enum
 
 from . import exceptions
 from flask import current_app
@@ -26,6 +27,11 @@ class JSONBool(object):
         raise ValueError()
 
 
+class StringEnum(enum.Enum):
+    def __str__(self):
+        return str(self.value)
+
+
 def json_bool(value):
     if isinstance(value, str):
         return str(JSONBool.from_string(value))