From dd1243a0630532cb0e2f0635ef2269cba874816c Mon Sep 17 00:00:00 2001 From: Thiago Kenji Okada Date: Thu, 20 Oct 2016 10:50:30 -0200 Subject: [PATCH] Rename Spotify module to Playerctl Provides a Spotify module, that is simply a wrapper of Playerctl module, for compatibility purposes. --- docs/i3pystatus.rst | 2 +- i3pystatus/playerctl.py | 104 ++++++++++++++++++++++++++++++++++++++++ i3pystatus/spotify.py | 104 ++-------------------------------------- 3 files changed, 109 insertions(+), 101 deletions(-) create mode 100644 i3pystatus/playerctl.py diff --git a/docs/i3pystatus.rst b/docs/i3pystatus.rst index a2bf7e2..882d801 100644 --- a/docs/i3pystatus.rst +++ b/docs/i3pystatus.rst @@ -11,7 +11,7 @@ Module reference :Audio: `alsa`_ - `pulseaudio`_ :Hardware: `backlight`_ - `battery`_ - `temp`_ :Network: `net_speed`_ - `network`_ - `online`_ - `openstack_vms`_ - `openvpn`_ -:Music: `cmus`_ - `moc`_ - `mpd`_ - `now_playing`_ - `pianobar`_ - `spotify`_ +:Music: `cmus`_ - `moc`_ - `mpd`_ - `now_playing`_ - `pianobar`_ - `playerctl`_ - `spotify`_ :Websites: `bitcoin`_ - `dota2wins`_ - `github`_ - `modsde`_ - `parcel`_ - `reddit`_ - `weather`_ - `whosonlocation`_ :Other: `anybar`_ - `mail`_ - `pomodoro`_ - `pyload`_ - `text`_ - `updates`_ diff --git a/i3pystatus/playerctl.py b/i3pystatus/playerctl.py new file mode 100644 index 0000000..d0afc41 --- /dev/null +++ b/i3pystatus/playerctl.py @@ -0,0 +1,104 @@ +from i3pystatus import formatp +from i3pystatus import IntervalModule +from i3pystatus.core.util import TimeWrapper + +import gi +gi.require_version('Playerctl', '1.0') # nopep8 +from gi.repository import Playerctl as pctl + + +class Playerctl(IntervalModule): + """ + Gets current music information from a playerctl supported player. + + .. rubric:: Available formatters + + * `{status}` — current status icon (paused/playing/stopped) + * `{length}` — total song duration, uses TimeWrapper formatting, default format is `%E%l:%M:%S` + * `{artist}` — artist + * `{title}` — title + * `{album}` — album + """ + + settings = ( + ('format', 'formatp string'), + ('format_not_running', 'Text to show if player is not running'), + ('color', 'The color of the text'), + ('color_not_running', 'The color of the text, when player is not running'), + ('status', 'Dictionary mapping status to output'), + ('player_name', + 'Name of music player, use `playerctl -l` with player running to get. If None, tries to autodetect.'), + ) + + # default settings + color = '#ffffff' + color_not_running = '#ffffff' + format = '{status} {length} {artist} - {title}' + format_not_running = 'Not running' + status = { + 'paused': '▷', + 'playing': '▶', + 'stopped': '■', + } + player_name = None + + on_leftclick = 'playpause' + on_rightclick = 'next_song' + on_upscroll = 'next_song' + on_downscroll = 'previous_song' + + def _get_length_in_secs(self, metadata): + if not metadata: + return 0 + try: + time = metadata["mpris:length"] / 1.0e6 + seconds = round(time) + return seconds + except KeyError: + return 0 + + def get_formatted_info(self, player): + """Get player track info from playerctl""" + + result = { + "status": "", + "artist": "", + "title": "", + "album": "", + "length": "", + } + + status = player.props.status + if status: + result["status"] = self.status.get(status.lower(), "") + result["artist"] = player.get_artist() + result["title"] = player.get_title() + result["album"] = player.get_album() + length_in_secs = self._get_length_in_secs(player.props.metadata) + result["length"] = TimeWrapper(length_in_secs, "%E%l%M:%S") + + return result + + def run(self): + """Main statement, executes all code every interval""" + + self.player = pctl.Player(player_name=self.player_name) + fdict = self.get_formatted_info(self.player) + if fdict.get("status", ""): + self.output = {"full_text": formatp(self.format, **fdict), + "color": self.color} + else: + self.output = {"full_text": self.format_not_running, + "color": self.color_not_running} + + def playpause(self): + """Pauses and plays player""" + self.player.play_pause() + + def next_song(self): + """skips to the next song""" + self.player.next() + + def previous_song(self): + """Plays the previous song""" + self.player.previous() diff --git a/i3pystatus/spotify.py b/i3pystatus/spotify.py index f5cfab3..bd608fe 100644 --- a/i3pystatus/spotify.py +++ b/i3pystatus/spotify.py @@ -1,104 +1,8 @@ -from i3pystatus import formatp -from i3pystatus import IntervalModule -from i3pystatus.core.util import TimeWrapper - -import gi -gi.require_version('Playerctl', '1.0') # nopep8 -from gi.repository import Playerctl +from i3pystatus.playerctl import Playerctl -class Spotify(IntervalModule): +class Spotify(Playerctl): """ - Gets Spotify (or any supported player) info using playerctl - - .. rubric:: Available formatters - - * `{status}` — current status icon (paused/playing/stopped) - * `{length}` — total song duration, uses TimeWrapper formatting, default format is `%E%l:%M:%S` - * `{artist}` — artist - * `{title}` — title - * `{album}` — album + Get Spotify info using playerctl. Based on `Playerctl`_ module. """ - - settings = ( - ('format', 'formatp string'), - ('format_not_running', 'Text to show if player is not running'), - ('color', 'The color of the text'), - ('color_not_running', 'The color of the text, when player is not running'), - ('status', 'Dictionary mapping status to output'), - ('player_name', - 'Name of music player, use `playerctl -l` with player running to get. If None, tries to autodetect.'), - ) - - # default settings - color = '#ffffff' - color_not_running = '#ffffff' - format = '{status} {length} {artist} - {title}' - format_not_running = 'Not running' - status = { - 'paused': '▷', - 'playing': '▶', - 'stopped': '■', - } - player_name = None - - on_leftclick = 'playpause' - on_rightclick = 'next_song' - on_upscroll = 'next_song' - on_downscroll = 'previous_song' - - def _get_length_in_secs(self, metadata): - if not metadata: - return 0 - try: - time = metadata["mpris:length"] / 1.0e6 - seconds = round(time) - return seconds - except KeyError: - return 0 - - def get_formatted_info(self, player): - """Get player track info from playerctl""" - - result = { - "status": "", - "artist": "", - "title": "", - "album": "", - "length": "", - } - - status = player.props.status - if status: - result["status"] = self.status.get(status.lower(), "") - result["artist"] = player.get_artist() - result["title"] = player.get_title() - result["album"] = player.get_album() - length_in_secs = self._get_length_in_secs(player.props.metadata) - result["length"] = TimeWrapper(length_in_secs, "%E%l%M:%S") - - return result - - def run(self): - """Main statement, executes all code every interval""" - - self.player = Playerctl.Player(player_name=self.player_name) - fdict = self.get_formatted_info(self.player) - if fdict.get("status", ""): - self.output = {"full_text": formatp(self.format, **fdict), - "color": self.color} - else: - self.output = {"full_text": self.format_not_running, - "color": self.color_not_running} - - def playpause(self): - """Pauses and plays player""" - self.player.play_pause() - - def next_song(self): - """skips to the next song""" - self.player.next() - - def previous_song(self): - """Plays the previous song""" - self.player.previous() + player_name = "spotify"