Merge pull request #537 from Dorukyum/format

Format

Author: Lulalaby

.github/CONTRIBUTING.md

@@ -26,7 +26,7 @@ Please be aware of the following things when filing bug reports.
     - Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot provide a code snippet, then let us know what the steps were, how often it happens, etc.
     - Tell us **what you expected to happen**. That way we can meet that expectation.
     - Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say *how* it failed, do you get an exception? Does it hang? How are the expectations different from reality?
-    - Tell us **information about your environment**. What version of discord.py are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use.
+    - Tell us **information about your environment**. What version of Pycord are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use.
 
 If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed.
 

discord/__main__.py

@@ -286,7 +286,7 @@ def add_newcog_args(subparser: argparse._SubParsersAction) -> None:
     parser.add_argument('--full', help='add all special methods as well', action='store_true')
 
 def parse_args() -> Tuple[argparse.ArgumentParser, argparse.Namespace]:
-    parser = argparse.ArgumentParser(prog='discord', description='Tools for helping with discord.py')
+    parser = argparse.ArgumentParser(prog='discord', description='Tools for helping with Pycord')
     parser.add_argument('-v', '--version', action='store_true', help='shows the library version')
     parser.set_defaults(func=core)
 

discord/client.py

@@ -361,7 +361,7 @@ async def _run_event(self, coro: Callable[..., Coroutine[Any, Any, Any]], event_
     def _schedule_event(self, coro: Callable[..., Coroutine[Any, Any, Any]], event_name: str, *args: Any, **kwargs: Any) -> asyncio.Task:
         wrapped = self._run_event(coro, event_name, *args, **kwargs)
         # Schedules the task
-        return asyncio.create_task(wrapped, name=f'discord.py: {event_name}')
+        return asyncio.create_task(wrapped, name=f'pycord: {event_name}')
 
     def dispatch(self, event: str, *args: Any, **kwargs: Any) -> None:
         _log.debug('Dispatching event %s', event)

discord/gateway.py

@@ -376,8 +376,8 @@ async def identify(self):
                 'token': self.token,
                 'properties': {
                     '$os': sys.platform,
-                    '$browser': 'discord.py',
-                    '$device': 'discord.py',
+                    '$browser': 'pycord',
+                    '$device': 'pycord',
                     '$referrer': '',
                     '$referring_domain': ''
                 },

examples/app_commands/slash_autocomplete.py

@@ -1,5 +1,6 @@
 import discord
-from discord.commands import slash_command, Option
+from discord.commands import Option, slash_command
+
 bot = discord.Bot()
 
 COLORS = ["red", "orange", "yellow", "green", "blue", "indigo", "violet"]
@@ -85,15 +86,19 @@
     "yellowgreen",
 ]
 
-BASIC_ALLOWED = [...]  # this would normally be a list of discord user IDs for the purpose of this example
+BASIC_ALLOWED = [
+    ...
+]  # this would normally be a list of discord user IDs for the purpose of this example
 
 
 async def color_searcher(ctx: discord.AutocompleteContext):
     """Returns a list of matching colors from the LOTS_OF_COLORS list
     In this example, we've added logic to only display any results in the returned list if the user's ID exists in the BASIC_ALLOWED list.
     This is to demonstrate passing a callback in the discord.utils.basic_autocomplete function.
     """
-    return [color for color in LOTS_OF_COLORS if ctx.interaction.user.id in BASIC_ALLOWED]
+    return [
+        color for color in LOTS_OF_COLORS if ctx.interaction.user.id in BASIC_ALLOWED
+    ]
 
 
 async def get_colors(ctx: discord.AutocompleteContext):
@@ -115,7 +120,9 @@ async def get_animals(ctx: discord.AutocompleteContext):
     elif picked_color == "blue":
         return ["blue jay", "blue whale"]
     elif picked_color == "indigo":
-        return ["eastern indigo snake"]  # needs to return an iterable even if only one item
+        return [
+            "eastern indigo snake"
+        ]  # needs to return an iterable even if only one item
     elif picked_color == "violet":
         return ["purple emperor butterfly", "orchid dottyback"]
     else:
@@ -129,14 +136,26 @@ async def autocomplete_example(
     animal: Option(str, "Pick an animal!", autocomplete=get_animals),
 ):
     """This demonstrates using the ctx.options parameter to to create slash command options that are dependent on the values entered for other options."""
-    await ctx.respond(f"You picked {color} for the color, which allowed you to choose {animal} for the animal.")
+    await ctx.respond(
+        f"You picked {color} for the color, which allowed you to choose {animal} for the animal."
+    )
 
 
 @bot.slash_command(name="ac_basic_example")
 async def autocomplete_basic_example(
     ctx: discord.ApplicationContext,
-    color: Option(str, "Pick a color from this big list", autocomplete=discord.utils.basic_autocomplete(color_searcher)),  # Demonstrates passing a callback to discord.utils.basic_autocomplete
-    animal: Option(str, "Pick an animal from this small list", autocomplete=discord.utils.basic_autocomplete(["snail", "python", "cricket", "orca"])),  # Demonstrates passing a static iterable discord.utils.basic_autocomplete
+    color: Option(
+        str,
+        "Pick a color from this big list",
+        autocomplete=discord.utils.basic_autocomplete(color_searcher),
+    ),  # Demonstrates passing a callback to discord.utils.basic_autocomplete
+    animal: Option(
+        str,
+        "Pick an animal from this small list",
+        autocomplete=discord.utils.basic_autocomplete(
+            ["snail", "python", "cricket", "orca"]
+        ),
+    ),  # Demonstrates passing a static iterable discord.utils.basic_autocomplete
 ):
     """This demonstrates using the discord.utils.basic_autocomplete helper function.
     For the `color` option, a callback is passed, where additional logic can be added to determine which values are returned.
@@ -145,4 +164,5 @@ async def autocomplete_basic_example(
     Note that the basic_autocomplete function itself will still only return a maximum of 25 items."""
     await ctx.respond(f"You picked {color} as your color, and {animal} as your animal!")
 
+
 bot.run("TOKEN")

examples/app_commands/slash_basic.py

@@ -6,7 +6,7 @@
 # Note: If you want you can use commands.Bot instead of discord.Bot
 # Use discord.Bot if you don't want prefixed message commands
 
-# With discord.Bot you can use @bot.command as an alias 
+# With discord.Bot you can use @bot.command as an alias
 # of @bot.slash_command but this is overridden by commands.Bot
 
 
@@ -28,7 +28,9 @@ async def joined(
     ctx, member: discord.Member = None
 ):  # Passing a default value makes the argument optional
     user = member or ctx.author
-    await ctx.respond(f"{user.name} joined at {discord.utils.format_dt(user.joined_at)}")
+    await ctx.respond(
+        f"{user.name} joined at {discord.utils.format_dt(user.joined_at)}"
+    )
 
 
 # To learn how to add descriptions and choices to options, check slash_options.py

examples/app_commands/slash_cog.py

@@ -1,18 +1,19 @@
+from discord.commands import slash_command  # Importing the decorator that makes slash commands.
 from discord.ext import commands
-from discord.commands import slash_command # Importing the decorator that makes slash commands.
+
 
 class Example(commands.Cog):
     def __init__(self, bot):
         self.bot = bot
- 
-    @slash_command(guild_ids=[...]) # Create a slash command for the supplied guilds.
+
+    @slash_command(guild_ids=[...])  # Create a slash command for the supplied guilds.
     async def hello(self, ctx):
         await ctx.respond("Hi, this is a slash command from a cog!")
-    
 
-    @slash_command() # Not passing in guild_ids creates a global slash command (might take an hour to register).
+    @slash_command()  # Not passing in guild_ids creates a global slash command (might take an hour to register).
     async def hi(self, ctx):
-        await ctx.respond(f"Hi, this is a global slash command from a cog!")
+        await ctx.respond("Hi, this is a global slash command from a cog!")
+
 
 def setup(bot):
     bot.add_cog(Example(bot))

examples/app_commands/slash_options.py

@@ -16,4 +16,5 @@ async def hello(
 ):
     await ctx.respond(f"Hello {name}")
 
-bot.run('TOKEN')
+
+bot.run("TOKEN")

examples/app_commands/slash_perms.py

@@ -1,5 +1,4 @@
 import discord
-
 # Imports permissions from discord.commands
 from discord.commands import permissions
 
@@ -8,7 +7,7 @@
 # Note: If you want you can use commands.Bot instead of discord.Bot
 # Use discord.Bot if you don't want prefixed message commands
 
-# With discord.Bot you can use @bot.command as an alias 
+# With discord.Bot you can use @bot.command as an alias
 # of @bot.slash_command but this is overridden by commands.Bot
 
 # by default, default_permission is set to True, you can use
@@ -31,45 +30,60 @@
 # Note: Please replace token, GUILD_ID, USER_ID and ROLE_NAME.
 
 # Guild Slash Command Example with User Permissions
+
+GUILD_ID = ...
+USER_ID = ...
+
+
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.is_user(USER_ID)
 async def user(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Owner Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.is_owner()
 async def owner(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Role Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.has_role("ROLE_NAME")
 async def role(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Any Specified Role Permissions
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.has_any_role("ROLE_NAME", "ROLE_NAME2")
 async def multirole(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Permission Decorator
 @bot.slash_command(guild_ids=[GUILD_ID], default_permission=False)
 @permissions.permission(user_id=USER_ID, permission=True)
 async def permission_decorator(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # Guild Slash Command Example with Permissions Kwarg
-@bot.slash_command(guild_ids=[GUILD_ID], default_permission=False, permissions=[permissions.Permission(id=USER_ID, type=2, permission=True)])
+@bot.slash_command(
+    guild_ids=[GUILD_ID],
+    default_permission=False,
+    permissions=[permissions.Permission(id=USER_ID, type=2, permission=True)],
+)
 async def permission_kwarg(ctx):
     """Say hello to the author"""  # the command description can be supplied as the docstring
     await ctx.respond(f"Hello {ctx.author}!")
 
+
 # To learn how to add descriptions, choices to options check slash_options.py
 bot.run("token")

examples/background_task.py

@@ -1,6 +1,5 @@
-from discord.ext import tasks
-
 import discord
+from discord.ext import tasks
 
 
 class MyClient(discord.Client):