Merge pull request #441 from BobDotCom/timeout

baseholder implementation for timeouts

Author: Lulalaby

discord/member.py

@@ -252,6 +252,10 @@ class Member(discord.abc.Messageable, _UserTag):
     premium_since: Optional[:class:`datetime.datetime`]
         An aware datetime object that specifies the date and time in UTC when the member used their
         "Nitro boost" on the guild, if available. This could be ``None``.
+    communication_disabled_until: Optional[:class:`datetime.datetime`]
+        An aware datetime object that specifies the date and time in UTC when the member will be removed from timeout.
+
+        .. versionadded:: 2.0
     """
 
     __slots__ = (
@@ -266,6 +270,7 @@ class Member(discord.abc.Messageable, _UserTag):
         '_user',
         '_state',
         '_avatar',
+        'communication_disabled_until',
     )
 
     if TYPE_CHECKING:
@@ -284,6 +289,7 @@ class Member(discord.abc.Messageable, _UserTag):
         banner: Optional[Asset]
         accent_color: Optional[Colour]
         accent_colour: Optional[Colour]
+        communication_disabled_until: Optional[datetime.datetime]
 
     def __init__(self, *, data: MemberWithUserPayload, guild: Guild, state: ConnectionState):
         self._state: ConnectionState = state
@@ -297,6 +303,7 @@ def __init__(self, *, data: MemberWithUserPayload, guild: Guild, state: Connecti
         self.nick: Optional[str] = data.get('nick', None)
         self.pending: bool = data.get('pending', False)
         self._avatar: Optional[str] = data.get('avatar')
+        self.communication_disabled_until: Optional[datetime.datetime] = utils.parse_time(data.get('communication_disabled_until'))
 
     def __str__(self) -> str:
         return str(self._user)
@@ -354,6 +361,7 @@ def _copy(cls: Type[M], member: M) -> M:
         self.activities = member.activities
         self._state = member._state
         self._avatar = member._avatar
+        self.communication_disabled_until = member.communication_disabled_until
 
         # Reference will not be copied unless necessary by PRESENCE_UPDATE
         # See below
@@ -380,6 +388,7 @@ def _update(self, data: MemberPayload) -> None:
         self.premium_since = utils.parse_time(data.get('premium_since'))
         self._roles = utils.SnowflakeList(map(int, data['roles']))
         self._avatar = data.get('avatar')
+        self.communication_disabled_until = utils.parse_time(data.get('communication_disabled_until'))
 
     def _presence_update(self, data: PartialPresenceUpdate, user: UserPayload) -> Optional[Tuple[User, User]]:
         self.activities = tuple(map(create_activity, data['activities']))
@@ -645,26 +654,29 @@ async def edit(
         roles: List[discord.abc.Snowflake] = MISSING,
         voice_channel: Optional[VocalGuildChannel] = MISSING,
         reason: Optional[str] = None,
+        communication_disabled_until: Optional[datetime.datetime] = MISSING,
     ) -> Optional[Member]:
         """|coro|
 
         Edits the member's data.
 
         Depending on the parameter passed, this requires different permissions listed below:
 
-        +---------------+--------------------------------------+
-        |   Parameter   |              Permission              |
-        +---------------+--------------------------------------+
-        | nick          | :attr:`Permissions.manage_nicknames` |
-        +---------------+--------------------------------------+
-        | mute          | :attr:`Permissions.mute_members`     |
-        +---------------+--------------------------------------+
-        | deafen        | :attr:`Permissions.deafen_members`   |
-        +---------------+--------------------------------------+
-        | roles         | :attr:`Permissions.manage_roles`     |
-        +---------------+--------------------------------------+
-        | voice_channel | :attr:`Permissions.move_members`     |
-        +---------------+--------------------------------------+
+        +------------------------------+--------------------------------------+
+        |   Parameter                  |              Permission              |
+        +------------------------------+--------------------------------------+
+        | nick                         | :attr:`Permissions.manage_nicknames` |
+        +------------------------------+--------------------------------------+
+        | mute                         | :attr:`Permissions.mute_members`     |
+        +------------------------------+--------------------------------------+
+        | deafen                       | :attr:`Permissions.deafen_members`   |
+        +------------------------------+--------------------------------------+
+        | roles                        | :attr:`Permissions.manage_roles`     |
+        +------------------------------+--------------------------------------+
+        | voice_channel                | :attr:`Permissions.move_members`     |
+        +------------------------------+--------------------------------------+
+        | communication_disabled_until | :attr:`Permissions.manage_members`   |
+        +------------------------------+--------------------------------------+
 
         All parameters are optional.
 
@@ -694,7 +706,11 @@ async def edit(
             Pass ``None`` to kick them from voice.
         reason: Optional[:class:`str`]
             The reason for editing this member. Shows up on the audit log.
+        communication_disabled_until: Optional[:class:`datetime.datetime`]
+            Temporarily puts the member in timeout until this time. If the value is ``None``, then the user is removed
+            from timeout.
 
+            .. versionadded:: 2.0
         Raises
         -------
         Forbidden
@@ -748,10 +764,64 @@ async def edit(
         if roles is not MISSING:
             payload['roles'] = tuple(r.id for r in roles)
 
+        if communication_disabled_until is not MISSING:
+            if communication_disabled_until is not None:
+                payload['communication_disabled_until'] = communication_disabled_until.isoformat()
+            else:
+                payload['communication_disabled_until'] = communication_disabled_until
+
         if payload:
             data = await http.edit_member(guild_id, self.id, reason=reason, **payload)
             return Member(data=data, guild=self.guild, state=self._state)
 
+    async def timeout(self, until: Optional[datetime.datetime], reason: str = None) -> None:
+        """|coro|
+
+        Timeouts a member from the guild for the set duration.
+
+        You must have the :attr:`~Permissions.manage_members` permission to
+        timeout a member.
+
+        Parameters
+        -----------
+        until: :class:`datetime.datetime`
+            The date and time to timeout the member for. If this is ``None`` then the member is removed from timeout.
+        reason: Optional[:class:`str`]
+            The reason for doing this action. Shows up on the audit log.
+
+        Raises
+        -------
+        Forbidden
+            You do not have permissions to timeout members.
+        HTTPException
+            An error occurred doing the request.
+        """
+        await self.edit(communication_disabled_until=until, reason=reason)
+
+    async def remove_timeout(self, reason: str = None) -> None:
+        """|coro|
+
+        Removes the timeout from a member.
+
+        You must have the :attr:`~Permissions.manage_members` permission to
+        remove the timeout.
+
+        This is equivalent to calling :meth:`~.timeout` and passing ``None`` to :param:`~.timeout.until`.
+
+        Parameters
+        -----------
+        reason: Optional[:class:`str`]
+            The reason for doing this action. Shows up on the audit log.
+
+        Raises
+        -------
+        Forbidden
+            You do not have permissions to remove the timeout.
+        HTTPException
+            An error occurred doing the request.
+        """
+        await self.edit(communication_disabled_until=None, reason=reason)
+
     async def request_to_speak(self) -> None:
         """|coro|
 

discord/types/member.py

@@ -46,6 +46,7 @@ class Member(PartialMember, total=False):
     premium_since: str
     pending: bool
     permissions: str
+    communication_disabled_until: str
 
 
 class _OptionalMemberWithUser(PartialMember, total=False):