♻️ move copy_doc to private

Author: Paillat-dev

discord/channel.py

@@ -30,7 +30,7 @@
 
 import discord.abc
 
-from .utils.private import bytes_to_base64_data, get_as_snowflake
+from .utils.private import bytes_to_base64_data, get_as_snowflake, copy_doc
 from . import utils
 from .asset import Asset
 from .emoji import GuildEmoji
@@ -244,7 +244,7 @@ def type(self) -> ChannelType:
     def _sorting_bucket(self) -> int:
         return ChannelType.text.value
 
-    @utils.copy_doc(discord.abc.GuildChannel.permissions_for)
+    @copy_doc(discord.abc.GuildChannel.permissions_for)
     def permissions_for(self, obj: Member | Role, /) -> Permissions:
         base = super().permissions_for(obj)
 
@@ -295,7 +295,7 @@ async def edit(self, **options) -> _TextChannel:
         """Edits the channel."""
         raise NotImplementedError
 
-    @utils.copy_doc(discord.abc.GuildChannel.clone)
+    @copy_doc(discord.abc.GuildChannel.clone)
     async def clone(self, *, name: str | None = None, reason: str | None = None) -> TextChannel:
         return await self._clone_impl(
             {
@@ -1581,7 +1581,7 @@ def voice_states(self) -> dict[int, VoiceState]:
             if value.channel and value.channel.id == self.id
         }
 
-    @utils.copy_doc(discord.abc.GuildChannel.permissions_for)
+    @copy_doc(discord.abc.GuildChannel.permissions_for)
     def permissions_for(self, obj: Member | Role, /) -> Permissions:
         base = super().permissions_for(obj)
 
@@ -1945,7 +1945,7 @@ def type(self) -> ChannelType:
         """The channel's Discord type."""
         return ChannelType.voice
 
-    @utils.copy_doc(discord.abc.GuildChannel.clone)
+    @copy_doc(discord.abc.GuildChannel.clone)
     async def clone(self, *, name: str | None = None, reason: str | None = None) -> VoiceChannel:
         return await self._clone_impl(
             {"bitrate": self.bitrate, "user_limit": self.user_limit},
@@ -2481,7 +2481,7 @@ def type(self) -> ChannelType:
         """The channel's Discord type."""
         return ChannelType.stage_voice
 
-    @utils.copy_doc(discord.abc.GuildChannel.clone)
+    @copy_doc(discord.abc.GuildChannel.clone)
     async def clone(self, *, name: str | None = None, reason: str | None = None) -> StageChannel:
         return await self._clone_impl({}, name=name, reason=reason)
 
@@ -2744,7 +2744,7 @@ def is_nsfw(self) -> bool:
         """Checks if the category is NSFW."""
         return self.nsfw
 
-    @utils.copy_doc(discord.abc.GuildChannel.clone)
+    @copy_doc(discord.abc.GuildChannel.clone)
     async def clone(self, *, name: str | None = None, reason: str | None = None) -> CategoryChannel:
         return await self._clone_impl({"nsfw": self.nsfw}, name=name, reason=reason)
 
@@ -2810,7 +2810,7 @@ async def edit(self, *, reason=None, **options):
             # the payload will always be the proper channel payload
             return self.__class__(state=self._state, guild=self.guild, data=payload)  # type: ignore
 
-    @utils.copy_doc(discord.abc.GuildChannel.move)
+    @copy_doc(discord.abc.GuildChannel.move)
     async def move(self, **kwargs):
         kwargs.pop("category", None)
         await super().move(**kwargs)

discord/commands/context.py

@@ -54,6 +54,7 @@
     from typing import Callable, Awaitable
 
 from ..utils import cached_property
+from ..utils.private import copy_doc
 
 T = TypeVar("T")
 CogT = TypeVar("CogT", bound="Cog")
@@ -258,17 +259,17 @@ def unselected_options(self) -> list[Option] | None:
         return None
 
     @property
-    @discord.utils.copy_doc(InteractionResponse.send_modal)
+    @copy_doc.copy_doc(InteractionResponse.send_modal)
     def send_modal(self) -> Callable[..., Awaitable[Interaction]]:
         return self.interaction.response.send_modal
 
     @property
-    @discord.utils.copy_doc(Interaction.respond)
+    @copy_doc.copy_doc(Interaction.respond)
     def respond(self, *args, **kwargs) -> Callable[..., Awaitable[Interaction | WebhookMessage]]:
         return self.interaction.respond
 
     @property
-    @discord.utils.copy_doc(InteractionResponse.send_message)
+    @copy_doc.copy_doc(InteractionResponse.send_message)
     def send_response(self) -> Callable[..., Awaitable[Interaction]]:
         if not self.interaction.response.is_done():
             return self.interaction.response.send_message
@@ -278,7 +279,7 @@ def send_response(self) -> Callable[..., Awaitable[Interaction]]:
             )
 
     @property
-    @discord.utils.copy_doc(Webhook.send)
+    @copy_doc.copy_doc(Webhook.send)
     def send_followup(self) -> Callable[..., Awaitable[WebhookMessage]]:
         if self.interaction.response.is_done():
             return self.followup.send
@@ -288,7 +289,7 @@ def send_followup(self) -> Callable[..., Awaitable[WebhookMessage]]:
             )
 
     @property
-    @discord.utils.copy_doc(InteractionResponse.defer)
+    @copy_doc.copy_doc(InteractionResponse.defer)
     def defer(self) -> Callable[..., Awaitable[None]]:
         return self.interaction.response.defer
 
@@ -322,7 +323,7 @@ async def delete(self, *, delay: float | None = None) -> None:
         return await self.interaction.delete_original_response(delay=delay)
 
     @property
-    @discord.utils.copy_doc(Interaction.edit_original_response)
+    @copy_doc.copy_doc(Interaction.edit_original_response)
     def edit(self) -> Callable[..., Awaitable[InteractionMessage]]:
         return self.interaction.edit_original_response
 

discord/ext/commands/bot.py

@@ -133,7 +133,7 @@ def __init__(
         self.help_command = DefaultHelpCommand() if help_command is MISSING else help_command
         self.strip_after_prefix = options.get("strip_after_prefix", False)
 
-    @discord.utils.copy_doc(discord.Client.close)
+    @discord.utils.private.copy_doc(discord.Client.close)
     async def close(self) -> None:
         for extension in tuple(self.__extensions):
             try:

discord/ext/commands/context.py

@@ -32,6 +32,7 @@
 import discord.abc
 import discord.utils
 from discord.message import Message
+from discord.utils.private import copy_doc
 
 if TYPE_CHECKING:
     from typing_extensions import ParamSpec
@@ -398,10 +399,10 @@ async def send_help(self, *args: Any) -> Any:
         except CommandError as e:
             await cmd.on_help_command_error(self, e)
 
-    @discord.utils.copy_doc(Message.reply)
+    @copy_doc(Message.reply)
     async def reply(self, content: str | None = None, **kwargs: Any) -> Message:
         return await self.message.reply(content, **kwargs)
 
-    @discord.utils.copy_doc(Message.forward_to)
+    @copy_doc(Message.forward_to)
     async def forward_to(self, channel: discord.abc.Messageable, **kwargs: Any) -> Message:
         return await self.message.forward_to(channel, **kwargs)

discord/member.py

@@ -34,7 +34,6 @@
 
 import discord.abc
 
-
 from . import utils
 from .activity import ActivityTypes, create_activity
 from .asset import Asset
@@ -45,7 +44,7 @@
 from .permissions import Permissions
 from .user import BaseUser, User, _UserTag
 from .utils import MISSING
-from .utils.private import parse_time, SnowflakeList
+from .utils.private import parse_time, SnowflakeList, copy_doc
 
 __all__ = (
     "VoiceState",
@@ -202,7 +201,7 @@ def general(self, *args, **kwargs):
                 return general
 
             func = generate_function(attr)
-            func = utils.copy_doc(value)(func)
+            func = copy_doc(value)(func)
             setattr(cls, attr, func)
 
     return cls

discord/utils/__init__.py

@@ -27,14 +27,12 @@
 
 import collections.abc
 import json
-from inspect import signature as _signature
 from typing import (
     TYPE_CHECKING,
     Any,
     AsyncIterator,
     Callable,
     Generic,
-    Iterable,
     Iterator,
     Mapping,
     Protocol,
@@ -202,15 +200,6 @@ def count(self, value: Any) -> int:
         return self.__proxied.count(value)
 
 
-def copy_doc(original: Callable) -> Callable[[T], T]:
-    def decorator(overridden: T) -> T:
-        overridden.__doc__ = original.__doc__
-        overridden.__signature__ = _signature(original)  # type: ignore
-        return overridden
-
-    return decorator
-
-
 async def get_or_fetch(obj, attr: str, id: int, *, default: Any = MISSING) -> Any:
     """|coro|
 

discord/utils/private.py

@@ -11,7 +11,7 @@
 import warnings
 from _bisect import bisect_left
 from base64 import b64encode
-from inspect import isawaitable
+from inspect import isawaitable, signature
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -447,3 +447,12 @@ def get(self, element: int) -> int | None:
     def has(self, element: int) -> bool:
         i = bisect_left(self, element)
         return i != len(self) and self[i] == element
+
+
+def copy_doc(original: Callable) -> Callable[[T], T]:
+    def decorator(overridden: T) -> T:
+        overridden.__doc__ = original.__doc__
+        overridden.__signature__ = signature(original)  # type: ignore
+        return overridden
+
+    return decorator

tests/test_utils.py

@@ -31,7 +31,6 @@
 from discord.utils import (
     MISSING,
     _cached_property,
-    copy_doc,
     find,
     generate_snowflake,
     get,