feat: add ThreadAutoArchiveDuration enum (#2826)

Signed-off-by: BOXER <[email protected]>
Signed-off-by: Lala Sabathil <[email protected]>
Signed-off-by: Lala Sabathil <[email protected]>
Signed-off-by: Dorukyum <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Paillat <[email protected]>
Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: plun1331 <[email protected]>
Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: Lumouille <[email protected]>
Co-authored-by: Dorukyum <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 8 people

CHANGELOG.md

@@ -67,6 +67,8 @@ These changes are available on the `master` branch, but have not yet been releas
   ([#2817](https://github.com/Pycord-Development/pycord/pull/2817))
 - Added role gradients support with `Role.colours` and the `RoleColours` class.
   ([#2818](https://github.com/Pycord-Development/pycord/pull/2818))
+- Added `ThreadArchiveDuration` enum to improve clarity of thread archive durations.
+  ([#2826](https://github.com/Pycord-Development/pycord/pull/2826))
 - Added `Interaction.attachment_size_limit`.
   ([#2854](https://github.com/Pycord-Development/pycord/pull/2854))
 - Added support for selects and text displays in modals.

discord/channel.py

@@ -48,6 +48,9 @@
     InviteTarget,
     SortOrder,
     StagePrivacyLevel,
+)
+from .enums import ThreadArchiveDuration as ThreadArchiveDurationEnum
+from .enums import (
     VideoQualityMode,
     VoiceRegion,
     try_enum,
@@ -1097,7 +1100,9 @@ async def edit(
         sync_permissions: bool = ...,
         category: CategoryChannel | None = ...,
         slowmode_delay: int = ...,
-        default_auto_archive_duration: ThreadArchiveDuration = ...,
+        default_auto_archive_duration: (
+            ThreadArchiveDuration | ThreadArchiveDurationEnum
+        ) = ...,
         default_thread_slowmode_delay: int = ...,
         default_sort_order: SortOrder = ...,
         default_reaction_emoji: GuildEmoji | int | str | None = ...,
@@ -1143,6 +1148,7 @@ async def edit(self, *, reason=None, **options):
         default_auto_archive_duration: :class:`int`
             The new default auto archive duration in minutes for threads created in this channel.
             Must be one of ``60``, ``1440``, ``4320``, or ``10080``.
+            :class:`ThreadArchiveDuration` can be used alternatively.
         default_thread_slowmode_delay: :class:`int`
             The new default slowmode delay in seconds for threads created in this channel.
 

discord/enums.py

@@ -27,6 +27,7 @@
 
 import types
 from collections import namedtuple
+from enum import IntEnum
 from typing import TYPE_CHECKING, Any, ClassVar, TypeVar, Union
 
 __all__ = (
@@ -78,6 +79,7 @@
     "InteractionContextType",
     "PollLayoutType",
     "MessageReferenceType",
+    "ThreadArchiveDuration",
     "SubscriptionStatus",
     "SeparatorSpacingSize",
 )
@@ -1088,6 +1090,15 @@ class SubscriptionStatus(Enum):
     inactive = 2
 
 
+class ThreadArchiveDuration(IntEnum):
+    """The time set until a thread is automatically archived."""
+
+    one_hour = 60
+    one_day = 1440
+    three_days = 4320
+    one_week = 10080
+
+
 class SeparatorSpacingSize(Enum):
     """A separator component's spacing size."""
 

discord/threads.py

@@ -28,7 +28,13 @@
 from typing import TYPE_CHECKING, Callable, Iterable
 
 from .abc import Messageable, _purge_messages_helper
-from .enums import ChannelType, try_enum
+from .enums import (
+    ChannelType,
+)
+from .enums import ThreadArchiveDuration as ThreadArchiveDurationEnum
+from .enums import (
+    try_enum,
+)
 from .errors import ClientException
 from .flags import ChannelFlags
 from .mixins import Hashable
@@ -602,7 +608,9 @@ async def edit(
         locked: bool = MISSING,
         invitable: bool = MISSING,
         slowmode_delay: int = MISSING,
-        auto_archive_duration: ThreadArchiveDuration = MISSING,
+        auto_archive_duration: (
+            ThreadArchiveDuration | ThreadArchiveDurationEnum
+        ) = MISSING,
         pinned: bool = MISSING,
         applied_tags: list[ForumTag] = MISSING,
         reason: str | None = None,
@@ -632,6 +640,7 @@ async def edit(
         auto_archive_duration: :class:`int`
             The new duration in minutes before a thread is automatically archived for inactivity.
             Must be one of ``60``, ``1440``, ``4320``, or ``10080``.
+            :class:`ThreadArchiveDuration` can be used alternatively.
         slowmode_delay: :class:`int`
             Specifies the slowmode rate limit for user in this thread, in seconds.
             A value of ``0`` disables slowmode. The maximum value possible is ``21600``.

docs/api/enums.rst

@@ -2521,6 +2521,30 @@ of :class:`enum.Enum`.
         The subscription is inactive and the subscription owner is not being charged.
 
 
+
+.. class:: ThreadArchiveDuration
+
+    Represents the time before a thread is archived.
+
+    .. versionadded:: 2.7
+
+    .. attribute:: one_hour
+
+        Indicates that the thread will be archived after 1 hour of inactivity.
+
+    .. attribute:: one_day
+
+        Indicates that the thread will be archived after 1 day of inactivity.
+
+    .. attribute:: three_days
+
+        Indicates that the thread will be archived after 3 days of inactivity.
+
+    .. attribute:: one_week
+
+        Indicates that the thread will be archived after 1 week of inactivity.
+
+
 .. class:: SeparatorSpacingSize
 
     Represents the padding size around a separator component.