pylav.storage.models package

Subpackages

• pylav.storage.models.node package
  • Submodules
  • pylav.storage.models.node.mocked module
    • NodeMock
      • NodeMock.add_to_disabled_sources()
      • NodeMock.bulk_add_to_disabled_sources()
      • NodeMock.bulk_remove_from_disabled_sources()
      • NodeMock.create_managed()
      • NodeMock.data
      • NodeMock.delete()
      • NodeMock.exists()
      • NodeMock.fetch_all()
      • NodeMock.fetch_disabled_sources()
      • NodeMock.fetch_extras()
      • NodeMock.fetch_managed()
      • NodeMock.fetch_name()
      • NodeMock.fetch_reconnect_attempts()
      • NodeMock.fetch_resume_timeout()
      • NodeMock.fetch_search_only()
      • NodeMock.fetch_session()
      • NodeMock.fetch_ssl()
      • NodeMock.fetch_yaml()
      • NodeMock.get_cache_key()
      • NodeMock.get_connection_args()
      • NodeMock.id
      • NodeMock.remove_from_disabled_sources()
      • NodeMock.session_id
      • NodeMock.update_disabled_sources()
      • NodeMock.update_extras()
      • NodeMock.update_managed()
      • NodeMock.update_name()
      • NodeMock.update_reconnect_attempts()
      • NodeMock.update_resume_timeout()
      • NodeMock.update_search_only()
      • NodeMock.update_session()
      • NodeMock.update_ssl()
      • NodeMock.update_yaml()
  • pylav.storage.models.node.real module
    • Node
      • Node.add_to_disabled_sources()
      • Node.bulk_add_to_disabled_sources()
      • Node.bulk_remove_from_disabled_sources()
      • Node.bulk_update()
      • Node.create_managed()
      • Node.delete()
      • Node.exists()
      • Node.fetch_all()
      • Node.fetch_disabled_sources()
      • Node.fetch_extras()
      • Node.fetch_managed()
      • Node.fetch_name()
      • Node.fetch_reconnect_attempts()
      • Node.fetch_resume_timeout()
      • Node.fetch_search_only()
      • Node.fetch_session()
      • Node.fetch_ssl()
      • Node.fetch_yaml()
      • Node.get_cache_key()
      • Node.get_connection_args()
      • Node.id
      • Node.remove_from_disabled_sources()
      • Node.update_disabled_sources()
      • Node.update_extras()
      • Node.update_managed()
      • Node.update_name()
      • Node.update_reconnect_attempts()
      • Node.update_resume_timeout()
      • Node.update_search_only()
      • Node.update_session()
      • Node.update_ssl()
      • Node.update_yaml()
  • Module contents
• pylav.storage.models.player package
  • Submodules
  • pylav.storage.models.player.config module
    • PlayerConfig
      • PlayerConfig.add_to_dj_roles()
      • PlayerConfig.add_to_dj_users()
      • PlayerConfig.bot
      • PlayerConfig.bulk_add_dj_roles()
      • PlayerConfig.bulk_add_dj_users()
      • PlayerConfig.bulk_remove_dj_roles()
      • PlayerConfig.bulk_remove_dj_users()
      • PlayerConfig.create_global()
      • PlayerConfig.delete()
      • PlayerConfig.dj_roles_reset()
      • PlayerConfig.dj_users_reset()
      • PlayerConfig.exists()
      • PlayerConfig.fetch_all()
      • PlayerConfig.fetch_alone_dc()
      • PlayerConfig.fetch_alone_pause()
      • PlayerConfig.fetch_auto_play()
      • PlayerConfig.fetch_auto_play_playlist_id()
      • PlayerConfig.fetch_auto_shuffle()
      • PlayerConfig.fetch_dj_roles()
      • PlayerConfig.fetch_dj_users()
      • PlayerConfig.fetch_effects()
      • PlayerConfig.fetch_empty_queue_dc()
      • PlayerConfig.fetch_extras()
      • PlayerConfig.fetch_forced_channel_id()
      • PlayerConfig.fetch_max_volume()
      • PlayerConfig.fetch_notify_channel_id()
      • PlayerConfig.fetch_repeat_current()
      • PlayerConfig.fetch_repeat_queue()
      • PlayerConfig.fetch_self_deaf()
      • PlayerConfig.fetch_shuffle()
      • PlayerConfig.fetch_text_channel_id()
      • PlayerConfig.fetch_volume()
      • PlayerConfig.get_cache_key()
      • PlayerConfig.id
      • PlayerConfig.is_dj()
      • PlayerConfig.remove_from_dj_roles()
      • PlayerConfig.remove_from_dj_users()
      • PlayerConfig.update_alone_dc()
      • PlayerConfig.update_alone_pause()
      • PlayerConfig.update_auto_play()
      • PlayerConfig.update_auto_play_playlist_id()
      • PlayerConfig.update_auto_shuffle()
      • PlayerConfig.update_effects()
      • PlayerConfig.update_empty_queue_dc()
      • PlayerConfig.update_extras()
      • PlayerConfig.update_forced_channel_id()
      • PlayerConfig.update_max_volume()
      • PlayerConfig.update_notify_channel_id()
      • PlayerConfig.update_repeat_current()
      • PlayerConfig.update_repeat_queue()
      • PlayerConfig.update_self_deaf()
      • PlayerConfig.update_shuffle()
      • PlayerConfig.update_text_channel_id()
      • PlayerConfig.update_volume()
  • pylav.storage.models.player.state module
    • PlayerState
      • PlayerState.auto_play
      • PlayerState.auto_play_playlist_id
      • PlayerState.auto_shuffle
      • PlayerState.bot
      • PlayerState.channel_id
      • PlayerState.current
      • PlayerState.delete()
      • PlayerState.effect_enabled
      • PlayerState.effects
      • PlayerState.extras
      • PlayerState.forced_channel_id
      • PlayerState.get()
      • PlayerState.get_cache_key()
      • PlayerState.history
      • PlayerState.id
      • PlayerState.notify_channel_id
      • PlayerState.paused
      • PlayerState.pk
      • PlayerState.playing
      • PlayerState.position
      • PlayerState.queue
      • PlayerState.repeat_current
      • PlayerState.repeat_queue
      • PlayerState.save()
      • PlayerState.self_deaf
      • PlayerState.shuffle
      • PlayerState.text_channel_id
      • PlayerState.volume
  • Module contents

Submodules

pylav.storage.models.config module

class pylav.storage.models.config.Config(*args: 'Any', **kwargs: 'Any')

Bases: CachedModel

bot

async delete()

Delete the config from the database

async exists()

Check if the config exists.

Returns:

Whether the config exists.

Return type:

bool

async fetch_all()

Update all attributed for the config from the database.

Returns:

The updated config.

Return type:

Config

async fetch_auto_update_managed_nodes()

Fetch the auto_update_managed_nodes.

Returns:

The auto_update_managed_nodes.

Return type:

bool

async fetch_config_folder()

Fetch the config folder.

Returns:

The config folder.

Return type:

str

async fetch_download_id()

Fetch the download_id.

Returns:

The download_id.

Return type:

str

async fetch_enable_managed_node()

Fetch the enable_managed_node.

Returns:

The enable_managed_node.

Return type:

bool

async fetch_extras()

Fetch the extras.

Returns:

The extras.

Return type:

dict

async fetch_java_path()

Fetch the java path.

Returns:

The java path.

Return type:

str

async fetch_localtrack_folder()

Fetch the localtrack folder.

Returns:

The localtrack folder.

Return type:

str

async fetch_next_execution_update_bundled_external_playlists()

Fetch the next_execution_update_bundled_external_playlists.

Returns:

The next_execution_update_bundled_external_playlists.

Return type:

datetime.datetime

async fetch_next_execution_update_bundled_playlists()

Fetch the next_execution_update_bundled_playlists.

Returns:

The next_execution_update_bundled_playlists.

Return type:

datetime.datetime

async fetch_next_execution_update_external_playlists()

Fetch the next_execution_update_external_playlists.

Returns:

The next_execution_update_external_playlists.

Return type:

datetime.datetime

async fetch_update_bot_activity()

Fetch the update_bot_activity.

Returns:

The update_bot_activity.

Return type:

bool

async fetch_use_bundled_lava_link_external()

Fetch the use_bundled_lava_link_external.

Returns:

The use_bundled_lava_link_external.

Return type:

bool

async fetch_use_bundled_pylav_external()

Fetch the use_bundled_pylav_external.

Returns:

The use_bundled_pylav_external.

Return type:

bool

get_cache_key()

id

async update_auto_update_managed_nodes(auto_update_managed_nodes)

Update the auto_update_managed_nodes.

Parameters:

auto_update_managed_nodes – The new auto_update_managed_nodes.

async update_config_folder(config_folder)

Update the config folder.

Parameters:

config_folder – The new config folder.

async update_download_id(download_id)

Update the download_id.

Parameters:

download_id – The new download_id.

async update_enable_managed_node(enable_managed_node)

Update the enable_managed_node.

Parameters:

enable_managed_node – The new enable_managed_node.

async update_extras(extras)

Update the extras.

Parameters:

extras – The new extras.

async update_java_path(java_path)

Update the java path.

Parameters:

java_path – The new java path.

async update_localtrack_folder(localtrack_folder)

Update the localtrack folder.

Parameters:

localtrack_folder – The new localtrack folder.

async update_next_execution_update_bundled_external_playlists(next_execution)

Update the next_execution_update_bundled_external_playlists.

Parameters:

next_execution – The new next_execution.

async update_next_execution_update_bundled_playlists(next_execution)

Update the next_execution_update_bundled_playlists.

Parameters:

next_execution – The new next_execution_update_bundled_playlists.

async update_next_execution_update_external_playlists(next_execution)

Update the next_execution_update_external_playlists.

Parameters:

next_execution – The new next_execution.

async update_update_bot_activity(update_bot_activity)

Update the update_bot_activity.

Parameters:

update_bot_activity – The new update_bot_activity.

async update_use_bundled_lava_link_external(use_bundled_lava_link_external)

Update the use_bundled_lava_link_external.

Parameters:

use_bundled_lava_link_external – The new use_bundled_lava_link_external.

async update_use_bundled_pylav_external(use_bundled_pylav_external)

Update the use_bundled_pylav_external.

Parameters:

use_bundled_pylav_external – The new use_bundled_pylav_external.

pylav.storage.models.equilizer module

class pylav.storage.models.equilizer.Equalizer(*, id: 'int', scope: 'int', author: 'int', name: 'str | None' = None, description: 'str | None' = None, band_25: 'float | None' = None, band_40: 'float | None' = None, band_63: 'float | None' = None, band_100: 'float | None' = None, band_160: 'float | None' = None, band_250: 'float | None' = None, band_400: 'float | None' = None, band_630: 'float | None' = None, band_1000: 'float | None' = None, band_1600: 'float | None' = None, band_2500: 'float | None' = None, band_4000: 'float | None' = None, band_6300: 'float | None' = None, band_10000: 'float | None' = None, band_16000: 'float | None' = None)

Bases: CachedModel

author

band_100

band_1000

band_10000

band_160

band_1600

band_16000

band_25

band_250

band_2500

band_40

band_400

band_4000

band_63

band_630

band_6300

async can_manage(bot, requester)

Check if the requester can manage the equalizer.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot.

• requester (discord.abc.User) – The requester.

Returns:

If the requester can manage the equalizer.

Return type:

bool

async delete()

Delete the equalizer from the database

description

classmethod from_dict(data)

Deserialize a Equalizer from a dict.

Parameters:

data (dict) – The data to use to build the Equalizer

Returns:

The Equalizer

Return type:

Equalizer

classmethod from_filter(equalizer, context, scope, description=None)

Deserialize a Equalizer from a Filter.

Parameters:

• equalizer (Equalizer) – The filter object

• context (PyLavContext) – The Context

• scope (int) – The scope number

• description (str) – The description of the Equalizer

Returns:

The Equalizer built from the Equalizer object

Return type:

Equalizer

async classmethod from_yaml(context, scope, url)

Deserialize a Equalizer from a YAML file.

Parameters:

• context (PyLavContext) – The context.

• scope (int) – The scope.

• url (str) – The URL to the YAML file.

Returns:

The Equalizer.

Return type:

Equalizer

async classmethod get(identifier)

Get an equalizer from the database.

Parameters:

identifier (int) – The id of the equalizer.

Returns:

The equalizer if found, else None.

Return type:

Equalizer | None

async get_author_name(bot, mention=True)

Get the name of the author.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot.

• mention (bool) – If the name should be mentionable.

Returns:

The name of the author.

Return type:

str | None

get_cache_key()

async get_scope_name(bot, mention=True, guild=None)

Get the name of the scope.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot.

• mention (bool) – If the name should be mentionable.

• guild (discord.Guild | None) – The guild.

Returns:

The name of the scope.

Return type:

str

id

name

async save()

Save the Equalizer to the database.

Returns:

The Equalizer.

Return type:

Equalizer

scope

to_dict()

Serialize the Equalizer to a dict.

Returns:

The dict representation of the Equalizer.

Return type:

dict

to_filter()

Serialize the Equalizer to a Filter.

Returns:

The filter representation of the Equalizer

Return type:

Equalizer

to_yaml(guild)

Serialize the Equalizer to a YAML file.

yields a tuple of (io.BytesIO, bool) where the bool is whether the playlist file was compressed using Gzip

Parameters:

guild (discord.Guild) – The guild.

Yields:

tuple[io.BytesIO, str | None] – The YAML file and the compression type.

pylav.storage.models.playlist module

class pylav.storage.models.playlist.Playlist(*args: 'Any', **kwargs: 'Any')

Bases: CachedModel

async add_track(tracks)

Add a track to the playlist.

Parameters:

tracks (list[str | Track]) – The tracks to add.

async bulk_remove_tracks(tracks)

Remove disc jockey users from the player.

Parameters:

tracks (list[str]) – The track to remove

async bulk_update(scope, name, author, url, tracks)

Bulk update the playlist.

async can_manage(bot, requester)

Check if the requester can manage the playlist.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot instance.

• requester (discord.abc.User) – The requester.

Returns:

Whether the requester can manage the playlist.

Return type:

bool

async delete()

Delete the playlist from the database

async exists()

Check if the config exists.

Returns:

Whether the config exists.

Return type:

bool

async fetch_all()

Fetch all playlists from the database.

Returns:

The playlists.

Return type:

dict

async fetch_author()

Fetch the author of the playlist.

Returns:

The author of the playlist.

Return type:

int

async fetch_first()

Get the first track.

Returns:

The first track

Return type:

str

async fetch_index(index)

Get the track at the index.

Parameters:

index (int) – The index of the track

Returns:

The track at the index

Return type:

str

async fetch_name()

Fetch the name of the playlist.

Returns:

The name of the playlist.

Return type:

str

async fetch_random()

Get a random track.

Returns:

A random track

Return type:

str

async fetch_scope()

Fetch the scope of the playlist.

Returns:

The scope of the playlist.

Return type:

int

async fetch_tracks()

Fetch the tracks of the playlist.

Returns:

The tracks of the playlist.

Return type:

list[str]

async fetch_url()

Fetch the url of the playlist.

Returns:

The url of the playlist.

Return type:

str

async classmethod from_yaml(context, scope, url)

Deserialize a playlist from a YAML file.

Parameters:

• context (PyLavContext) – The context.

• scope (int) – The scope of the playlist.

• url (str) – The url of the playlist.

Returns:

The playlist.

Return type:

Playlist

async get_author_name(bot, mention=True)

Get the name of the author of the playlist.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot instance.

• mention (bool) – Whether to add a mention if it is mentionable.

Returns:

The name of the author of the playlist.

Return type:

str | None

get_cache_key()

async get_name_formatted(with_url=True, escape=True)

Get the name of the playlist formatted.

Parameters:

• with_url (bool) – Whether to include the url in the name.

• escape (bool) – Whether to markdown escape the response

Returns:

The formatted name.

Return type:

str

async get_scope_name(bot, mention=True, guild=None)

Get the name of the scope of the playlist.

Parameters:

• bot (DISCORD_BOT_TYPE) – The bot instance.

• mention (bool) – Whether to add a mention if it is mentionable.

• guild (discord.Guild) – The guild to get the scope name for.

Returns:

The name of the scope of the playlist.

Return type:

str

id

async remove_all_tracks()

Remove all tracks from the playlist.

async remove_track(track)

Remove a track from the playlist.

Parameters:

track (str) – The track to remove

async size()

Count the tracks of the playlist.

Returns:

The number of tracks in the playlist.

Return type:

int

to_yaml(guild)

Serialize the playlist to a YAML file.

yields a tuple of (io.BytesIO, bool) where the bool is whether the playlist file was compressed using Gzip

Parameters:

guild (discord.Guild) – The guild where the yaml will be sent to.

Yields:

tuple[io.BytesIO, str | None] – The YAML file and the compression type.

async update_author(author)

Update the author of the playlist.

Parameters:

author (int) – The new author of the playlist.

async update_name(name)

Update the name of the playlist.

Parameters:

name (str) – The new name of the playlist.

async update_scope(scope)

Update the scope of the playlist.

Parameters:

scope (int) – The new scope of the playlist.

async update_tracks(tracks)

Update the tracks of the playlist.

Parameters:

tracks (list[str]) – The new tracks of the playlist.

async update_url(url)

Update the url of the playlist.

Parameters:

url (str) – The new url of the playlist.

pylav.storage.models.query module

class pylav.storage.models.query.Query(*args: 'Any', **kwargs: 'Any')

Bases: CachedModel

async bulk_update(tracks, name, info=None, plugin_info=None)

Bulk update the query.

Parameters:

• tracks (list[str | Track]) – The tracks of the playlist.

• name (str) – The name of the playlist

async delete()

Delete the query from the database

async exists()

Check if the config exists.

Returns:

Whether the config exists.

Return type:

bool

async fetch_bulk(info=False, name=False, pluginInfo=False, tracks=False)

Get all tracks.

Returns:

All tracks

Return type:

list[str]

async fetch_first()

Get the first track.

Returns:

The first track

Return type:

str

async fetch_index(index)

Get the track at the index.

Parameters:

index (int) – The index of the track

Returns:

The track at the index

Return type:

str

async fetch_info()

Get the info of the playlist.

Returns:

The plugin info of the playlist.

Return type:

JSON_DICT_TYPE

async fetch_last_updated()

Get the last updated time of the playlist.

Returns:

The last updated time of the playlist.

Return type:

datetime

async fetch_name()

Get the name of the playlist.

Returns:

The name of the playlist.

Return type:

str

async fetch_plugin_info()

Get the plugin info of the playlist.

Returns:

The plugin info of the playlist.

Return type:

JSON_DICT_TYPE

async fetch_random()

Get a random track.

Returns:

A random track

Return type:

str

async fetch_tracks()

Get the tracks of the playlist.

Returns:

The tracks of the playlist.

Return type:

list[str]

get_cache_key()

id

async size()

Count the tracks of the playlist.

Returns:

The number of tracks in the playlist.

Return type:

int

async update_info(info)

Update the info of the playlist.

Parameters:

info (JSON_DICT_TYPE) – The plugin info of the playlist.

async update_last_updated()

Update the last updated time of the playlist

async update_name(name)

Update the name of the playlist.

Parameters:

name (str) – The name of the playlist.

async update_plugin_info(plugin_info)

Update the plugin info of the playlist.

Parameters:

plugin_info (JSON_DICT_TYPE) – The plugin info of the playlist.

async update_tracks(tracks)

Update the tracks of the playlist.

Parameters:

tracks (list[str | Track]) – The tracks of the playlist.

pylav.storage.models.version module

class pylav.storage.models.version.BotVersion(*args, **kwargs)

Bases: CachedModel

A class to represent the version of the bot in the database

async fetch_version()

Fetch the version of the bot from the database

get_cache_key()

Get the cache key for the bot version.

id

async update_version(version)

Update the version of the bot in the database

Module contents