feat: Replaced useless cached_property with property and moved to functools.cached_property (#2769)

* feat: Replaced useless `cached_property` with `property` and moved to `functools.cached_property`

* style(pre-commit): auto fixes from pre-commit.com hooks

* chore: switch to `functools.cached_property` for intensive code

* style(pre-commit): auto fixes from pre-commit.com hooks

* Update context.py

Signed-off-by: Paillat <[email protected]>

---------

Signed-off-by: Paillat <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Paillat <[email protected]>

Author: 3 people

discord/audit_logs.py

@@ -602,12 +602,12 @@ def _get_member(self, user_id: int) -> Member | User | None:
     def __repr__(self) -> str:
         return f"<AuditLogEntry id={self.id} action={self.action} user={self.user!r}>"
 
-    @utils.cached_property
+    @property
     def created_at(self) -> datetime.datetime:
         """Returns the entry's creation time in UTC."""
         return utils.snowflake_time(self.id)
 
-    @utils.cached_property
+    @property
     def target(
         self,
     ) -> (
@@ -631,24 +631,24 @@ def target(
         else:
             return converter(self._target_id)
 
-    @utils.cached_property
+    @property
     def category(self) -> enums.AuditLogActionCategory:
         """The category of the action, if applicable."""
         return self.action.category
 
-    @utils.cached_property
+    @property
     def changes(self) -> AuditLogChanges:
         """The list of changes this entry has."""
         obj = AuditLogChanges(self, self._changes, state=self._state)
         del self._changes
         return obj
 
-    @utils.cached_property
+    @property
     def before(self) -> AuditLogDiff:
         """The target's prior state."""
         return self.changes.before
 
-    @utils.cached_property
+    @property
     def after(self) -> AuditLogDiff:
         """The target's subsequent state."""
         return self.changes.after

discord/automod.py

@@ -416,12 +416,12 @@ def __repr__(self) -> str:
     def __str__(self) -> str:
         return self.name
 
-    @cached_property
+    @property
     def guild(self) -> Guild | None:
         """The guild this rule belongs to."""
         return self._state._get_guild(self.guild_id)
 
-    @cached_property
+    @property
     def creator(self) -> Member | None:
         """The member who created this rule."""
         if self.guild is None:

discord/commands/context.py

@@ -32,28 +32,25 @@
 from discord.webhook.async_ import Webhook
 
 if TYPE_CHECKING:
+    from typing import Awaitable, Callable
+
     from typing_extensions import ParamSpec
 
     import discord
-    from .. import Bot
-    from ..state import ConnectionState
-    from ..voice_client import VoiceClient
 
-    from .core import ApplicationCommand, Option
-    from ..interactions import InteractionChannel
+    from .. import Bot
+    from ..client import ClientUser
+    from ..cog import Cog
     from ..guild import Guild
+    from ..interactions import InteractionChannel
     from ..member import Member
     from ..message import Message
-    from ..user import User
     from ..permissions import Permissions
-    from ..client import ClientUser
-
-    from ..cog import Cog
+    from ..state import ConnectionState
+    from ..user import User
+    from ..voice_client import VoiceClient
     from ..webhook import WebhookMessage
-
-    from typing import Callable, Awaitable
-
-from ..utils import cached_property
+    from .core import ApplicationCommand, Option
 
 T = TypeVar("T")
 CogT = TypeVar("CogT", bound="Cog")
@@ -142,53 +139,53 @@ def command(self) -> ApplicationCommand | None:
     def command(self, value: ApplicationCommand | None) -> None:
         self.interaction.command = value
 
-    @cached_property
+    @property
     def channel(self) -> InteractionChannel | None:
         """Union[:class:`abc.GuildChannel`, :class:`PartialMessageable`, :class:`Thread`]:
         Returns the channel associated with this context's command. Shorthand for :attr:`.Interaction.channel`.
         """
         return self.interaction.channel
 
-    @cached_property
+    @property
     def channel_id(self) -> int | None:
         """Returns the ID of the channel associated with this context's command.
         Shorthand for :attr:`.Interaction.channel_id`.
         """
         return self.interaction.channel_id
 
-    @cached_property
+    @property
     def guild(self) -> Guild | None:
         """Returns the guild associated with this context's command.
         Shorthand for :attr:`.Interaction.guild`.
         """
         return self.interaction.guild
 
-    @cached_property
+    @property
     def guild_id(self) -> int | None:
         """Returns the ID of the guild associated with this context's command.
         Shorthand for :attr:`.Interaction.guild_id`.
         """
         return self.interaction.guild_id
 
-    @cached_property
+    @property
     def locale(self) -> str | None:
         """Returns the locale of the guild associated with this context's command.
         Shorthand for :attr:`.Interaction.locale`.
         """
         return self.interaction.locale
 
-    @cached_property
+    @property
     def guild_locale(self) -> str | None:
         """Returns the locale of the guild associated with this context's command.
         Shorthand for :attr:`.Interaction.guild_locale`.
         """
         return self.interaction.guild_locale
 
-    @cached_property
+    @property
     def app_permissions(self) -> Permissions:
         return self.interaction.app_permissions
 
-    @cached_property
+    @property
     def me(self) -> Member | ClientUser | None:
         """Union[:class:`.Member`, :class:`.ClientUser`]:
         Similar to :attr:`.Guild.me` except it may return the :class:`.ClientUser` in private message
@@ -200,14 +197,14 @@ def me(self) -> Member | ClientUser | None:
             else self.bot.user
         )
 
-    @cached_property
+    @property
     def message(self) -> Message | None:
         """Returns the message sent with this context's command.
         Shorthand for :attr:`.Interaction.message`, if applicable.
         """
         return self.interaction.message
 
-    @cached_property
+    @property
     def user(self) -> Member | User:
         """Returns the user that sent this context's command.
         Shorthand for :attr:`.Interaction.user`.
@@ -226,7 +223,7 @@ def voice_client(self) -> VoiceClient | None:
 
         return self.interaction.guild.voice_client
 
-    @cached_property
+    @property
     def response(self) -> InteractionResponse:
         """Returns the response object associated with this context's command.
         Shorthand for :attr:`.Interaction.response`.
@@ -268,7 +265,7 @@ def unselected_options(self) -> list[Option] | None:
                 return self.command.options  # type: ignore
         return None
 
-    @cached_property
+    @property
     def attachment_size_limit(self) -> int:
         """Returns the attachment size limit associated with this context's interaction.
         Shorthand for :attr:`.Interaction.attachment_size_limit`.

discord/ext/commands/context.py

@@ -283,28 +283,28 @@ def cog(self) -> Cog | None:
             return None
         return self.command.cog
 
-    @discord.utils.cached_property
+    @property
     def guild(self) -> Guild | None:
         """Returns the guild associated with this context's command.
         None if not available.
         """
         return self.message.guild
 
-    @discord.utils.cached_property
+    @property
     def channel(self) -> MessageableChannel:
         """Returns the channel associated with this context's command.
         Shorthand for :attr:`.Message.channel`.
         """
         return self.message.channel
 
-    @discord.utils.cached_property
+    @property
     def author(self) -> User | Member:
         """Union[:class:`~discord.User`, :class:`.Member`]:
         Returns the author associated with this context's command. Shorthand for :attr:`.Message.author`
         """
         return self.message.author
 
-    @discord.utils.cached_property
+    @property
     def me(self) -> Member | ClientUser:
         """Union[:class:`.Member`, :class:`.ClientUser`]:
         Similar to :attr:`.Guild.me` except it may return the :class:`.ClientUser` in private message

discord/onboarding.py

@@ -24,11 +24,12 @@
 
 from __future__ import annotations
 
+from functools import cached_property
 from typing import TYPE_CHECKING, Any
 
 from .enums import OnboardingMode, PromptType, try_enum
 from .partial_emoji import PartialEmoji
-from .utils import MISSING, cached_property, generate_snowflake, get
+from .utils import MISSING, generate_snowflake, get
 
 if TYPE_CHECKING:
     from .abc import Snowflake

discord/poll.py

@@ -25,6 +25,7 @@
 from __future__ import annotations
 
 import datetime
+from functools import cached_property
 from typing import TYPE_CHECKING, Any
 
 from . import utils
@@ -358,7 +359,7 @@ def __init__(
         self._expiry = None
         self._message = None
 
-    @utils.cached_property
+    @cached_property
     def expiry(self) -> datetime.datetime | None:
         """An aware datetime object that specifies the date and time in UTC when the poll will end."""
         return utils.parse_time(self._expiry)

discord/utils.py

@@ -125,22 +125,6 @@ def __repr__(self) -> str:
 
 MISSING: Any = _MissingSentinel()
 
-
-class _cached_property:
-    def __init__(self, function):
-        self.function = function
-        self.__doc__ = getattr(function, "__doc__")
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return self
-
-        value = self.function(instance)
-        setattr(instance, self.function.__name__, value)
-
-        return value
-
-
 if TYPE_CHECKING:
     from typing_extensions import ParamSpec
 
@@ -154,12 +138,9 @@ def __get__(self, instance, owner):
     class _RequestLike(Protocol):
         headers: Mapping[str, Any]
 
-    cached_property = property
-
     P = ParamSpec("P")
 
 else:
-    cached_property = _cached_property
     AutocompleteContext = Any
     OptionChoice = Any
 

tests/test_utils.py

@@ -30,7 +30,6 @@
 
 from discord.utils import (
     MISSING,
-    _cached_property,
     _parse_ratelimit_header,
     _unique,
     async_all,
@@ -80,22 +79,6 @@ def test_temporary():
 #     assert repr(MISSING) == '...'
 #
 #
-# def test_cached_property() -> None:
-#     class Test:
-#         def __init__(self, x: int):
-#             self.x = x
-#
-#         @_cached_property
-#         def foo(self) -> int:
-#             self.x += 1
-#             return self.x
-#
-#     t = Test(0)
-#     assert isinstance(_cached_property.__get__(_cached_property(None), None, None), _cached_property)
-#     assert t.foo == 1
-#     assert t.foo == 1
-#
-#
 # def test_find_get() -> None:
 #     class Obj:
 #         def __init__(self, value: int):