Merge pull request #57 from cloudwithax/pre-commit-ci-update-config

[pre-commit.ci] pre-commit autoupdate

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: check-ast
     -   id: check-builtin-literals
@@ -11,29 +11,29 @@ repos:
     -   id: requirements-txt-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.10.1
     hooks:
     - id: black
       language_version: python3.11
 -   repo: https://github.com/asottile/blacken-docs
-    rev: 1.15.0
+    rev: 1.16.0
     hooks:
     -   id: blacken-docs
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
+    rev: v3.15.0
     hooks:
     -   id: pyupgrade
         args: [--py37-plus, --keep-runtime-typing]
 -   repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.10.0
+    rev: v3.12.0
     hooks:
     -   id: reorder-python-imports
 -   repo: https://github.com/asottile/add-trailing-comma
-    rev: v3.0.1
+    rev: v3.1.0
     hooks:
     -   id: add-trailing-comma
 -   repo: https://github.com/hadialqattan/pycln
-    rev: v2.2.2
+    rev: v2.3.0
     hooks:
     -   id: pycln
 

docs/hdi/events.md

@@ -13,11 +13,9 @@ The classes listed here are as they appear in Pomice. When you use them within y
 the way you use them will be different. Here's an example on how you would use the `TrackStartEvent` within an event listener in a cog:
 
 ```py
-
 @commands.Cog.listener
 async def on_pomice_track_start(self, player: Player, track: Track):
     ...
-
 ```
 
 ## Event definitions

docs/quickstart.md

@@ -10,63 +10,71 @@ import re
 
 from discord.ext import commands
 
-URL_REG = re.compile(r'https?://(?:www\.)?.+')
+URL_REG = re.compile(r"https?://(?:www\.)?.+")
+
 
 class MyBot(commands.Bot):
+    def __init__(self) -> None:
+        super().__init__(
+            command_prefix="!",
+            activity=discord.Activity(
+                type=discord.ActivityType.listening, name="to music!"
+            ),
+        )
 
-   def __init__(self) -> None:
+        self.add_cog(Music(self))
-      super().__init__(command_prefix='!', activity=discord.Activity(type=discord.ActivityType.listening, name='to music!'))
 
-      self.add_cog(Music(self))
+    async def on_ready(self) -> None:
-
+        print("I'm online!")
-   async def on_ready(self) -> None:
+        await self.cogs["Music"].start_nodes()
-      print("I'm online!")
-      await self.cogs["Music"].start_nodes()
 
 
 class Music(commands.Cog):
+    def __init__(self, bot) -> None:
+        self.bot = bot
 
-   def __init__(self, bot) -> None:
+        self.pomice = pomice.NodePool()
-      self.bot = bot
 
-      self.pomice = pomice.NodePool()
+    async def start_nodes(self):
+        await self.pomice.create_node(
+            bot=self.bot,
+            host="127.0.0.1",
+            port="3030",
+            password="youshallnotpass",
+            identifier="MAIN",
+        )
+        print(f"Node is ready!")
 
-   async def start_nodes(self):
+    @commands.command(name="join", aliases=["connect"])
-      await self.pomice.create_node(bot=self.bot, host='127.0.0.1', port='3030',
+    async def join(
-                                    password='youshallnotpass', identifier='MAIN')
+        self, ctx: commands.Context, *, channel: discord.TextChannel = None
-      print(f"Node is ready!")
+    ) -> None:
-
+        if not channel:
-
+            channel = getattr(ctx.author.voice, "channel", None)
-
-   @commands.command(name='join', aliases=['connect'])
-   async def join(self, ctx: commands.Context, *, channel: discord.TextChannel = None) -> None:
-
-      if not channel:
-            channel = getattr(ctx.author.voice, 'channel', None)
             if not channel:
-               raise commands.CheckFailure('You must be in a voice channel to use this command'
+                raise commands.CheckFailure(
-                                          'without specifying the channel argument.')
+                    "You must be in a voice channel to use this command"
+                    "without specifying the channel argument."
+                )
 
+        await ctx.author.voice.channel.connect(cls=pomice.Player)
+        await ctx.send(f"Joined the voice channel `{channel}`")
 
-      await ctx.author.voice.channel.connect(cls=pomice.Player)
+    @commands.command(name="play")
-      await ctx.send(f'Joined the voice channel `{channel}`')
+    async def play(self, ctx, *, search: str) -> None:
-
+        if not ctx.voice_client:
-   @commands.command(name='play')
-   async def play(self, ctx, *, search: str) -> None:
-
-      if not ctx.voice_client:
             await ctx.invoke(self.join)
 
-      player = ctx.voice_client
+        player = ctx.voice_client
 
-      results = await player.get_tracks(query=f'{search}')
+        results = await player.get_tracks(query=f"{search}")
 
-      if not results:
+        if not results:
-            raise commands.CommandError('No results were found for that search term.')
+            raise commands.CommandError("No results were found for that search term.")
 
-      if isinstance(results, pomice.Playlist):
+        if isinstance(results, pomice.Playlist):
             await player.play(track=results.tracks[0])
-      else:
+        else:
             await player.play(track=results[0])