docs and typing cleanup

Author: NeloBlivion

discord/abc.py

@@ -95,7 +95,7 @@
     from .types.channel import GuildChannel as GuildChannelPayload
     from .types.channel import OverwriteType
     from .types.channel import PermissionOverwrite as PermissionOverwritePayload
-    from .ui.view import View
+    from .ui.view import BaseView
     from .user import ClientUser
 
     PartialMessageableChannel = Union[
@@ -1355,7 +1355,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1376,7 +1376,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1397,7 +1397,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1418,7 +1418,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1509,7 +1509,7 @@ async def send(
             If set, overrides the :attr:`~discord.AllowedMentions.replied_user` attribute of ``allowed_mentions``.
 
             .. versionadded:: 1.6
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             A Discord UI View to add to the message.
         embeds: List[:class:`~discord.Embed`]
             A list of embeds to upload. Must be a maximum of 10.

discord/channel.py

@@ -107,7 +107,7 @@
     from .types.channel import VoiceChannelEffectSendEvent as VoiceChannelEffectSend
     from .types.snowflake import SnowflakeList
     from .types.threads import ThreadArchiveDuration
-    from .ui.view import View
+    from .ui.view import BaseView
     from .user import BaseUser, ClientUser, User
     from .webhook import Webhook
 
@@ -1217,7 +1217,7 @@ async def create_thread(
         delete_message_after: float | None = None,
         nonce: int | str | None = None,
         allowed_mentions: AllowedMentions | None = None,
-        view: View | None = None,
+        view: BaseView | None = None,
         applied_tags: list[ForumTag] | None = None,
         suppress: bool = False,
         silent: bool = False,
@@ -1262,7 +1262,7 @@ async def create_thread(
             to the object, otherwise it uses the attributes set in :attr:`~discord.Client.allowed_mentions`.
             If no object is passed at all then the defaults given by :attr:`~discord.Client.allowed_mentions`
             are used instead.
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             A Discord UI View to add to the message.
         applied_tags: List[:class:`discord.ForumTag`]
             A list of tags to apply to the new thread.

discord/client.py

@@ -59,7 +59,7 @@
 from .sticker import GuildSticker, StandardSticker, StickerPack, _sticker_factory
 from .template import Template
 from .threads import Thread
-from .ui.view import View
+from .ui.view import BaseView
 from .user import ClientUser, User
 from .utils import MISSING
 from .voice_client import VoiceClient
@@ -552,7 +552,7 @@ async def on_view_error(
 
         The default view error handler provided by the client.
 
-        This only fires for a view if you did not define its :func:`~discord.ui.View.on_error`.
+        This only fires for a view if you did not define its :func:`~discord.ui.BaseView.on_error`.
 
         Parameters
         ----------
@@ -2037,8 +2037,8 @@ async def create_dm(self, user: Snowflake) -> DMChannel:
         data = await state.http.start_private_message(user.id)
         return state.add_dm_channel(data)
 
-    def add_view(self, view: View, *, message_id: int | None = None) -> None:
-        """Registers a :class:`~discord.ui.View` for persistent listening.
+    def add_view(self, view: BaseView, *, message_id: int | None = None) -> None:
+        """Registers a :class:`~discord.ui.BaseView` for persistent listening.
 
         This method should be used for when a view is comprised of components
         that last longer than the lifecycle of the program.
@@ -2047,7 +2047,7 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
 
         Parameters
         ----------
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             The view to register for dispatching.
         message_id: Optional[:class:`int`]
             The message ID that the view is attached to. This is currently used to
@@ -2063,8 +2063,8 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
             and all their components have an explicitly provided ``custom_id``.
         """
 
-        if not isinstance(view, View):
-            raise TypeError(f"expected an instance of View not {view.__class__!r}")
+        if not isinstance(view, BaseView):
+            raise TypeError(f"expected an instance of BaseView not {view.__class__!r}")
 
         if not view.is_persistent():
             raise ValueError(
@@ -2075,7 +2075,7 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
         self._connection.store_view(view, message_id)
 
     @property
-    def persistent_views(self) -> Sequence[View]:
+    def persistent_views(self) -> Sequence[BaseView]:
         """A sequence of persistent views added to the client.
 
         .. versionadded:: 2.0

discord/interactions.py

@@ -89,7 +89,7 @@
     from .types.interactions import InteractionMetadata as InteractionMetadataPayload
     from .types.interactions import MessageInteraction as MessageInteractionPayload
     from .ui.modal import Modal
-    from .ui.view import View
+    from .ui.view import BaseView
 
     InteractionChannel = Union[
         VoiceChannel,
@@ -164,7 +164,7 @@ class Interaction:
         The command that this interaction belongs to.
 
         .. versionadded:: 2.7
-    view: Optional[:class:`View`]
+    view: Optional[:class:`BaseView`]
         The view that this interaction belongs to.
 
         .. versionadded:: 2.7
@@ -257,7 +257,7 @@ def _from_data(self, data: InteractionPayload):
         )
 
         self.command: ApplicationCommand | None = None
-        self.view: View | None = None
+        self.view: BaseView | None = None
         self.modal: Modal | None = None
         self.attachment_size_limit: int = data.get("attachment_size_limit")
 
@@ -522,7 +522,7 @@ async def edit_original_response(
         file: File = MISSING,
         files: list[File] = MISSING,
         attachments: list[Attachment] = MISSING,
-        view: View | None = MISSING,
+        view: BaseView | None = MISSING,
         allowed_mentions: AllowedMentions | None = None,
         delete_after: float | None = None,
         suppress: bool = False,
@@ -557,7 +557,7 @@ async def edit_original_response(
         allowed_mentions: :class:`AllowedMentions`
             Controls the mentions being processed in this message.
             See :meth:`.abc.Messageable.send` for more information.
-        view: Optional[:class:`~discord.ui.View`]
+        view: Optional[:class:`~discord.ui.BaseView`]
             The updated view to update this message with. If ``None`` is passed then
             the view is removed.
         delete_after: Optional[:class:`float`]
@@ -947,7 +947,7 @@ async def send_message(
         *,
         embed: Embed = None,
         embeds: list[Embed] = None,
-        view: View = None,
+        view: BaseView = None,
         tts: bool = False,
         ephemeral: bool = False,
         allowed_mentions: AllowedMentions = None,
@@ -972,7 +972,7 @@ async def send_message(
             ``embeds`` parameter.
         tts: :class:`bool`
             Indicates if the message should be sent using text-to-speech.
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             The view to send with the message.
         ephemeral: :class:`bool`
             Indicates if the message should only be visible to the user who started the interaction.
@@ -1128,7 +1128,7 @@ async def edit_message(
         file: File = MISSING,
         files: list[File] = MISSING,
         attachments: list[Attachment] = MISSING,
-        view: View | None = MISSING,
+        view: BaseView | None = MISSING,
         delete_after: float | None = None,
         suppress: bool | None = MISSING,
         allowed_mentions: AllowedMentions | None = None,
@@ -1155,7 +1155,7 @@ async def edit_message(
         attachments: List[:class:`Attachment`]
             A list of attachments to keep in the message. If ``[]`` is passed
             then all attachments are removed.
-        view: Optional[:class:`~discord.ui.View`]
+        view: Optional[:class:`~discord.ui.BaseView`]
             The updated view to update this message with. If ``None`` is passed then
             the view is removed.
         delete_after: Optional[:class:`float`]
@@ -1486,7 +1486,7 @@ async def edit(
         file: File = MISSING,
         files: list[File] = MISSING,
         attachments: list[Attachment] = MISSING,
-        view: View | None = MISSING,
+        view: BaseView | None = MISSING,
         allowed_mentions: AllowedMentions | None = None,
         delete_after: float | None = None,
         suppress: bool | None = MISSING,
@@ -1515,7 +1515,7 @@ async def edit(
         allowed_mentions: :class:`AllowedMentions`
             Controls the mentions being processed in this message.
             See :meth:`.abc.Messageable.send` for more information.
-        view: Optional[:class:`~discord.ui.View`]
+        view: Optional[:class:`~discord.ui.BaseView`]
             The updated view to update this message with. If ``None`` is passed then
             the view is removed.
         delete_after: Optional[:class:`float`]

discord/message.py

@@ -92,7 +92,7 @@
     from .types.snowflake import SnowflakeList
     from .types.threads import ThreadArchiveDuration
     from .types.user import User as UserPayload
-    from .ui.view import View
+    from .ui.view import BaseView
     from .user import User
 
     MR = TypeVar("MR", bound="MessageReference")
@@ -1660,7 +1660,7 @@ async def edit(
         suppress: bool = ...,
         delete_after: float | None = ...,
         allowed_mentions: AllowedMentions | None = ...,
-        view: View | None = ...,
+        view: BaseView | None = ...,
     ) -> Message: ...
 
     async def edit(
@@ -1674,7 +1674,7 @@ async def edit(
         suppress: bool = MISSING,
         delete_after: float | None = None,
         allowed_mentions: AllowedMentions | None = MISSING,
-        view: View | None = MISSING,
+        view: BaseView | None = MISSING,
     ) -> Message:
         """|coro|
 
@@ -1723,7 +1723,7 @@ async def edit(
             are used instead.
 
             .. versionadded:: 1.4
-        view: Optional[:class:`~discord.ui.View`]
+        view: Optional[:class:`~discord.ui.BaseView`]
             The updated view to update this message with. If ``None`` is passed then
             the view is removed.
 
@@ -2412,7 +2412,7 @@ async def edit(self, **fields: Any) -> Message | None:
             to the object, otherwise it uses the attributes set in :attr:`~discord.Client.allowed_mentions`.
             If no object is passed at all then the defaults given by :attr:`~discord.Client.allowed_mentions`
             are used instead.
-        view: Optional[:class:`~discord.ui.View`]
+        view: Optional[:class:`~discord.ui.BaseView`]
             The updated view to update this message with. If ``None`` is passed then
             the view is removed.
 

discord/state.py

@@ -71,7 +71,7 @@
 from .sticker import GuildSticker
 from .threads import Thread, ThreadMember
 from .ui.modal import Modal, ModalStore
-from .ui.view import View, ViewStore
+from .ui.view import BaseView, ViewStore
 from .user import ClientUser, User
 
 if TYPE_CHECKING:
@@ -399,17 +399,17 @@ def store_sticker(self, guild: Guild, data: GuildStickerPayload) -> GuildSticker
         self._stickers[sticker_id] = sticker = GuildSticker(state=self, data=data)
         return sticker
 
-    def store_view(self, view: View, message_id: int | None = None) -> None:
+    def store_view(self, view: BaseView, message_id: int | None = None) -> None:
         self._view_store.add_view(view, message_id)
 
     def store_modal(self, modal: Modal, message_id: int) -> None:
         self._modal_store.add_modal(modal, message_id)
 
-    def prevent_view_updates_for(self, message_id: int) -> View | None:
+    def prevent_view_updates_for(self, message_id: int) -> BaseView | None:
         return self._view_store.remove_message_tracking(message_id)
 
     @property
-    def persistent_views(self) -> Sequence[View]:
+    def persistent_views(self) -> Sequence[BaseView]:
         return self._view_store.persistent_views
 
     @property

discord/ui/action_row.py

@@ -21,11 +21,11 @@
     from ..emoji import AppEmoji, GuildEmoji
     from ..partial_emoji import PartialEmoji, _EmojiTag
     from ..types.components import ActionRow as ActionRowPayload
-    from .view import View
+    from .view import DesignerView
 
 
 A = TypeVar("A", bound="ActionRow")
-V = TypeVar("V", bound="View", covariant=True)
+V = TypeVar("V", bound="DesignerView", covariant=True)
 
 
 class ActionRow(Item[V]):

discord/ui/button.py

@@ -41,10 +41,10 @@
 
 if TYPE_CHECKING:
     from ..emoji import AppEmoji, GuildEmoji
-    from .view import View
+    from .view import BaseView
 
 B = TypeVar("B", bound="Button")
-V = TypeVar("V", bound="View", covariant=True)
+V = TypeVar("V", bound="BaseView", covariant=True)
 
 
 class Button(Item[V]):
@@ -298,7 +298,7 @@ def button(
     """A decorator that attaches a button to a component.
 
     The function being decorated should have three parameters, ``self`` representing
-    the :class:`discord.ui.View`, the :class:`discord.ui.Button` being pressed and
+    the :class:`discord.ui.View`, :class:`discord.ui.ActionRow` or :class:`discord.ui.Section`, the :class:`discord.ui.Button` being pressed, and
     the :class:`discord.Interaction` you receive.
 
     .. note::

discord/ui/container.py

@@ -25,11 +25,11 @@
     from typing_extensions import Self
 
     from ..types.components import ContainerComponent as ContainerComponentPayload
-    from .view import View
+    from .view import DesignerView
 
 
 C = TypeVar("C", bound="Container")
-V = TypeVar("V", bound="View", covariant=True)
+V = TypeVar("V", bound="DesignerView", covariant=True)
 
 
 class Container(Item[V]):

discord/ui/file.py

@@ -11,11 +11,11 @@
 
 if TYPE_CHECKING:
     from ..types.components import FileComponent as FileComponentPayload
-    from .view import View
+    from .view import DesignerView
 
 
 F = TypeVar("F", bound="File")
-V = TypeVar("V", bound="View", covariant=True)
+V = TypeVar("V", bound="DesignerView", covariant=True)
 
 
 class File(Item[V]):