feat (WIP): use pydantic for model validation

Pipfile

@@ -5,7 +5,9 @@ name = "pypi"
 
 [packages]
 orjson = "*"
+pydantic = ">=2"
 "discord.py" = {extras = ["voice"], version = "*"}
+websockets = "*"
 
 [dev-packages]
 mypy = "*"

examples/advanced.py

@@ -125,7 +125,7 @@ def is_privileged(self, ctx: commands.Context):
 
         return player.dj == ctx.author or ctx.author.guild_permissions.kick_members
 
-    # The following are events from pomice.events
+    # The following are events from pomice.models.events
     # We are using these so that if the track either stops or errors,
     # we can just skip to the next track
 

pomice/__init__.py

@@ -27,7 +27,7 @@ class DiscordPyOutdated(Exception):
 __copyright__ = "Copyright (c) 2023, cloudwithax"
 
 from .enums import *
-from .events import *
+from .models import *
 from .exceptions import *
 from .filters import *
 from .objects import *

pomice/applemusic/client.py

@@ -11,17 +11,12 @@
 import aiohttp
 import orjson as json
 
-from .exceptions import *
-from .objects import *
+from pomice.applemusic.exceptions import *
+from pomice.applemusic.objects import *
+from pomice.enums import URLRegex
 
 __all__ = ("Client",)
 
-AM_URL_REGEX = re.compile(
-    r"https?://music.apple.com/(?P<country>[a-zA-Z]{2})/(?P<type>album|playlist|song|artist)/(?P<name>.+)/(?P<id>[^?]+)",
-)
-AM_SINGLE_IN_ALBUM_REGEX = re.compile(
-    r"https?://music.apple.com/(?P<country>[a-zA-Z]{2})/(?P<type>album|playlist|song|artist)/(?P<name>.+)/(?P<id>.+)(\?i=)(?P<id2>.+)",
-)
 
 AM_SCRIPT_REGEX = re.compile(r'<script.*?src="(/assets/index-.*?)"')
 
@@ -103,7 +98,7 @@ async def search(self, query: str) -> Union[Album, Playlist, Song, Artist]:
         if not self.token or datetime.utcnow() > self.expiry:
             await self.request_token()
 
-        result = AM_URL_REGEX.match(query)
+        result = URLRegex.AM_URL.match(query)
         if not result:
             raise InvalidAppleMusicURL(
                 "The Apple Music link provided is not valid.",
@@ -113,7 +108,7 @@ async def search(self, query: str) -> Union[Album, Playlist, Song, Artist]:
         type = result.group("type")
         id = result.group("id")
 
-        if type == "album" and (sia_result := AM_SINGLE_IN_ALBUM_REGEX.match(query)):
+        if type == "album" and (sia_result := URLRegex.AM_SINGLE_IN_ALBUM_REGEX.match(query)):
             # apple music likes to generate links for singles off an album
             # by adding a param at the end of the url
             # so we're gonna scan for that and correct it

pomice/enums.py

@@ -1,6 +1,7 @@
 import re
 from enum import Enum
 from enum import IntEnum
+from enum import unique
 
 __all__ = (
     "SearchType",
@@ -15,7 +16,13 @@
 )
 
 
-class SearchType(Enum):
+class BaseStrEnum(str, Enum):
+    def __str__(self):
+        return self.value
+
+
+@unique
+class SearchType(BaseStrEnum):
     """
     The enum for the different search types for Pomice.
     This feature is exclusively for the Spotify search feature of Pomice.
@@ -31,15 +38,13 @@ class SearchType(Enum):
     which is an alternative to YouTube or YouTube Music.
     """
 
-    ytsearch = "ytsearch"
-    ytmsearch = "ytmsearch"
-    scsearch = "scsearch"
-
-    def __str__(self) -> str:
-        return self.value
+    YTSEARCH = "ytsearch"
+    YTMSEARCH = "ytmsearch"
+    SCSEARCH = "scsearch"
 
 
-class TrackType(Enum):
+@unique
+class TrackType(BaseStrEnum):
     """
     The enum for the different track types for Pomice.
 
@@ -64,11 +69,9 @@ class TrackType(Enum):
     HTTP = "http"
     LOCAL = "local"
 
-    def __str__(self) -> str:
-        return self.value
 
-
-class PlaylistType(Enum):
+@unique
+class PlaylistType(BaseStrEnum):
     """
     The enum for the different playlist types for Pomice.
 
@@ -87,11 +90,9 @@ class PlaylistType(Enum):
     SPOTIFY = "spotify"
     APPLE_MUSIC = "apple_music"
 
-    def __str__(self) -> str:
-        return self.value
-
 
-class NodeAlgorithm(Enum):
+@unique
+class NodeAlgorithm(BaseStrEnum):
     """
     The enum for the different node algorithms in Pomice.
 
@@ -111,11 +112,9 @@ class NodeAlgorithm(Enum):
     by_ping = "BY_PING"
     by_players = "BY_PLAYERS"
 
-    def __str__(self) -> str:
-        return self.value
-
 
-class LoopMode(Enum):
+@unique
+class LoopMode(BaseStrEnum):
     """
     The enum for the different loop modes.
     This feature is exclusively for the queue utility of pomice.
@@ -124,18 +123,15 @@ class LoopMode(Enum):
     LoopMode.TRACK sets the queue loop to the current track.
 
     LoopMode.QUEUE sets the queue loop to the whole queue.
-
     """
 
     # We don't have to define anything special for these, since these just serve as flags
     TRACK = "track"
     QUEUE = "queue"
 
-    def __str__(self) -> str:
-        return self.value
-
 
-class RouteStrategy(Enum):
+@unique
+class RouteStrategy(BaseStrEnum):
     """
     The enum for specifying the route planner strategy for Lavalink.
     This feature is exclusively for the RoutePlanner class.
@@ -153,7 +149,6 @@ class RouteStrategy(Enum):
     RouteStrategy.ROTATING_NANO_SWITCH specifies that the node is switching
     between IPs every CPU clock cycle and is rotating between IP blocks on
     ban.
-
     """
 
     ROTATE_ON_BAN = "RotatingIpRoutePlanner"
@@ -162,7 +157,8 @@ class RouteStrategy(Enum):
     ROTATING_NANO_SWITCH = "RotatingNanoIpRoutePlanner"
 
 
-class RouteIPType(Enum):
+@unique
+class RouteIPType(BaseStrEnum):
     """
     The enum for specifying the route planner IP block type for Lavalink.
     This feature is exclusively for the RoutePlanner class.
@@ -177,9 +173,43 @@ class RouteIPType(Enum):
     IPV6 = "Inet6Address"
 
 
+@unique
+class LogLevel(IntEnum):
+    """
+    The enum for specifying the logging level within Pomice.
+    This class serves as shorthand for logging.<level>
+    This enum is exclusively for the logging feature in Pomice.
+    If you are not using this feature, this class is not necessary.
+
+
+    LogLevel.DEBUG sets the logging level to "debug".
+
+    LogLevel.INFO sets the logging level to "info".
+
+    LogLevel.WARN sets the logging level to "warn".
+
+    LogLevel.ERROR sets the logging level to "error".
+
+    LogLevel.CRITICAL sets the logging level to "CRITICAL".
+    """
+
+    DEBUG = 10
+    INFO = 20
+    WARN = 30
+    ERROR = 40
+    CRITICAL = 50
+
+    @classmethod
+    def from_str(cls, level_str):
+        try:
+            return cls[level_str.upper()]
+        except KeyError:
+            raise ValueError(f"No such log level: {level_str}")
+
+
 class URLRegex:
     """
-    The enum for all the URL Regexes in use by Pomice.
+    The class for all the URL Regexes in use by Pomice.
 
     URLRegex.SPOTIFY_URL returns the Spotify URL Regex.
 
@@ -196,7 +226,6 @@ class URLRegex:
     URLRegex.SOUNDCLOUD_URL returns the SoundCloud URL Regex.
 
     URLRegex.BASE_URL returns the standard URL Regex.
-
     """
 
     SPOTIFY_URL = re.compile(
@@ -246,37 +275,3 @@ class URLRegex:
     LAVALINK_SEARCH = re.compile(r"(?P<type>ytm?|sc)search:")
 
     BASE_URL = re.compile(r"https?://(?:www\.)?.+")
-
-
-class LogLevel(IntEnum):
-    """
-    The enum for specifying the logging level within Pomice.
-    This class serves as shorthand for logging.<level>
-    This enum is exclusively for the logging feature in Pomice.
-    If you are not using this feature, this class is not necessary.
-
-
-    LogLevel.DEBUG sets the logging level to "debug".
-
-    LogLevel.INFO sets the logging level to "info".
-
-    LogLevel.WARN sets the logging level to "warn".
-
-    LogLevel.ERROR sets the logging level to "error".
-
-    LogLevel.CRITICAL sets the logging level to "CRITICAL".
-
-    """
-
-    DEBUG = 10
-    INFO = 20
-    WARN = 30
-    ERROR = 40
-    CRITICAL = 50
-
-    @classmethod
-    def from_str(cls, level_str):
-        try:
-            return cls[level_str.upper()]
-        except KeyError:
-            raise ValueError(f"No such log level: {level_str}")