Merge branch 'main' into dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7

Author: EvieePy

docs/conf.py

@@ -21,6 +21,7 @@
 import re
 import sys
 
+
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath(".."))
 sys.path.append(os.path.abspath("extensions"))

docs/extensions/attributetable.py

@@ -3,7 +3,8 @@
 import importlib
 import inspect
 import re
-from typing import TYPE_CHECKING, Dict, List, NamedTuple, Optional, Sequence, Tuple
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, NamedTuple
 
 from docutils import nodes
 from sphinx import addnodes
@@ -13,6 +14,7 @@
 from sphinx.util.docutils import SphinxDirective
 from sphinx.util.typing import OptionSpec
 
+
 if TYPE_CHECKING:
     from .builder import DPYHTML5Translator
 
@@ -96,7 +98,7 @@ class PyAttributeTable(SphinxDirective):
     final_argument_whitespace = False
     option_spec: OptionSpec = {}
 
-    def parse_name(self, content: str) -> Tuple[str, str]:
+    def parse_name(self, content: str) -> tuple[str, str]:
         match = _name_parser_regex.match(content)
         if match is None:
             raise RuntimeError(f"content {content} somehow doesn't match regex in {self.env.docname}.")
@@ -112,7 +114,7 @@ def parse_name(self, content: str) -> Tuple[str, str]:
 
         return modulename, name
 
-    def run(self) -> List[attributetableplaceholder]:
+    def run(self) -> list[attributetableplaceholder]:
         """If you're curious on the HTML this is meant to generate:
 
         <div class="py-attribute-table">
@@ -149,7 +151,7 @@ def run(self) -> List[attributetableplaceholder]:
         return [node]
 
 
-def build_lookup_table(env: BuildEnvironment) -> Dict[str, List[str]]:
+def build_lookup_table(env: BuildEnvironment) -> dict[str, list[str]]:
     # Given an environment, load up a lookup table of
     # full-class-name: objects
     result = {}
@@ -178,7 +180,7 @@ def build_lookup_table(env: BuildEnvironment) -> Dict[str, List[str]]:
 class TableElement(NamedTuple):
     fullname: str
     label: str
-    badge: Optional[attributetablebadge]
+    badge: attributetablebadge | None
 
 
 def process_attributetable(app: Sphinx, doctree: nodes.Node, fromdocname: str) -> None:
@@ -203,12 +205,12 @@ def process_attributetable(app: Sphinx, doctree: nodes.Node, fromdocname: str) -
 
 
 def get_class_results(
-    lookup: Dict[str, List[str]], modulename: str, name: str, fullname: str
-) -> Dict[str, List[TableElement]]:
+    lookup: dict[str, list[str]], modulename: str, name: str, fullname: str
+) -> dict[str, list[TableElement]]:
     module = importlib.import_module(modulename)
     cls = getattr(module, name)
 
-    groups: Dict[str, List[TableElement]] = {
+    groups: dict[str, list[TableElement]] = {
         _("Attributes"): [],
         _("Methods"): [],
     }

docs/wavelink.rst

@@ -34,6 +34,19 @@ An event listener in a cog.
     This event can be called many times throughout your bots lifetime, as it will be called when Wavelink successfully
     reconnects to your node in the event of a disconnect.
 
+.. function:: on_wavelink_node_disconnected(payload: wavelink.NodeDisconnectedEventPayload)
+
+    Called when a Node has disconnected/lost connection to wavelink. **This is NOT** the same as a node being closed.
+    This event will however be called directly before the :func:`on_wavelink_node_closed` event.
+
+    The default behaviour is for wavelink to attempt to reconnect a disconnected Node. This event can change that
+    behaviour. If you want to close this node completely see: :meth:`Node.close`
+
+    This event can be used to manage currrently connected players to this Node.
+    See: :meth:`Player.switch_node`
+
+    .. versionadded:: 3.5.0
+
 .. function:: on_wavelink_stats_update(payload: wavelink.StatsEventPayload)
 
     Called when the ``stats`` OP is received by Lavalink.
@@ -128,6 +141,11 @@ Types
 
         tracks: wavelink.Search = await wavelink.Playable.search("Ocean Drive")
 
+.. attributetable:: PlayerBasicState
+
+.. autoclass:: PlayerBasicState
+
+
 
 Payloads
 ---------
@@ -136,6 +154,11 @@ Payloads
 .. autoclass:: NodeReadyEventPayload
     :members:
 
+.. attributetable:: NodeDisconnectedEventPayload
+
+.. autoclass:: NodeDisconnectedEventPayload
+    :members:
+
 .. attributetable:: TrackStartEventPayload
 
 .. autoclass:: TrackStartEventPayload
@@ -442,6 +465,8 @@ Exceptions
     Exception raised when a :class:`Node` is tried to be retrieved from the
     :class:`Pool` without existing, or the ``Pool`` is empty.
 
+    This exception is also raised when providing an invalid node to :meth:`Player.switch_node`.
+
 .. py:exception:: LavalinkException
 
     Exception raised when Lavalink returns an invalid response.

examples/simple.py

@@ -86,7 +86,7 @@ async def play(ctx: commands.Context, *, query: str) -> None:
         return
 
     player: wavelink.Player
-    player = cast(wavelink.Player, ctx.voice_client)  # type: ignore
+    player = cast("wavelink.Player", ctx.voice_client)  # type: ignore
 
     if not player:
         try:
@@ -143,7 +143,7 @@ async def play(ctx: commands.Context, *, query: str) -> None:
 @bot.command()
 async def skip(ctx: commands.Context) -> None:
     """Skip the current song."""
-    player: wavelink.Player = cast(wavelink.Player, ctx.voice_client)
+    player: wavelink.Player = cast("wavelink.Player", ctx.voice_client)
     if not player:
         return
 
@@ -154,7 +154,7 @@ async def skip(ctx: commands.Context) -> None:
 @bot.command()
 async def nightcore(ctx: commands.Context) -> None:
     """Set the filter to a nightcore style."""
-    player: wavelink.Player = cast(wavelink.Player, ctx.voice_client)
+    player: wavelink.Player = cast("wavelink.Player", ctx.voice_client)
     if not player:
         return
 
@@ -168,7 +168,7 @@ async def nightcore(ctx: commands.Context) -> None:
 @bot.command(name="toggle", aliases=["pause", "resume"])
 async def pause_resume(ctx: commands.Context) -> None:
     """Pause or Resume the Player depending on its current state."""
-    player: wavelink.Player = cast(wavelink.Player, ctx.voice_client)
+    player: wavelink.Player = cast("wavelink.Player", ctx.voice_client)
     if not player:
         return
 
@@ -179,7 +179,7 @@ async def pause_resume(ctx: commands.Context) -> None:
 @bot.command()
 async def volume(ctx: commands.Context, value: int) -> None:
     """Change the volume of the player."""
-    player: wavelink.Player = cast(wavelink.Player, ctx.voice_client)
+    player: wavelink.Player = cast("wavelink.Player", ctx.voice_client)
     if not player:
         return
 
@@ -190,7 +190,7 @@ async def volume(ctx: commands.Context, value: int) -> None:
 @bot.command(aliases=["dc"])
 async def disconnect(ctx: commands.Context) -> None:
     """Disconnect the Player."""
-    player: wavelink.Player = cast(wavelink.Player, ctx.voice_client)
+    player: wavelink.Player = cast("wavelink.Player", ctx.voice_client)
     if not player:
         return
 

pyproject.toml

@@ -4,7 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wavelink"
-version = "3.4.1"
+version = "3.5.1"
+
 authors = [
   { name="PythonistaGuild, EvieePy", email="evieepy@gmail.com" },
 ]
@@ -76,7 +77,8 @@ ignore = [
     "PTH123",
     "E203", 
     "E501",
-    "RUF006"
+    "RUF006",
+    "SIM910",
 ]
 
 [tool.ruff.lint.isort]
@@ -97,7 +99,7 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.pyright]
-exclude = ["venv"]
+exclude = ["venv", "**/node_modules", "**/__pycache__", "**/.*", ".venv"]
 ignore = ["test*.py", "examples/*.py", "docs/*"]
 useLibraryCodeForTypes = true
 typeCheckingMode = "strict"

requirements.txt

@@ -1,5 +1,5 @@
 aiohttp>=3.7.4,<4
-discord.py>=2.0.1
+discord.py>=2.7.0
 yarl>=1.9.2
 async_timeout
 typing_extensions

wavelink/__init__.py

@@ -26,8 +26,7 @@
 __author__ = "PythonistaGuild, EvieePy"
 __license__ = "MIT"
 __copyright__ = "Copyright 2019-Present (c) PythonistaGuild, EvieePy"
-__version__ = "3.4.1"
-
+__version__ = "3.5.1"
 
 from .enums import *
 from .exceptions import *
@@ -38,4 +37,5 @@
 from .player import Player as Player
 from .queue import *
 from .tracks import *
+from .types.state import PlayerBasicState as PlayerBasicState
 from .utils import ExtrasNamespace as ExtrasNamespace

wavelink/__main__.py

@@ -16,7 +16,7 @@
 def get_debug_info() -> None:
     python_info = "\n".join(sys.version.split("\n"))
     java_version = subprocess.check_output(["java", "-version"], stderr=subprocess.STDOUT)
-    java_version = f'\n{" " * 8}- '.join(v for v in java_version.decode().split("\r\n") if v)
+    java_version = f"\n{' ' * 8}- ".join(v for v in java_version.decode().split("\r\n") if v)
 
     info: str = f"""
     wavelink: {wavelink.__version__}

wavelink/enums.py

@@ -25,7 +25,7 @@
 import enum
 
 
-__all__ = ("NodeStatus", "TrackSource", "DiscordVoiceCloseType", "AutoPlayMode", "QueueMode")
+__all__ = ("AutoPlayMode", "DiscordVoiceCloseType", "NodeStatus", "QueueMode", "TrackSource")
 
 
 class NodeStatus(enum.Enum):

wavelink/exceptions.py

@@ -32,16 +32,16 @@
 
 
 __all__ = (
-    "WavelinkException",
-    "NodeException",
-    "InvalidClientException",
     "AuthorizationFailedException",
+    "ChannelTimeoutException",
+    "InvalidChannelStateException",
+    "InvalidClientException",
     "InvalidNodeException",
     "LavalinkException",
     "LavalinkLoadException",
-    "InvalidChannelStateException",
-    "ChannelTimeoutException",
+    "NodeException",
     "QueueEmpty",
+    "WavelinkException",
 )
 
 
@@ -82,6 +82,8 @@ class AuthorizationFailedException(WavelinkException):
 class InvalidNodeException(WavelinkException):
     """Exception raised when a :class:`Node` is tried to be retrieved from the
     :class:`Pool` without existing, or the ``Pool`` is empty.
+
+    This exception is also raised when providing an invalid node to :meth:`~wavelink.Player.switch_node`.
     """