Add queue system and fix a few issues
This commit is contained in:
cloudwithax
parent
6a0765d712
commit
fd0a2c5c26
|
|
@ -29,3 +29,4 @@ from .filters import *
|
|||
from .objects import *
|
||||
from .player import Player
|
||||
from .pool import *
|
||||
from .queue import *
|
||||
|
|
|
|||
|
|
@ -41,9 +41,27 @@ class NodeAlgorithm(Enum):
|
|||
"""
|
||||
|
||||
# We don't have to define anything special for these, since these just serve as flags
|
||||
by_ping = auto()
|
||||
by_region = auto()
|
||||
by_players = auto()
|
||||
by_ping = "BY_PING"
|
||||
by_region = "BY_REGION"
|
||||
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
|
||||
|
|
@ -71,3 +71,16 @@ class InvalidSpotifyClientAuthorization(PomiceException):
|
|||
"""No Spotify client authorization was provided for track searching."""
|
||||
pass
|
||||
|
||||
class QueueException(Exception):
|
||||
"""Base Pomice queue exception."""
|
||||
pass
|
||||
|
||||
|
||||
class QueueFull(QueueException):
|
||||
"""Exception raised when attempting to add to a full Queue."""
|
||||
pass
|
||||
|
||||
|
||||
class QueueEmpty(QueueException):
|
||||
"""Exception raised when attempting to retrieve from an empty Queue."""
|
||||
pass
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@ class Track:
|
|||
self.identifier = info.get("identifier")
|
||||
self.isrc = info.get("isrc")
|
||||
|
||||
if self.uri:
|
||||
if info.get("thumbnail"):
|
||||
self.thumbnail = info.get("thumbnail")
|
||||
elif SOUNDCLOUD_URL_REGEX.match(self.uri):
|
||||
|
|
|
|||
|
|
@ -0,0 +1,334 @@
|
|||
from __future__ import annotations
|
||||
import random
|
||||
from collections import deque
|
||||
from copy import copy
|
||||
from re import L
|
||||
from typing import (
|
||||
Iterable,
|
||||
Iterator,
|
||||
List,
|
||||
Optional,
|
||||
Union,
|
||||
)
|
||||
|
||||
from .objects import Track
|
||||
from .enums import LoopMode
|
||||
from .exceptions import QueueEmpty, QueueException, QueueFull
|
||||
|
||||
|
||||
class Queue(Iterable[Track]):
|
||||
def __init__(
|
||||
self,
|
||||
max_size: Optional[int] = None,
|
||||
*,
|
||||
overflow: bool = True,
|
||||
):
|
||||
self.max_size: Optional[int] = max_size
|
||||
self._queue = [] # type: ignore
|
||||
self._overflow: bool = overflow
|
||||
self._loop_mode: Optional[LoopMode] = None
|
||||
self._current_item: Optional[Track] = None
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""String showing all Track objects appearing as a list."""
|
||||
return str(list(f"'{t}'" for t in self))
|
||||
|
||||
def __repr__(self) -> str:
|
||||
"""Official representation with max_size and member count."""
|
||||
return (
|
||||
f"<{self.__class__.__name__} max_size={self.max_size} members={self.count}>"
|
||||
)
|
||||
|
||||
def __bool__(self) -> bool:
|
||||
"""Treats the queue as a bool, with it evaluating True when it contains members."""
|
||||
return bool(self.count)
|
||||
|
||||
def __call__(self, item: Track) -> None:
|
||||
"""Allows the queue instance to be called directly in order to add a member."""
|
||||
self.put(item)
|
||||
|
||||
def __len__(self) -> int:
|
||||
"""Return the number of members in the queue."""
|
||||
return self.count
|
||||
|
||||
def __getitem__(self, index: int) -> Track:
|
||||
"""Returns a member at the given position.
|
||||
Does not remove item from queue.
|
||||
"""
|
||||
if not isinstance(index, int):
|
||||
raise ValueError("'int' type required.'")
|
||||
|
||||
return self._queue[index]
|
||||
|
||||
def __setitem__(self, index: int, item: Track):
|
||||
"""Inserts an item at given position."""
|
||||
if not isinstance(index, int):
|
||||
raise ValueError("'int' type required.'")
|
||||
|
||||
self.put_at_index(index, item)
|
||||
|
||||
def __delitem__(self, index: int) -> None:
|
||||
"""Delete item at given position."""
|
||||
self._queue.__delitem__(index)
|
||||
|
||||
def __iter__(self) -> Iterator[Track]:
|
||||
"""Iterate over members in the queue.
|
||||
Does not remove items when iterating.
|
||||
"""
|
||||
return self._queue.__iter__()
|
||||
|
||||
def __reversed__(self) -> Iterator[Track]:
|
||||
"""Iterate over members in reverse order."""
|
||||
return self._queue.__reversed__()
|
||||
|
||||
def __contains__(self, item: Track) -> bool:
|
||||
"""Check if an item is a member of the queue."""
|
||||
return item in self._queue
|
||||
|
||||
def __add__(self, other: Iterable[Track]) -> Queue:
|
||||
"""Return a new queue containing all members.
|
||||
The new queue will have the same max_size as the original.
|
||||
"""
|
||||
if not isinstance(other, Iterable):
|
||||
raise TypeError(f"Adding with the '{type(other)}' type is not supported.")
|
||||
|
||||
new_queue = self.copy()
|
||||
new_queue.extend(other)
|
||||
return new_queue
|
||||
|
||||
def __iadd__(self, other: Union[Iterable[Track], Track]) -> Queue:
|
||||
"""Add items to queue."""
|
||||
if isinstance(other, Track):
|
||||
self.put(other)
|
||||
return self
|
||||
|
||||
if isinstance(other, Iterable):
|
||||
self.extend(other)
|
||||
return self
|
||||
|
||||
raise TypeError(f"Adding '{type(other)}' type to the queue is not supported.")
|
||||
|
||||
def _get(self) -> Track:
|
||||
return self._queue.pop(0)
|
||||
|
||||
def _drop(self) -> Track:
|
||||
return self._queue.pop()
|
||||
|
||||
def _index(self, item: Track) -> int:
|
||||
return self._queue.index(item)
|
||||
|
||||
|
||||
def _put(self, item: Track) -> None:
|
||||
self._queue.append(item)
|
||||
|
||||
def _insert(self, index: int, item: Track) -> None:
|
||||
self._queue.insert(index, item)
|
||||
|
||||
def _remove(self, index: int) -> None:
|
||||
self._queue.remove(index)
|
||||
|
||||
def _get_random_float(self) -> float:
|
||||
return random.random()
|
||||
|
||||
@staticmethod
|
||||
def _check_track(item: Track) -> Track:
|
||||
if not isinstance(item, Track):
|
||||
raise TypeError("Only pomice.Track objects are supported.")
|
||||
|
||||
return item
|
||||
|
||||
@classmethod
|
||||
def _check_track_container(cls, iterable: Iterable) -> List[Track]:
|
||||
iterable = list(iterable)
|
||||
for item in iterable:
|
||||
cls._check_track(item)
|
||||
|
||||
return iterable
|
||||
|
||||
@property
|
||||
def count(self) -> int:
|
||||
"""Returns queue member count."""
|
||||
return len(self._queue)
|
||||
|
||||
@property
|
||||
def is_empty(self) -> bool:
|
||||
"""Returns True if queue has no members."""
|
||||
return not bool(self.count)
|
||||
|
||||
@property
|
||||
def is_full(self) -> bool:
|
||||
"""Returns True if queue item count has reached max_size."""
|
||||
return False if self.max_size is None else self.count >= self.max_size
|
||||
|
||||
@property
|
||||
def is_looping(self) -> bool:
|
||||
"""Returns True if the queue is looping either a track or the queue"""
|
||||
return bool(self._loop_mode)
|
||||
|
||||
@property
|
||||
def loop_mode(self) -> LoopMode:
|
||||
"""Returns the LoopMode enum set in the queue object"""
|
||||
return self._loop_mode
|
||||
|
||||
@property
|
||||
def size(self) -> int:
|
||||
"""Returns the amount of items in the queue"""
|
||||
return len(self._queue)
|
||||
|
||||
|
||||
|
||||
def get_queue(self) -> List:
|
||||
"""Returns the queue as a List"""
|
||||
return self._queue
|
||||
|
||||
|
||||
def get(self) -> Track:
|
||||
"""Return next immediately available item in queue if any.
|
||||
Raises QueueEmpty if no items in queue.
|
||||
"""
|
||||
|
||||
if self._loop_mode == LoopMode.TRACK:
|
||||
return self._current_item
|
||||
|
||||
if self.is_empty:
|
||||
raise QueueEmpty("No items in the queue.")
|
||||
|
||||
if self._loop_mode == LoopMode.QUEUE:
|
||||
|
||||
# recurse if the item isnt in the queue
|
||||
if self._current_item not in self._queue:
|
||||
self.get()
|
||||
|
||||
# set current item to first track in queue if not set already
|
||||
if not self._current_item:
|
||||
self._current_item = self._queue[0]
|
||||
item = self._current_item
|
||||
|
||||
# we reached the end of the queue, go back to first track
|
||||
if self._index(self._current_item) == len(self._queue) - 1:
|
||||
item = self._queue[0]
|
||||
|
||||
# we are in the middle of the queue, go the next item
|
||||
else:
|
||||
index = self._index(self._current_item) + 1
|
||||
item = self._queue[index]
|
||||
else:
|
||||
item = self._get()
|
||||
|
||||
self._current_item = item
|
||||
return item
|
||||
|
||||
def pop(self) -> Track:
|
||||
"""Return item from the right end side of the queue.
|
||||
Raises QueueEmpty if no items in queue.
|
||||
"""
|
||||
if self.is_empty:
|
||||
raise QueueEmpty("No items in the queue.")
|
||||
|
||||
return self._queue.pop()
|
||||
|
||||
def remove(self, item: Track) -> None:
|
||||
"""
|
||||
Removes a item within the queue.
|
||||
Raises ValueError if item is not in queue.
|
||||
"""
|
||||
return self._remove(self._index(self._check_track(item)))
|
||||
|
||||
|
||||
def find_position(self, item: Track) -> int:
|
||||
"""Find the position a given item within the queue.
|
||||
Raises ValueError if item is not in queue.
|
||||
"""
|
||||
return self._index(self._check_track(item))
|
||||
|
||||
def put(self, item: Track) -> None:
|
||||
"""Put the given item into the back of the queue."""
|
||||
if self.is_full:
|
||||
if not self._overflow:
|
||||
raise QueueFull(f"Queue max_size of {self.max_size} has been reached.")
|
||||
|
||||
self._drop()
|
||||
|
||||
return self._put(self._check_track(item))
|
||||
|
||||
def put_at_index(self, index: int, item: Track) -> None:
|
||||
"""Put the given item into the queue at the specified index."""
|
||||
if self.is_full:
|
||||
if not self._overflow:
|
||||
raise QueueFull(f"Queue max_size of {self.max_size} has been reached.")
|
||||
|
||||
self._drop()
|
||||
|
||||
return self._insert(index, self._check_track(item))
|
||||
|
||||
def put_at_front(self, item: Track) -> None:
|
||||
"""Put the given item into the front of the queue."""
|
||||
return self.put_at_index(0, item)
|
||||
|
||||
def extend(self, iterable: Iterable[Track], *, atomic: bool = True) -> None:
|
||||
"""
|
||||
Add the members of the given iterable to the end of the queue.
|
||||
If atomic is set to True, no tracks will be added upon any exceptions.
|
||||
If atomic is set to False, as many tracks will be added as possible.
|
||||
When overflow is enabled for the queue, `atomic=True` won't prevent dropped items.
|
||||
"""
|
||||
if atomic:
|
||||
iterable = self._check_track_container(iterable)
|
||||
|
||||
if not self._overflow and self.max_size is not None:
|
||||
new_len = len(iterable)
|
||||
|
||||
if (new_len + self.count) > self.max_size:
|
||||
raise QueueFull(
|
||||
f"Queue has {self.count}/{self.max_size} items, "
|
||||
f"cannot add {new_len} more."
|
||||
)
|
||||
|
||||
for item in iterable:
|
||||
self.put(item)
|
||||
|
||||
def copy(self) -> Queue:
|
||||
"""Create a copy of the current queue including it's members."""
|
||||
new_queue = self.__class__(max_size=self.max_size)
|
||||
new_queue._queue = copy(self._queue)
|
||||
|
||||
return new_queue
|
||||
|
||||
def clear(self) -> None:
|
||||
"""Remove all items from the queue."""
|
||||
self._queue.clear()
|
||||
|
||||
def set_loop_mode(self, mode: LoopMode):
|
||||
"""
|
||||
Sets the loop mode of the queue.
|
||||
Takes the LoopMode enum as an argument.
|
||||
"""
|
||||
self._loop_mode = mode
|
||||
if self._loop_mode == LoopMode.QUEUE:
|
||||
try:
|
||||
index = self._index(self._current_item)
|
||||
except ValueError:
|
||||
index = 0
|
||||
if self._current_item not in self._queue:
|
||||
self._queue.insert(index, self._current_item)
|
||||
self._current_item = self._queue[index]
|
||||
|
||||
|
||||
def disable_loop(self):
|
||||
"""
|
||||
Disables loop mode if set.
|
||||
Raises QueueException if loop mode is already None.
|
||||
"""
|
||||
if not self._loop_mode:
|
||||
raise QueueException("Queue loop is already disabled.")
|
||||
|
||||
if self._loop_mode == LoopMode.QUEUE:
|
||||
index = self.find_position(self._current_item) + 1
|
||||
self._queue = self._queue[index:]
|
||||
|
||||
self._loop_mode = None
|
||||
|
||||
|
||||
def shuffle(self):
|
||||
"""Shuffles the queue."""
|
||||
return random.shuffle(self._queue)
|
||||
Loading…
Reference in New Issue