feat!: Rename suppress parameter to suppress_embeds everywhere and add suppress_notifications parameter.

Author: mccoderpy

discord/abc.py

@@ -26,10 +26,9 @@
 from __future__ import annotations
 
 import abc
-import sys
-import copy
 import asyncio
-
+import copy
+import sys
 from typing import (
     Any,
     List,
@@ -40,21 +39,21 @@
     TYPE_CHECKING
 )
 
-from .iterators import HistoryIterator
+from . import utils
 from .context_managers import Typing
-from .enums import try_enum, ChannelType, PermissionType
-from .errors import InvalidArgument, ClientException
+from .enums import ChannelType, PermissionType, try_enum
+from .errors import ClientException, InvalidArgument
+from .file import File
+from .http import handle_message_parameters
+from .invite import Invite
+from .iterators import HistoryIterator
 from .mentions import AllowedMentions
 from .permissions import PermissionOverwrite, Permissions
 from .role import Role
-from .invite import Invite
-from .file import File
 from .voice_client import VoiceClient, VoiceProtocol
-from .http import handle_message_parameters
-from . import utils
 
 if TYPE_CHECKING:
-    import datetime
+    from datetime import datetime
     from .embeds import Embed
     from .sticker import GuildSticker
     from .components import ActionRow, Button, BaseSelect
@@ -984,23 +983,25 @@ class Messageable(metaclass=abc.ABCMeta):
     async def _get_channel(self):
         raise NotImplementedError
 
-    async def send(self,
-                   content: Any = None,
-                   *,
-                   tts: bool = False,
-                   embed: Optional[Embed] = None,
-                   embeds: Optional[List[Embed]] = None,
-                   components: Optional[List[Union[ActionRow, List[Union[Button, BaseSelect]]]]] = None,
-                   file: Optional[File] = None,
-                   files: Optional[List[File]] = None,
-                   stickers: Optional[List[GuildSticker]] = None,
-                   delete_after: Optional[float] = None,
-                   nonce: Optional[int] = None,
-                   allowed_mentions: Optional[AllowedMentions] = None,
-                   reference: Optional[Union[Message, MessageReference]] = None,
-                   mention_author: Optional[bool] = None,
-                   supress_embeds: Optional[bool] = False
-                   ) -> Message:
+    async def send(
+            self,
+            content: Any = None,
+            *,
+            tts: bool = False,
+            embed: Optional[Embed] = None,
+            embeds: Optional[List[Embed]] = None,
+            components: Optional[List[Union[ActionRow, List[Union[Button, BaseSelect]]]]] = None,
+            file: Optional[File] = None,
+            files: Optional[List[File]] = None,
+            stickers: Optional[List[GuildSticker]] = None,
+            delete_after: Optional[float] = None,
+            nonce: Optional[int] = None,
+            allowed_mentions: Optional[AllowedMentions] = None,
+            reference: Optional[Union[Message, MessageReference]] = None,
+            mention_author: Optional[bool] = None,
+            suppress_embeds: bool = False,
+            suppress_notifications: bool = False
+    ) -> Message:
         """|coro|
 
         Sends a message to the destination with the content given.
@@ -1065,9 +1066,16 @@ async def send(self,
 
             .. versionadded:: 1.6
 
-        supress_embeds: Optional[:class:`bool`
+        suppress_embeds: :class:`bool`
             Whether to supress embeds send with the message, default to :obj:`False`
-
+        
+        suppress_notifications: :class:`bool`
+            Whether to suppress desktop- & push-notifications for this message, default to :obj:`False`
+            
+            Users will still see a ping-symbol when they are mentioned in the message, or the message is in a dm channel.
+            
+            .. versionadded:: 2.0
+            
         Raises
         --------
         ~discord.HTTPException
@@ -1104,9 +1112,10 @@ async def send(self,
         else:
             reference = MISSING
 
-        if supress_embeds:
+        if suppress_embeds or suppress_notifications:
             from .flags import MessageFlags
             flags = MessageFlags._from_value(4)
+            flags.suppress_notifications = suppress_notifications
         else:
             flags = MISSING
 
@@ -1220,13 +1229,15 @@ async def pins(self):
         data = await state.http.pins_from(channel.id)
         return [state.create_message(channel=channel, data=m) for m in data]
 
-    def history(self,
-                *,
-                limit: Optional[int] = 100,
-                before: Optional[Union[Snowflake, 'datetime.datetime']] = None,
-                after: Optional[Union[Snowflake, 'datetime.datetime']] = None,
-                around: Optional[Union[Snowflake, 'datetime.datetime']] = None,
-                oldest_first: Optional[bool] = None):
+    def history(
+            self,
+            *,
+            limit: Optional[int] = 100,
+            before: Optional[Union[Snowflake, datetime]] = None,
+            after: Optional[Union[Snowflake, datetime]] = None,
+            around: Optional[Union[Snowflake, datetime]] = None,
+            oldest_first: Optional[bool] = None
+    ):
         """Returns an :class:`~discord.AsyncIterator` that enables receiving the destination's message history.
 
         You must have :attr:`~Permissions.read_message_history` permissions to use this.
@@ -1264,7 +1275,7 @@ def history(self,
             Retrieve messages around this date or message.
             If a date is provided it must be a timezone-naive datetime representing UTC time.
             When using this argument, the maximum limit is 101. Note that if the limit is an
-            even number then this will return at most limit + 1 messages.
+            even number, then this will return at most limit + 1 messages.
         oldest_first: Optional[:class:`bool`]
             If set to ``True``, return messages in oldest->newest order. Defaults to ``True`` if
             ``after`` is specified, otherwise ``False``.

discord/application_commands.py

@@ -85,43 +85,32 @@ class Localizations:
     """
     Represents a :class:`dict` with localized values.
     These are used for application-commands, options and choices ``name_localizations`` and ``description_localizations``
-
-    +--------+-------------------------+---------------------+
-    | Locale |      Language Name      |     Native Name     |
-    |        | (lowercase also usable) |                     |
-    +========+=========================+=====================+
-    | da     | Danish                  | Dansk               |
-    | de     | German                  | Deutsch             |
-    | en_GB  | English, UK             | English, UK         |
-    | en_US  | English, US             | English, US         |
-    | es_ES  | Spanish                 | Español             |
-    | fr     | French                  | Français            |
-    | hr     | Croatian                | Hrvatski            |
-    | it     | Italian                 | Italiano            |
-    | lt     | Lithuanian              | Lietuviškai         |
-    | hu     | Hungarian               | Magyar              |
-    | nl     | Dutch                   | Nederlands          |
-    | no     | Norwegian               | Norsk               |
-    | pl     | Polish                  | Polski              |
-    | pt_BR  | Portuguese/Brazilian    | Português do Brasil |
-    | ro     | Romanian, Romania       | Română              |
-    | fi     | Finnish                 | Suomi               |
-    | sv_SE  | Swedish                 | Svenska             |
-    | vi     | Vietnamese              | Tiếng Việt          |
-    | tr     | Turkish                 | Türkçe              |
-    | cs     | Czech                   | Čeština             |
-    | el     | Greek                   | Ελληνικά            |
-    | bg     | Bulgarian               | български           |
-    | ru     | Russian                 | Pусский             |
-    | uk     | Ukrainian               | Українська          |
-    | hi     | Hindi                   | हिन्दी              |
-    | th     | Thai                    | ไทย                 |
-    | zh_CN  | Chinese, China          | 中文                  |
-    | ja     | Japanese                | 日本語                 |
-    | zh_TW  | Chinese, Taiwan         | 繁體中文                |
-    | ko     | Korean                  | 한국어                 |
-    +--------+-------------------------+---------------------+
-
+    
+    See :class:`~discord.Locale` for a list of available locals.
+    
+    Example
+    -------
+    
+    .. code-block:: python3
+        
+        Localizations(
+            en_US='Hello World!',
+            de='Hallo Welt!',
+            fr='Bonjour le monde!'
+            uk='Привіт світ!'
+        )
+    
+    Using the full language name is also possible.
+    
+    .. code-block:: python3
+    
+        Localizations(
+            english_us='Hello World!',
+            german='Hallo Welt!',
+            french='Bonjour le monde!'
+            ukrainian='Привіт світ!'
+        )
+    
     Parameters
     ----------
     kwargs: Any

discord/channel.py

@@ -25,34 +25,33 @@
 """
 from __future__ import annotations
 
+import asyncio
 import datetime
 import time
-import asyncio
-
 from typing import (
-    TYPE_CHECKING,
+    Any,
     Callable,
-    Union,
-    Optional,
-    Sequence,
     Coroutine,
+    Dict,
     List,
+    Optional,
+    Sequence,
     Tuple,
-    Dict,
-    Any
+    TYPE_CHECKING,
+    Union
 )
 
-from .permissions import Permissions, PermissionOverwrite
-from .enums import ChannelType, VoiceRegion, AutoArchiveDuration, PostSortOrder, try_enum
-from .components import Button, SelectMenu, ActionRow
-from .iterators import ThreadMemberIterator
-from .mixins import Hashable
-from . import utils, abc
-from .flags import ChannelFlags
+from . import abc, utils
 from .asset import Asset
-from .errors import ClientException, NoMoreItems, InvalidArgument, ThreadIsArchived
+from .components import ActionRow, BaseSelect, Button
+from .enums import AutoArchiveDuration, ChannelType, PostSortOrder, try_enum, VoiceRegion
+from .errors import ClientException, InvalidArgument, NoMoreItems, ThreadIsArchived
+from .flags import ChannelFlags, MessageFlags
 from .http import handle_message_parameters
+from .iterators import ThreadMemberIterator
+from .mixins import Hashable
 from .partial_emoji import PartialEmoji
+from .permissions import PermissionOverwrite, Permissions
 
 if TYPE_CHECKING:
     from .state import ConnectionState
@@ -1072,7 +1071,7 @@ async def remove_member(self, member: Union[Member, int]):
 
         return await self._state.http.remove_thread_member(channel_id=self.id, member_id=member_id)
 
-    async def fetch_members(
+    def fetch_members(
             self,
             limit: int = 100,
             after: Union[abc.Snowflake, datetime.datetime] = None,
@@ -1081,36 +1080,42 @@ async def fetch_members(
         """Returns a :class:`ThreadMemberIterator` that allows to retrieve the currently joined members of this thread.
 
         .. note::
-
-            This requires :func:`Intents.members` to be enabled and will also add the members retrieved to :attr:`members`
+            This requires the :func:`~Intents.members` intent to be enabled and will also add the members retrieved to :attr:`members`
         
         Examples
         ---------
-
+        
         Usage ::
-            
-            print(f"The thread {channel.name} has the following members:\n")
+
+            print(f"The thread {channel.name} has the following members:\\n")
             async for member in thread.fetch_members(limit=200):
                 print(member)
 
-        Flattening into a list: ::
+
+        Flattening into a list ::
 
             messages = await thread.fetch_members(limit=123).flatten()
             # messages is now a list of ThreadMember...
 
+
         All parameters are optional.
         
         Parameters
-        -----------
+        ----------
         limit: :class:`int`
             The limit of thread members to retrieve - defaults to 100
         after: Union[:class:`int`, :class:`datetime.datetime`]
             Get thread members after this user ID
         
+        Raises
+        ------
+        ~discord.ClientException
+            The :attr:`~Intents.members` intent is not enabled.
+        
         Yields
         -------
         :class:`~discord.ThreadMember`
-            The thread member
+            A member of this thread
         """
         if not self._state.intents.members:
             raise ClientException('You need to enable the GUILD_MEMBERS Intent to use this API-call.')
@@ -2831,21 +2836,19 @@ async def create_post(
             content: Any = None,
             embed: Optional[Embed] = None,
             embeds: Sequence[Embed] = None,
-            components: Optional[List[Union[ActionRow, List[Union[Button, SelectMenu]]]]] = None,
+            components: Optional[List[Union[ActionRow, List[Union[Button, BaseSelect]]]]] = None,
             file: Optional[File] = None,
             files: Sequence[File] = None,
             allowed_mentions: Optional[AllowedMentions] = None,
-            suppress: bool = False,
+            suppress_embeds: bool = False,
+            supress_notifications: bool = False,
             auto_archive_duration: Optional[AutoArchiveDuration] = None,
             slowmode_delay: int = 0,
             reason: Optional[str] = None
     ) -> ForumPost:
         """|coro|
 
-        Creates a new post in this forum.
-
-        You must have the :attr:`~Permissions.create_posts` permission to
-        use this.
+        Creates a new post in this forum. Requires the :attr:`~Permissions.create_posts` permission.
 
         Parameters
         -----------
@@ -2860,16 +2863,20 @@ async def create_post(
             A embed of the post starter-message.
         embeds: List[:class:`Embed`]
             A list of up to 10 embeds to include in the post starter-message.
-        components: List[Union[:class:`ActionRow`, List[Union[:class:`Button`, :class:`SelectMenu`]]]]
+        components: List[Union[:class:`ActionRow`, List[Union[:class:`Button`, :class:`BaseSelect`]]]]
             A list of components to include in the post starter-message.
         file: Optional[class:`File`]
             A file to include in the post starter-message.
         files: List[:class:`File`]
             A list of files to include in the post starter-message.
         allowed_mentions: Optional[:class:`AllowedMentions`]
             The allowed mentions for the post.
-        suppress: Optional[:class:`bool`]
+        suppress_embeds: Optional[:class:`bool`]
             Whether to suppress embeds in the post starter-message.
+        supress_notifications: Optional[:class:`bool`]
+            Whether to suppress desktop- & push-notifications for the post starter-message.
+            
+            Users will still see a ping-symbol when they are mentioned in the message, or the message is in a dm channel.
         auto_archive_duration: Optional[:class:`AutoArchiveDuration`]
             The duration after the post will be archived automatically when inactive.
         slowmode_delay: Optional[:class:`int`]
@@ -2895,10 +2902,10 @@ async def create_post(
         if self.flags.require_tags and not tags:
             raise InvalidArgument('This forum requires at least one tag provided when creating a post.')
 
-        if suppress:
-            from .message import MessageFlags
+        if suppress_embeds or supress_notifications:
             flags = MessageFlags._from_value(0)
-            flags.suppress_embeds = True
+            flags.suppress_embeds = suppress_embeds
+            flags.suppress_notifications = supress_notifications
         else:
             flags = MISSING
 
@@ -3060,4 +3067,4 @@ def _channel_factory(channel_type):
 def _check_channel_type(obj, types) -> bool:
     """Just something to check channel instances without circular imports."""
     types = tuple([_channel_factory(t)[0] for t in types])
-    return isinstance(obj, types)
+    return isinstance(obj, types)