import re from enum import Enum __all__ = ( "SearchType", "TrackType", "PlaylistType", "NodeAlgorithm", "LoopMode", "RouteStrategy", "RouteIPType", "URLRegex", ) class SearchType(Enum): """ The enum for the different search types for Pomice. This feature is exclusively for the Spotify search feature of Pomice. If you are not using this feature, this class is not necessary. SearchType.ytsearch searches using regular Youtube, which is best for all scenarios. SearchType.ytmsearch searches using YouTube Music, which is best for getting audio-only results. SearchType.scsearch searches using SoundCloud, which is an alternative to YouTube or YouTube Music. """ ytsearch = "ytsearch" ytmsearch = "ytmsearch" scsearch = "scsearch" def __str__(self) -> str: return self.value class TrackType(Enum): """ The enum for the different track types for Pomice. TrackType.YOUTUBE defines that the track is from YouTube TrackType.SOUNDCLOUD defines that the track is from SoundCloud. TrackType.SPOTIFY defines that the track is from Spotify TrackType.APPLE_MUSIC defines that the track is from Apple Music. TrackType.HTTP defines that the track is from an HTTP source. """ # We don't have to define anything special for these, since these just serve as flags YOUTUBE = "youtube" SOUNDCLOUD = "soundcloud" SPOTIFY = "spotify" APPLE_MUSIC = "apple_music" HTTP = "http" def __str__(self) -> str: return self.value class PlaylistType(Enum): """ The enum for the different playlist types for Pomice. PlaylistType.YOUTUBE defines that the playlist is from YouTube PlaylistType.SOUNDCLOUD defines that the playlist is from SoundCloud. PlaylistType.SPOTIFY defines that the playlist is from Spotify PlaylistType.APPLE_MUSIC defines that the playlist is from Apple Music. """ # We don't have to define anything special for these, since these just serve as flags YOUTUBE = "youtube" SOUNDCLOUD = "soundcloud" SPOTIFY = "spotify" APPLE_MUSIC = "apple_music" def __str__(self) -> str: return self.value class NodeAlgorithm(Enum): """ The enum for the different node algorithms in Pomice. The enums in this class are to only differentiate different methods, since the actual method is handled in the get_best_node() method. NodeAlgorithm.by_ping returns a node based on it's latency, preferring a node with the lowest response time NodeAlgorithm.by_players return a nodes based on how many players it has. This algorithm prefers nodes with the least amount of players. """ # We don't have to define anything special for these, since these just serve as flags by_ping = "BY_PING" by_players = "BY_PLAYERS" def __str__(self) -> str: return self.value class LoopMode(Enum): """ The enum for the different loop modes. This feature is exclusively for the queue utility of pomice. If you are not using this feature, this class is not necessary. 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): """ The enum for specifying the route planner strategy for Lavalink. This feature is exclusively for the RoutePlanner class. If you are not using this feature, this class is not necessary. RouteStrategy.ROTATE_ON_BAN specifies that the node is rotating IPs whenever they get banned by Youtube. RouteStrategy.LOAD_BALANCE specifies that the node is selecting random IPs to balance out requests between them. RouteStrategy.NANO_SWITCH specifies that the node is switching between IPs every CPU clock cycle. 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" LOAD_BALANCE = "BalancingIpRoutePlanner" NANO_SWITCH = "NanoIpRoutePlanner" ROTATING_NANO_SWITCH = "RotatingNanoIpRoutePlanner" class RouteIPType(Enum): """ The enum for specifying the route planner IP block type for Lavalink. This feature is exclusively for the RoutePlanner class. If you are not using this feature, this class is not necessary. RouteIPType.IPV4 specifies that the IP block type is IPV4 RouteIPType.IPV6 specifies that the IP block type is IPV6 """ IPV4 = "Inet4Address" IPV6 = "Inet6Address" class URLRegex: """ The enums for all the URL Regexes in use by Pomice. URLRegex.SPOTIFY_URL returns the Spotify URL Regex. URLRegex.DISCORD_MP3_URL returns the Discord MP3 URL Regex. URLRegex.YOUTUBE_URL returns the Youtube URL Regex. URLRegex.YOUTUBE_PLAYLIST returns the Youtube Playlist Regex. URLRegex.YOUTUBE_TIMESTAMP returns the Youtube Timestamp Regex. URLRegex.AM_URL returns the Apple Music URL Regex. URLRegex.SOUNDCLOUD_URL returns the SoundCloud URL Regex. URLRegex.BASE_URL returns the standard URL Regex. """ SPOTIFY_URL = re.compile( r"https?://open.spotify.com/(?Palbum|playlist|track|artist)/(?P[a-zA-Z0-9]+)", ) DISCORD_MP3_URL = re.compile( r"https?://cdn.discordapp.com/attachments/(?P[0-9]+)/" r"(?P[0-9]+)/(?P[a-zA-Z0-9_.]+)+", ) YOUTUBE_URL = re.compile( r"^((?:https?:)?\/\/)?((?:www|m)\.)?((?:youtube\.com|youtu.be))" r"(\/(?:[\w\-]+\?v=|embed\/|v\/)?)([\w\-]+)(\S+)?$", ) YOUTUBE_PLAYLIST_URL = re.compile( r"^((?:https?:)?\/\/)?((?:www|m)\.)?((?:youtube\.com|youtu.be))/playlist\?list=.*", ) YOUTUBE_VID_IN_PLAYLIST = re.compile( r"(?P