feat: new IntFlag objects for User & Application flags (#459)

* Add user & bot flags to flags.py

* changed some user flag names

* Added flags.py to user.pyi

* added flag properties to user object

* removed unused appflags

* Added flag checking before starting gateway

* added AppFlags

* added appflags

* abstracted flags to application object

* Accounted for LIMITED priv intent flags

* Fix typo

Co-authored-by: Damego <[email protected]>

Co-authored-by: Damego <[email protected]>

Author: panley01

interactions/api/models/flags.py

@@ -85,3 +85,36 @@ class Permissions(IntFlag):
     SEND_MESSAGES_IN_THREADS = 1 << 38
     START_EMBEDDED_ACTIVITIES = 1 << 39
     MODERATE_MEMBERS = 1 << 40
+
+    
+class UserFlags(IntFlag):
+    """An integer flag bitshift object representing the different user flags given by Discord."""
+    
+    STAFF = 1
+    PARTNER = 1 << 1
+    HYPESQUAD = 1 << 2
+    BUG_HUNTER_LEVEL_1 = 1 << 3
+    HYPESQUAD_HOUSE_1 = 1 << 6
+    HYPESQUAD_HOUSE_2 = 1 << 7
+    HYPESQUAD_HOUSE_3 = 1 << 8
+    PREMIUM_EARLY_SUPPORTER = 1 << 9
+    TEAM_PSEUDO_USER = 1 << 10
+    SYSTEM = 1 << 12
+    BUG_HUNTER_LEVEL_2 = 1 << 14
+    VERIFIED_BOT = 1 << 16
+    VERIFIED_DEVELOPER = 1 << 17
+    DISCORD_CERTIFIED_MODERATOR = 1 << 18
+    BOT_HTTP_INTERACTIONS = 1 << 19
+
+class AppFlags(IntFlag):
+    """An integer flag bitshift object representing the different application flags given by Discord."""
+    
+    GATEWAY_PRESENCE = 1 << 12
+    GATEWAY_PRESENCE_LIMITED = 1 << 13
+    GATEWAY_GUILD_MEMBERS = 1 << 14
+    GATEWAY_GUILD_MEMBERS_LIMITED = 1 << 15
+    VERIFICATION_PENDING_GUILD_LIMIT = 1 << 16
+    EMBEDDED = 1 << 17
+    GATEWAY_MESSAGE_CONTENT = 1 << 18
+    GATEWAY_MESSAGE_CONTENT_LIMITED = 1 << 19
+        

interactions/api/models/team.py

@@ -1,6 +1,7 @@
 from .channel import ThreadMember
 from .misc import DictSerializerMixin, Snowflake
 from .user import User
+from .flags import AppFlags
 
 
 class TeamMember(DictSerializerMixin):
@@ -75,7 +76,7 @@ class Application(DictSerializerMixin):
     :ivar Optional[int] primary_sku_id?: Game SKU ID, if this app is a game sold on Discord
     :ivar Optional[str] slug?: URL slug that links to the store page, if this app is a game sold on Discord
     :ivar Optional[str] cover_image?: The app's default rich presence invite cover image
-    :ivar Optional[int] flags?: The application's public flags
+    :ivar Optional[AppFlags] flags?: The application's public flags
     """
 
     __slots__ = (
@@ -115,3 +116,4 @@ def __init__(self, **kwargs):
         )
         self.owner = User(**self.owner) if self._json.get("owner") else None
         self.team = Team(**self.team) if self._json.get("team") else None
+        self.flags = AppFlags(self.flags) if self._json.get("flags") else None

interactions/api/models/team.pyi

@@ -2,6 +2,7 @@ from typing import Any, List, Optional
 
 from .misc import DictSerializerMixin, Snowflake
 from .user import User
+from .flags import AppFlags
 
 class TeamMember(DictSerializerMixin):
     _json: dict
@@ -39,7 +40,7 @@ class Application(DictSerializerMixin):
     primary_sku_id: Optional[Snowflake]
     slug: Optional[str]
     cover_image: Optional[str]
-    flags: Optional[int]
+    flags: Optional[AppFlags]
     type: Optional[Any]
     hook: Optional[Any]
     def __init__(self, **kwargs): ...

interactions/api/models/user.py

@@ -1,4 +1,5 @@
 from .misc import DictSerializerMixin, Snowflake
+from .flags import UserFlags
 
 
 class User(DictSerializerMixin):
@@ -8,18 +9,18 @@ class User(DictSerializerMixin):
     :ivar Snowflake id: The User ID
     :ivar str username: The Username associated (not necessarily unique across the platform)
     :ivar str discriminator: The User's 4-digit discord-tag (i.e.: XXXX)
-    :ivar Optional[str] avatar?: The user's avatar hash, if any.
-    :ivar Optional[bool] bot?: A status denoting if the user is a bot.
-    :ivar Optional[bool] system?: A status denoting if the user is an Official Discord System user.
-    :ivar Optional[bool] mfa_enabled?: A status denoting if the user has 2fa on their account.
-    :ivar Optional[str] banner?: The user's banner hash, if any.
+    :ivar Optional[str] avatar?: The user's avatar hash, if any
+    :ivar Optional[bool] bot?: A status denoting if the user is a bot
+    :ivar Optional[bool] system?: A status denoting if the user is an Official Discord System user
+    :ivar Optional[bool] mfa_enabled?: A status denoting if the user has 2fa on their account
+    :ivar Optional[str] banner?: The user's banner hash, if any
     :ivar Optional[int] accent_color?: The user's banner color as an integer represented of hex color codes
     :ivar Optional[str] locale?: The user's chosen language option
     :ivar Optional[bool] verified?: Whether the email associated with this account has been verified
-    :ivar Optional[str] email?: The user's email, if any.
-    :ivar Optional[int] flags?: The user's flags
+    :ivar Optional[str] email?: The user's email, if any
+    :ivar Optional[UserFlags] flags?: The user's flags
     :ivar Optional[int] premium_type?: The type of Nitro subscription the user has
-    :ivar Optional[int] public_flags?: The user's public flags
+    :ivar Optional[UserFlags] public_flags?: The user's public flags
     """
 
     __slots__ = (
@@ -44,3 +45,15 @@ class User(DictSerializerMixin):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.id = Snowflake(self.id) if self._json.get("id") else None
+        
+        self.public_flags = (
+            UserFlags(int(self._json.get("public_flags")))
+            if self._json.get("public_flags")
+            else None
+        )
+        
+        self.flags = (
+            UserFlags(int(self._json.get("flags")))
+            if self._json.get("flags")
+            else None
+        )

interactions/api/models/user.pyi

@@ -1,6 +1,7 @@
 from typing import Optional
 
 from .misc import DictSerializerMixin, Snowflake
+from .flags import UserFlags, AppFlags
 
 class User(DictSerializerMixin):
     _json: dict
@@ -16,7 +17,7 @@ class User(DictSerializerMixin):
     locale: Optional[str]
     verified: Optional[bool]
     email: Optional[str]
-    flags: Optional[int]
+    flags: Optional[UserFlags]
     premium_type: Optional[int]
-    public_flags: Optional[int]
+    public_flags: Optional[UserFlags]
     def __init__(self, **kwargs): ...

interactions/client.py

@@ -91,9 +91,10 @@ def __init__(
             )
         else:
             self._automate_sync = True
-
+        
         data = self._loop.run_until_complete(self._http.get_current_bot_information())
         self.me = Application(**data)
+        
 
     def start(self) -> None:
         """Starts the client session."""
@@ -256,6 +257,12 @@ async def _ready(self) -> None:
         ready: bool = False
 
         try:
+            if self._intents.GUILD_PRESENCES and not (self.me.flags.GATEWAY_PRESENCE or self.me.flags.GATEWAY_PRESENCE_LIMITED):
+                raise RuntimeError("Client not authorised for GUILD_PRESENCES intent")
+            if self._intents.GUILD_MEMBERS and not (self.me.flags.GATEWAY_GUILD_MEMBERS or self.me.flags.GATEWAY_GUILD_MEMBERS_LIMITED):
+                raise RuntimeError("Client not authorised for GUILD_MEMBERS intent")
+            if self._intents.GUILD_MESSAGES and not (self.me.flags.GATEWAY_MESSAGE_CONTENT or self.me.flags.GATEWAY_MESSAGE_CONTENT_LIMITED):
+                log.critical("Client not authorised for MESSAGE_CONTENT intent")
             self.__register_events()
             if self._automate_sync:
                 await self._synchronize()