♻️ update deprecated usage in versioning and interactions to use typing.deprecated

Author: Paillat-dev

discord/_version.py

@@ -36,7 +36,9 @@
 
 from typing import Literal, NamedTuple
 
-from .utils import deprecated
+from typing_extensions import deprecated
+
+from .utils import deprecated_message
 
 try:
     __version__ = version("py-cord")
@@ -84,27 +86,27 @@ def advanced(self, value: object) -> None:
         _advanced = value
 
     @property
-    @deprecated("releaselevel", "2.4")
+    @deprecated(deprecated_message("release_level", "releaselevel", "2.4"))
     def release_level(self) -> Literal["alpha", "beta", "candidate", "final"]:
         return self.releaselevel
 
     @property
-    @deprecated('.advanced["serial"]', "2.4")
+    @deprecated(deprecated_message("serial", '.advanced["serial"]', "2.4"))
     def serial(self) -> int:
         return self.advanced["serial"]
 
     @property
-    @deprecated('.advanced["build"]', "2.4")
+    @deprecated(deprecated_message("build", '.advanced["build"]', "2.4"))
     def build(self) -> int | None:
         return self.advanced["build"]
 
     @property
-    @deprecated('.advanced["commit"]', "2.4")
+    @deprecated(deprecated_message("commit", '.advanced["commit"]', "2.4"))
     def commit(self) -> str | None:
         return self.advanced["commit"]
 
     @property
-    @deprecated('.advanced["date"]', "2.4")
+    @deprecated(deprecated_message("date", '.advanced["date"]', "2.4"))
     def date(self) -> datetime.date | None:
         return self.advanced["date"]
 

discord/interactions.py

@@ -29,6 +29,8 @@
 import datetime
 from typing import TYPE_CHECKING, Any, Coroutine, Union
 
+from typing_extensions import deprecated
+
 from . import utils
 from .channel import ChannelType, PartialMessageable, _threaded_channel_factory
 from .enums import (
@@ -47,6 +49,7 @@
 from .object import Object
 from .permissions import Permissions
 from .user import User
+from .utils import deprecated_message
 from .webhook.async_ import (
     Webhook,
     WebhookMessage,
@@ -315,7 +318,10 @@ def is_component(self) -> bool:
         return self.type == InteractionType.component
 
     @utils.cached_slot_property("_cs_channel")
-    @utils.deprecated("Interaction.channel", "2.7", stacklevel=4)
+    @deprecated(
+        deprecated_message("Interaction.cached_channel", "Interaction.channel", "2.7"),
+        stacklevel=2,
+    )
     def cached_channel(self) -> InteractionChannel | None:
         """The cached channel from which the interaction was sent.
         DM channels are not resolved. These are :class:`PartialMessageable` instead.
@@ -457,7 +463,11 @@ async def original_response(self) -> InteractionMessage:
         self._original_response = message
         return message
 
-    @utils.deprecated("Interaction.original_response", "2.2")
+    @deprecated(
+        deprecated_message(
+            "Interaction.original_message", "Interaction.original_response", "2.2"
+        )
+    )
     async def original_message(self):
         """An alias for :meth:`original_response`.
 
@@ -584,7 +594,13 @@ async def edit_original_response(
 
         return message
 
-    @utils.deprecated("Interaction.edit_original_response", "2.2")
+    @deprecated(
+        deprecated_message(
+            "Interaction.edit_original_message",
+            "Interaction.edit_original_response",
+            "2.2",
+        )
+    )
     async def edit_original_message(self, **kwargs):
         """An alias for :meth:`edit_original_response`.
 
@@ -642,7 +658,13 @@ async def delete_original_response(self, *, delay: float | None = None) -> None:
         else:
             await func
 
-    @utils.deprecated("Interaction.delete_original_response", "2.2")
+    @deprecated(
+        deprecated_message(
+            "Interaction.delete_original_message",
+            "Interaction.delete_original_response",
+            "2.2",
+        )
+    )
     async def delete_original_message(self, **kwargs):
         """An alias for :meth:`delete_original_response`.
 
@@ -1288,7 +1310,13 @@ async def send_modal(self, modal: Modal) -> Interaction:
         self._parent._state.store_modal(modal, self._parent.user.id)
         return self._parent
 
-    @utils.deprecated("a button with type ButtonType.premium", "2.6")
+    @deprecated(
+        deprecated_message(
+            "InteractionResponse.premium_required",
+            "a button with type ButtonType.premium",
+            "2.6",
+        )
+    )
     async def premium_required(self) -> Interaction:
         """|coro|
 

discord/utils.py

@@ -75,7 +75,7 @@
 __all__ = (
     "parse_time",
     "warn_deprecated",
-    "deprecated",
+    "deprecated_message",
     "oauth_url",
     "snowflake_time",
     "time_snowflake",
@@ -283,6 +283,40 @@ def decorator(overridden: T) -> T:
     return decorator
 
 
+def deprecated_message(
+    name: str,
+    instead: str | None = None,
+    since: str | None = None,
+    removed: str | None = None,
+    reference: str | None = None,
+) -> str:
+    """
+    Generates a deprecation message, with the ability to specify details about the deprecation.
+
+    Parameters
+    ----------
+    name
+    instead
+    since
+    removed
+    reference
+
+    Returns
+    -------
+    """
+    message = f"{name} is deprecated"
+    if since:
+        message += f" since version {since}"
+    if removed:
+        message += f" and will be removed in version {removed}"
+    if instead:
+        message += f", consider using {instead} instead"
+    message += "."
+    if reference:
+        message += f" See {reference} for more information."
+    return message
+
+
 def warn_deprecated(
     name: str,
     instead: str | None = None,
@@ -313,16 +347,13 @@ def warn_deprecated(
         The stacklevel kwarg passed to :func:`warnings.warn`. Defaults to 3.
     """
     warnings.simplefilter("always", DeprecationWarning)  # turn off filter
-    message = f"{name} is deprecated"
-    if since:
-        message += f" since version {since}"
-    if removed:
-        message += f" and will be removed in version {removed}"
-    if instead:
-        message += f", consider using {instead} instead"
-    message += "."
-    if reference:
-        message += f" See {reference} for more information."
+    message = deprecated_message(
+        name=name,
+        instead=instead,
+        since=since,
+        removed=removed,
+        reference=reference,
+    )
 
     warnings.warn(message, stacklevel=stacklevel, category=DeprecationWarning)
     warnings.simplefilter("default", DeprecationWarning)  # reset filter