Skip to content

Add plugin support #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/lavalink.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ Models
.. autoclass:: DefaultPlayer
:members:

.. autoclass:: Plugin
:members:

Node
----
.. autoclass:: Node
Expand Down
22 changes: 20 additions & 2 deletions lavalink/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@
import random
from collections import defaultdict
from inspect import getmembers, ismethod
from typing import Set, Union
from typing import List, Set, Union
from urllib.parse import quote

import aiohttp

from .errors import AuthenticationError, NodeError
from .events import Event
from .models import DefaultPlayer, LoadResult, Source
from .models import DefaultPlayer, LoadResult, Plugin, Source
from .node import Node
from .nodemanager import NodeManager
from .playermanager import PlayerManager
Expand Down Expand Up @@ -329,6 +329,24 @@ async def routeplanner_free_all_failing(self, node: Node) -> bool:
return await self._post_request('{}/routeplanner/free/all'.format(node.http_uri),
headers={'Authorization': node.password})

async def get_node_plugins(self, node: Node) -> List[Plugin]:
"""|coro|
Retrieves a list of plugins active on the target node.

Parameters
----------
node: :class:`Node`
The node to use for the query.

Returns
-------
List[:class:`Plugin`]
A list of Plugins active on the target node.
"""
data = await self._get_request('{}/plugins'.format(node.http_uri),
headers={'Authorization': node.password})
return [Plugin(plugin) for plugin in data]

async def voice_update_handler(self, data):
"""|coro|
This function intercepts websocket data from your Discord library and
Expand Down
29 changes: 29 additions & 0 deletions lavalink/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -985,3 +985,32 @@ async def change_node(self, node):

def __repr__(self):
return '<DefaultPlayer volume={0.volume} current={0.current}>'.format(self)


class Plugin:
"""
Represents a Lavalink server plugin.

Parameters
----------
data: :class:`dict`
The data to initialise a Plugin from.

Attributes
----------
name: :class:`str`
The name of the plugin.
version: :class:`str`
The version of the plugin.
"""
__slots__ = ('name', 'version')

def __init__(self, data: dict):
self.name: str = data['name']
self.version: str = data['version']

def __str__(self):
return '{0.name} v{0.version}'.format(self)

def __repr__(self):
return '<Plugin name={0.name} version={0.version}>'.format(self)
11 changes: 11 additions & 0 deletions lavalink/node.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,17 @@ async def routeplanner_free_all_failing(self):
"""
return await self._manager._lavalink.routeplanner_free_all_failing(self)

async def get_plugins(self):
"""|coro|
Retrieves a list of plugins active on this node.

Returns
-------
List[:class:`Plugin`]
A list of active plugins.
"""
return await self._manager._lavalink.get_node_plugins(self)

async def _dispatch_event(self, event: Event):
"""|coro|
Dispatches the given event to all registered hooks.
Expand Down