Merge: v5.7.0

LordOfPolls · web-flow · commit ea20323d3dd6 · 2023-06-19T08:10:13.000+01:00
v5.7.0
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -30,7 +30,7 @@ repos:
     - id: check-merge-conflict
       name: Merge Conflicts
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.270'
+    rev: 'v0.0.272'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ In addition to core functionality, `interactions.py` provides a range of optiona
 
 So the base library doesn't do what you want? No problem! With builtin extensions, you are able to extend the functionality of the library. And if none of those pique your interest, there are a myriad of other extension libraries available.
 
-Just type `bot.load("extension")`
+Just type `bot.load_extension("extension")`
 
 <details>
     <summary>Extensions</summary>
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -34,7 +34,7 @@ In addition to core functionality, interactions.py provides a range of optional
 
 So the base library doesn't do what you want? No problem! With builtin extensions, you are able to extend the functionality of the library. And if none of those pique your interest, there are a myriad of other extension libraries available.
 
-Just type `bot.load("extension")`
+Just type `bot.load_extension("extension")`
 
 ---
 
diff --git a/interactions/__init__.py b/interactions/__init__.py
@@ -1,3 +1,4 @@
+import sys
 from .client import (
     __api_version__,
     __py_version__,
@@ -680,6 +681,10 @@
     "WebSocketOPCode",
 )
 
+if "discord" in sys.modules:
+    get_logger().error(
+        "`import discord` import detected.  Interactions.py is a completely separate library, and is not compatible with d.py models.  Please see https://interactions-py.github.io/interactions.py/Guides/100%20Migration%20From%20D.py/ for how to fix your code."
+    )
 
 ########################################################################################################################
 # Noteworthy Credits
diff --git a/interactions/api/events/base.py b/interactions/api/events/base.py
@@ -9,7 +9,7 @@
 from interactions.models.discord.snowflake import to_snowflake
 
 if TYPE_CHECKING:
-    from interactions import Client
+    from interactions.client.client import Client
     from interactions.models.discord.snowflake import Snowflake_Type
     from interactions.models.discord.guild import Guild
 
diff --git a/interactions/api/http/http_requests/guild.py b/interactions/api/http/http_requests/guild.py
@@ -1,17 +1,18 @@
-from typing import TYPE_CHECKING, List, cast, Mapping, Any
+from typing import TYPE_CHECKING, Any, List, Mapping, cast
 
 import discord_typings
 
 from interactions.client.utils.serializer import dict_filter_none
 from interactions.models.internal.protocols import CanRequest
-from ..route import Route, PAYLOAD_TYPE
+
+from ..route import PAYLOAD_TYPE, Route
 
 __all__ = ("GuildRequests",)
 
 
 if TYPE_CHECKING:
-    from interactions.models.discord.snowflake import Snowflake_Type
     from interactions.models.discord.enums import AuditLogEventType
+    from interactions.models.discord.snowflake import Snowflake_Type
 
 
 class GuildRequests(CanRequest):
@@ -404,9 +405,6 @@ async def modify_guild_role_positions(
         Args:
             guild_id: The ID of the guild
             position_changes: A list of dicts representing the roles to move and their new positions
-
-            ``{"id": role_id, "position": new_position}``
-
             reason: The reason for this action
 
         Returns:
diff --git a/interactions/api/voice/voice_gateway.py b/interactions/api/voice/voice_gateway.py
@@ -268,7 +268,7 @@ def _udp_keep_alive(self) -> None:
         keep_alive = b"\xc9\x00\x00\x00\x00\x00\x00\x00\x00"
 
         self.logger.debug("Starting UDP Keep Alive")
-        while not self.socket._closed and not self.ws.closed:
+        while not self.socket._closed and self.ws and not self.ws.closed:
             try:
                 _, writable, _ = select.select([], [self.socket], [], 0)
                 while not writable:
diff --git a/interactions/client/mixins/modal.py b/interactions/client/mixins/modal.py
@@ -9,7 +9,7 @@
 
 
 class ModalMixin:
-    client: "interactions.Client"
+    client: "interactions.client.client.Client"
     """The client that created this context."""
     responded: bool
     """Whether this context has been responded to."""
diff --git a/interactions/client/mixins/send.py b/interactions/client/mixins/send.py
@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING, Any, Iterable, Optional, Union
 
 import interactions.models as models
+import interactions.models.discord
 from interactions.models.discord.enums import MessageFlags
 
 if TYPE_CHECKING:
@@ -82,6 +83,18 @@ async def send(
                 flags = MessageFlags(flags)
             flags = flags | MessageFlags.SILENT
 
+        if (
+            files
+            and (
+                isinstance(files, Iterable)
+                and any(isinstance(file, interactions.models.discord.message.Attachment) for file in files)
+            )
+            or isinstance(files, interactions.models.discord.message.Attachment)
+        ):
+            raise ValueError(
+                "Attachments are not files. Attachments only contain metadata about the file, not the file itself - to send an attachment, you need to download it first. Check Attachment.url"
+            )
+
         message_payload = models.discord.message.process_message_payload(
             content=content,
             embeds=embeds or embed,
diff --git a/interactions/client/utils/attr_utils.py b/interactions/client/utils/attr_utils.py
@@ -36,20 +36,20 @@ def docs(doc_string: str) -> Dict[str, str]:
     return {"docs": doc_string}
 
 
-def str_validator(self: Any, attribute: attrs.Attribute, value: Any) -> None:
+def str_validator(cls: Any, attribute: attrs.Attribute, value: Any) -> None:
     """
     Validates that the value is a string. Helps convert and ives a warning if it isn't.
 
     Args:
-        self: The instance of the class.
+        cls: The instance of the class.
         attribute: The attr attribute being validated.
         value: The value being validated.
 
     """
     if not isinstance(value, str):
         if value is MISSING:
             return
-        setattr(self, attribute.name, str(value))
+        setattr(cls, attribute.name, str(value))
         get_logger().warning(
             f"Value of {attribute.name} has been automatically converted to a string. Please use strings in future.\n"
             "Note: Discord will always return value as a string"
diff --git a/interactions/client/utils/input_utils.py b/interactions/client/utils/input_utils.py
@@ -35,7 +35,7 @@ def enc_hook(obj: Any) -> int:
 
     json_mode = "msgspec"
 else:
-    import json
+    import json  # type: ignore
 
 get_logger().debug(f"Using {json_mode} for JSON encoding and decoding.")
 
diff --git a/interactions/ext/paginators.py b/interactions/ext/paginators.py
@@ -352,18 +352,19 @@ def to_dict(self) -> dict:
             "components": [c.to_dict() for c in self.create_components()],
         }
 
-    async def send(self, ctx: BaseContext) -> Message:
+    async def send(self, ctx: BaseContext, **kwargs) -> Message:
         """
         Send this paginator.
 
         Args:
             ctx: The context to send this paginator with
+            **kwargs: Additional options to pass to `send`.
 
         Returns:
             The resulting message
 
         """
-        self._message = await ctx.send(**self.to_dict())
+        self._message = await ctx.send(**self.to_dict(), **kwargs)
         self._author_id = ctx.author.id
 
         if self.timeout_interval > 1:
@@ -372,16 +373,18 @@ async def send(self, ctx: BaseContext) -> Message:
 
         return self._message
 
-    async def reply(self, ctx: "PrefixedContext") -> Message:
+    async def reply(self, ctx: "PrefixedContext", **kwargs) -> Message:
         """
         Reply this paginator to ctx.
 
         Args:
             ctx: The context to reply this paginator with
+            **kwargs: Additional options to pass to `reply`.
+
         Returns:
             The resulting message
         """
-        self._message = await ctx.reply(**self.to_dict())
+        self._message = await ctx.reply(**self.to_dict(), **kwargs)
         self._author_id = ctx.author.id
 
         if self.timeout_interval > 1:
diff --git a/interactions/ext/prefixed_commands/context.py b/interactions/ext/prefixed_commands/context.py
@@ -1,4 +1,4 @@
-from typing import Optional, Union, Iterable, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Iterable, Optional, Union
 
 from typing_extensions import Self
 
@@ -80,7 +80,7 @@ async def reply(
         content: Optional[str] = None,
         embeds: Optional[Union[Iterable[Union[Embed, dict]], Union[Embed, dict]]] = None,
         embed: Optional[Union[Embed, dict]] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> Message:
         """
         Reply to the context's message. Takes all the same attributes as `send`.
diff --git a/interactions/models/discord/channel.py b/interactions/models/discord/channel.py
@@ -775,6 +775,8 @@ class BaseChannel(DiscordObject):
     """The name of the channel (1-100 characters)"""
     type: Union[ChannelType, int] = attrs.field(repr=True, converter=ChannelType)
     """The channel topic (0-1024 characters)"""
+    permissions: Optional[Permissions] = attrs.field(repr=False, default=None, converter=optional_c(Permissions))
+    """Calculated permissions for the bot in this channel, only given when using channels as an option with slash commands"""
 
     @classmethod
     def from_dict_factory(cls, data: dict, client: "Client") -> "TYPE_ALL_CHANNEL":
diff --git a/interactions/models/discord/emoji.py b/interactions/models/discord/emoji.py
@@ -206,6 +206,11 @@ async def delete(self, reason: Optional[str] = None) -> None:
 
         await self._client.http.delete_guild_emoji(self._guild_id, self.id, reason=reason)
 
+    @property
+    def url(self) -> str:
+        """CDN url for the emoji."""
+        return f"https://cdn.discordapp.net/emojis/{self.id}.{'gif' if self.animated else 'png'}"
+
 
 def process_emoji_req_format(emoji: Optional[Union[PartialEmoji, dict, str]]) -> Optional[str]:
     """
diff --git a/interactions/models/discord/file.py b/interactions/models/discord/file.py
@@ -32,7 +32,7 @@ def __attrs_post_init__(self) -> None:
             else:
                 self.file_name = Path(self.file).name
 
-    def open_file(self) -> BinaryIO:
+    def open_file(self) -> BinaryIO | IOBase:
         """
         Opens the file.
 
@@ -55,7 +55,7 @@ def __exit__(self, exc_type, exc_val, exc_tb) -> None:
 UPLOADABLE_TYPE = Union[File, IOBase, BinaryIO, Path, str]
 
 
-def open_file(file: UPLOADABLE_TYPE) -> BinaryIO:
+def open_file(file: UPLOADABLE_TYPE) -> BinaryIO | IOBase:
     """
     Opens the file.
 
diff --git a/interactions/models/discord/guild.py b/interactions/models/discord/guild.py
@@ -3,47 +3,55 @@
 from asyncio import QueueEmpty
 from collections import namedtuple
 from functools import cmp_to_key
-from typing import List, Optional, Union, Set, Dict, Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union
 from warnings import warn
 
 import attrs
 
 import interactions.models as models
-from interactions.client.const import Absent, MISSING, PREMIUM_GUILD_LIMITS
+from interactions.client.const import MISSING, PREMIUM_GUILD_LIMITS, Absent
 from interactions.client.errors import EventLocationNotProvided, NotFound
 from interactions.client.mixins.serialization import DictSerializationMixin
-from interactions.client.utils.attr_converters import optional, list_converter
-from interactions.client.utils.attr_converters import timestamp_converter
+from interactions.client.utils.attr_converters import optional, list_converter, timestamp_converter
 from interactions.client.utils.attr_utils import docs
 from interactions.client.utils.deserialise_app_cmds import deserialize_app_cmds
-from interactions.client.utils.serializer import to_image_data, no_export_meta
-from interactions.models.discord.app_perms import CommandPermissions, ApplicationCommandPermission
+from interactions.client.utils.serializer import no_export_meta, to_image_data
+from interactions.models.discord.app_perms import (
+    ApplicationCommandPermission,
+    CommandPermissions,
+)
 from interactions.models.discord.auto_mod import AutoModRule, BaseAction, BaseTrigger
 from interactions.models.discord.file import UPLOADABLE_TYPE
 from interactions.models.misc.iterator import AsyncIterator
-from .base import DiscordObject, ClientObject
+
+from .base import ClientObject, DiscordObject
 from .enums import (
-    NSFWLevel,
-    Permissions,
-    SystemChannelFlags,
-    VerificationLevel,
+    AuditLogEventType,
+    AutoModEvent,
+    AutoModTriggerType,
+    ChannelType,
     DefaultNotificationLevel,
     ExplicitContentFilterLevel,
-    MFALevel,
-    ChannelType,
+    ForumLayoutType,
     IntegrationExpireBehaviour,
+    MFALevel,
+    NSFWLevel,
+    Permissions,
     ScheduledEventPrivacyLevel,
     ScheduledEventType,
-    AuditLogEventType,
-    AutoModEvent,
-    AutoModTriggerType,
-    ForumLayoutType,
+    SystemChannelFlags,
+    VerificationLevel,
+)
+from .snowflake import (
+    Snowflake_Type,
+    to_optional_snowflake,
+    to_snowflake,
+    to_snowflake_list,
 )
-from .snowflake import to_snowflake, Snowflake_Type, to_optional_snowflake, to_snowflake_list
 
 if TYPE_CHECKING:
-    from interactions.client.client import Client
     from interactions import InteractionCommand
+    from interactions.client.client import Client
 
 __all__ = (
     "GuildBan",
@@ -581,7 +589,7 @@ async def http_chunk(self) -> None:
             f"Cached {iterator.total_retrieved} members for {self.id} in {time.perf_counter() - start_time:.2f} seconds"
         )
 
-    async def gateway_chunk(self, wait=True, presences=True) -> None:
+    async def gateway_chunk(self, wait: bool = True, presences: bool = True) -> None:
         """
         Trigger a gateway `get_members` event, populating this object with members.
 
@@ -598,7 +606,7 @@ async def chunk(self) -> None:
         """Populates all members of this guild using the REST API."""
         await self.http_chunk()
 
-    async def chunk_guild(self, wait=True, presences=True) -> None:
+    async def chunk_guild(self, wait: bool = True, presences: bool = True) -> None:
         """
         Trigger a gateway `get_members` event, populating this object with members.
 
diff --git a/interactions/models/discord/scheduled_event.py b/interactions/models/discord/scheduled_event.py
@@ -15,7 +15,7 @@
 from .enums import ScheduledEventPrivacyLevel, ScheduledEventType, ScheduledEventStatus
 
 if TYPE_CHECKING:
-    from interactions.client import Client
+    from interactions.client.client import Client
     from interactions.models.discord.channel import GuildStageVoice, GuildVoice
     from interactions.models.discord.guild import Guild
     from interactions.models.discord.user import Member
diff --git a/interactions/models/discord/sticker.py b/interactions/models/discord/sticker.py
@@ -135,6 +135,11 @@ async def delete(self, reason: Optional[str] = MISSING) -> None:
 
         await self._client.http.delete_guild_sticker(self._guild_id, self.id, reason)
 
+    @property
+    def url(self) -> str:
+        """CDN url for the sticker."""
+        return f"https://media.discordapp.net/stickers/{self.id}.webp"
+
 
 @attrs.define(eq=False, order=False, hash=False, kw_only=True)
 class StickerPack(DiscordObject):
diff --git a/interactions/models/discord/user.py b/interactions/models/discord/user.py
@@ -65,7 +65,7 @@ def _process_dict(cls, data: Dict[str, Any], client: "Client") -> Dict[str, Any]
             if data["avatar"]:
                 data["avatar"] = Asset.from_path_hash(client, f"avatars/{data['id']}/{{}}", data["avatar"])
             elif data["discriminator"] == "0":
-                data["avatar"] = Asset(client, f"{Asset.BASE}/embed/avatars/{(int(data['id']) >> 22) % 5}")
+                data["avatar"] = Asset(client, f"{Asset.BASE}/embed/avatars/{(int(data['id']) >> 22) % 6}")
             else:
                 data["avatar"] = Asset(client, f"{Asset.BASE}/embed/avatars/{int(data['discriminator']) % 5}")
         return data
diff --git a/interactions/models/discord/user.pyi b/interactions/models/discord/user.pyi
diff --git a/interactions/models/internal/active_voice_state.py b/interactions/models/internal/active_voice_state.py
diff --git a/interactions/models/internal/tasks/task.py b/interactions/models/internal/tasks/task.py
diff --git a/interactions/models/internal/tasks/triggers.py b/interactions/models/internal/tasks/triggers.py
diff --git a/pyproject.toml b/pyproject.toml
