revil-O/platypush
1
0
Fork 0
forked from platypush/platypush
Code Pull requests Activity

[music.mpd] Removed deprecated actions.

Browse source 
- `setvol` ➡️  `set_volume`
- `seekcur` ➡️  `seek`
- `playlistinfo` ➡️  `get_tracks`
- `listplaylists` ➡️  `get_playlists`
- `listplaylist` ➡️  `get_playlist`
- `listplaylistinfo` ➡️  `get_playlist`
- `playlistadd` ➡️  `add_to_playlist`
- `playlistdelete` ➡️  `remove_from_playlist`
- `playlistmove` ➡️  `playlist_move`
- `playlistclear` ➡️  `playlist_clear`
- `rename` ➡️  `rename_playlist`
- `rm` ➡️  `delete_playlist`

stuff
This commit is contained in:
Fabio Manganiello 2024-03-08 18:58:17 +01:00
parent a3b6d411e4
commit d2e5e5230b
1 changed files with 10 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
platypush/plugins/music/mpd/__init__.py
View file

@ -167,15 +167,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
return self._exec('stop') return self._exec('stop')
return self._exec('play') return self._exec('play')
@action
def playid(self, track_id: str):
"""
Play a track by ID.
:param track_id: Track ID.
"""
return self._exec('playid', track_id)
@action @action
def next(self, *_, **__): def next(self, *_, **__):
"""Play the next track""" """Play the next track"""
@ -186,20 +177,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
"""Play the previous track""" """Play the previous track"""
return self._exec('previous') return self._exec('previous')
@action
def setvol(self, vol: int):
"""
Set the volume.
..warning :: **DEPRECATED**, use :meth:`.set_volume` instead.
:param vol: Volume value (range: 0-100).
"""
self.logger.warning(
'music.mpd.setvol is deprecated, use music.mpd.set_volume instead'
)
return self.set_volume(vol)
@action @action
def set_volume(self, volume: int, **__): def set_volume(self, volume: int, **__):
""" """
@ -219,7 +196,7 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
step = step or kwargs.get('delta') or 5 step = step or kwargs.get('delta') or 5
volume = int(self._status()['volume']) volume = int(self._status()['volume'])
new_volume = min(volume + step, 100) new_volume = min(volume + step, 100)
return self.setvol(new_volume) return self.set_volume(new_volume)
@action @action
def voldown(self, step: Optional[float] = None, **kwargs): def voldown(self, step: Optional[float] = None, **kwargs):
@ -231,7 +208,7 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
step = step or kwargs.get('delta') or 5 step = step or kwargs.get('delta') or 5
volume = int(self._status()['volume']) volume = int(self._status()['volume'])
new_volume = max(volume - step, 0) new_volume = max(volume - step, 0)
return self.setvol(new_volume) return self.set_volume(new_volume)
def _toggle(self, key: str, value: Optional[bool] = None): def _toggle(self, key: str, value: Optional[bool] = None):
if value is None: if value is None:
@ -334,20 +311,18 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
:return: The modified playlist :return: The modified playlist
""" """
for pos in sorted(positions, key=int, reverse=True): for pos in sorted(positions, key=int, reverse=True):
self._exec('delete', pos) self._exec('delete', pos)
return self.playlistinfo() return self.get_tracks()
@action @action
def rm(self, playlist): def delete_playlist(self, playlist: Union[str, Collection[str]]):
""" """
Permanently remove playlist(s) by name Permanently remove playlist(s) by name
:param playlist: Name or list of playlist names to remove :param playlist: Name or list of playlist names to remove
:type playlist: str or list[str] :type playlist: str or list[str]
""" """
if isinstance(playlist, str): if isinstance(playlist, str):
playlist = [playlist] playlist = [playlist]
elif not isinstance(playlist, list): elif not isinstance(playlist, list):
@ -409,19 +384,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
"""Clear the current playlist""" """Clear the current playlist"""
return self._exec('clear') return self._exec('clear')
@action
def seekcur(self, value: float):
"""
Seek to the specified position (DEPRECATED, use :meth:`.seek` instead).
:param value: Seek position in seconds, or delta string (e.g. '+15' or
'-15') to indicate a seek relative to the current position
"""
self.logger.warning(
'music.mpd.seekcur is deprecated, use music.mpd.seek instead'
)
return self.seek(value)
@action @action
def seek(self, position: float, **__): def seek(self, position: float, **__):
""" """
@ -537,7 +499,7 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
return self._current_track() return self._current_track()
@action @action
def playlistinfo(self): def get_tracks(self, *_, **__):
""" """
:returns: The tracks in the current playlist as a list of dicts. :returns: The tracks in the current playlist as a list of dicts.
@ -572,7 +534,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
}, },
] ]
""" """
return self._exec('playlistinfo', return_status=False) return self._exec('playlistinfo', return_status=False)
@action @action
@ -602,20 +563,10 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
) )
return sorted(playlists, key=lambda p: p['playlist']) return sorted(playlists, key=lambda p: p['playlist'])
@action
def listplaylists(self):
"""
Deprecated alias for :meth:`.playlists`.
"""
self.logger.warning(
'music.mpd.listplaylists is deprecated, use music.mpd.get_playlists instead'
)
return self.get_playlists()
@action @action
def get_playlist(self, playlist: str, *_, with_tracks: bool = False, **__): def get_playlist(self, playlist: str, *_, with_tracks: bool = False, **__):
""" """
List the items in the specified playlist. List the information (and, optionally, the items) for the specified playlist.
:param playlist: Name of the playlist :param playlist: Name of the playlist
:param with_tracks: If True then the list of tracks in the playlist will :param with_tracks: If True then the list of tracks in the playlist will
@ -627,26 +578,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
return_status=False, return_status=False,
) )
@action
def listplaylist(self, name: str):
"""
Deprecated alias for :meth:`.playlist`.
"""
self.logger.warning(
'music.mpd.listplaylist is deprecated, use music.mpd.get_playlist instead'
)
return self._exec('listplaylist', name, return_status=False)
@action
def listplaylistinfo(self, name: str):
"""
Deprecated alias for :meth:`.playlist` with ``with_tracks=True``.
"""
self.logger.warning(
'music.mpd.listplaylistinfo is deprecated, use music.mpd.get_playlist instead'
)
return self.get_playlist(name, with_tracks=True)
@action @action
def add_to_playlist( def add_to_playlist(
self, playlist: str, resources: Union[str, Collection[str]], **_ self, playlist: str, resources: Union[str, Collection[str]], **_
@ -664,16 +595,6 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
for res in resources: for res in resources:
self._exec('playlistadd', playlist, res) self._exec('playlistadd', playlist, res)
@action
def playlistadd(self, name: str, uri: str):
"""
Deprecated alias for :meth:`.add_to_playlist`.
"""
self.logger.warning(
'music.mpd.playlistadd is deprecated, use music.mpd.add_to_playlist instead'
)
return self.add_to_playlist(name, uri)
@action @action
def remove_from_playlist( def remove_from_playlist(
self, playlist: str, resources: Union[int, Collection[int]], *_, **__ self, playlist: str, resources: Union[int, Collection[int]], *_, **__
@ -705,27 +626,7 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
self._exec('playlistmove', playlist, from_pos, to_pos) self._exec('playlistmove', playlist, from_pos, to_pos)
@action @action
def playlistdelete(self, name: str, pos: int): def playlist_clear(self, name: str):
"""
Deprecated alias for :meth:`.remove_from_playlist`.
"""
self.logger.warning(
'music.mpd.playlistdelete is deprecated, use music.mpd.remove_from_playlist instead'
)
return self.remove_from_playlist(name, pos)
@action
def playlistmove(self, name: str, from_pos: int, to_pos: int):
"""
Deprecated alias for :meth:`.playlist_move`.
"""
self.logger.warning(
'music.mpd.playlistmove is deprecated, use music.mpd.playlist_move instead'
)
return self.playlist_move(name, from_pos=from_pos, to_pos=to_pos)
@action
def playlistclear(self, name: str):
""" """
Clears all the elements from the specified playlist. Clears all the elements from the specified playlist.
@ -734,14 +635,14 @@ class MusicMpdPlugin(MusicPlugin, RunnablePlugin):
self._exec('playlistclear', name) self._exec('playlistclear', name)
@action @action
def rename(self, name: str, new_name: str): def rename_playlist(self, playlist: str, new_name: str):
""" """
Rename a playlist. Rename a playlist.
:param name: Original playlist name :param playlist: Original playlist name or URI
:param new_name: New playlist name :param new_name: New playlist name
""" """
self._exec('rename', name, new_name) self._exec('rename', playlist, new_name)
@action @action
def lsinfo(self, uri: Optional[str] = None): def lsinfo(self, uri: Optional[str] = None):