Common segments¶

VCS submodule¶

class powerline.segments.common.vcs.BranchSegment[source]¶

class powerline.segments.common.vcs.StashSegment[source]¶

powerline.segments.common.vcs.branch(ignore_statuses=(), status_colors=False)¶

Return the current VCS branch.

Parameters:

status_colors (bool) – Determines whether repository status will be used to determine highlighting. Default: False.
ignore_statuses (list) – List of statuses which will not result in repo being marked as dirty. Most useful is setting this option to ["U"]: this will ignore repository which has just untracked files (i.e. repository with modified, deleted or removed files will be marked as dirty, while just untracked files will make segment show clean repository). Only applicable if status_colors option is True.

Highlight groups used: branch_clean, branch_dirty, branch.

powerline.segments.common.vcs.stash()¶

Return the number of current VCS stash entries, if any.

Highlight groups used: stash.

System properties¶

class powerline.segments.common.sys.CPULoadPercentSegment[source]¶

powerline.segments.common.sys.cpu_load_percent()¶

Return the average CPU load as a percentage.

Requires the psutil module.

Parameters:: format (str) – Output format. Accepts measured CPU load as the first argument.

Highlight groups used: cpu_load_percent_gradient (gradient) or cpu_load_percent.

powerline.segments.common.sys.system_load()[source]¶

Return system load average.

Highlights using system_load_good, system_load_bad and system_load_ugly highlighting groups, depending on the thresholds passed to the function.

Parameters:

format (str) – format string, receives avg as an argument
threshold_good (float) – threshold for gradient level 0: any normalized load average below this value will have this gradient level.
threshold_bad (float) – threshold for gradient level 100: any normalized load average above this value will have this gradient level. Load averages between threshold_good and threshold_bad receive gradient level that indicates relative position in this interval: (100 * (cur-good) / (bad-good)). Note: both parameters are checked against normalized load averages.
track_cpu_count (bool) – if True powerline will continuously poll the system to detect changes in the number of CPUs.
short (bool) – if True only the sys load over last 1 minute will be displayed.

Divider highlight group used: background:divider.

Highlight groups used: system_load_gradient (gradient) or system_load.

powerline.segments.common.sys.uptime()[source]¶

Return system uptime.

Parameters:

days_format (str) – day format string, will be passed days as the argument
hours_format (str) – hour format string, will be passed hours as the argument
minutes_format (str) – minute format string, will be passed minutes as the argument
seconds_format (str) – second format string, will be passed seconds as the argument
shorten_len (int) – shorten the amount of units (days, hours, etc.) displayed

Divider highlight group used: background:divider.

Network¶

class powerline.segments.common.net.ExternalIpSegment[source]¶

class powerline.segments.common.net.NetworkLoadSegment[source]¶

powerline.segments.common.net.external_ip()¶

Return external IP address.

Parameters:

query_url (str) –

URI to query for IP address, should return only the IP address as a text string

Suggested URIs:

http://ipv4.icanhazip.com/
http://ipv6.icanhazip.com/
http://icanhazip.com/ (returns IPv6 address if available, else IPv4)

Divider highlight group used: background:divider.

powerline.segments.common.net.hostname(exclude_domain=False, only_if_ssh=False)[source]¶

Return the current hostname.

Parameters:

only_if_ssh (bool) – only return the hostname if currently in an SSH session
exclude_domain (bool) – return the hostname without domain if there is one

powerline.segments.common.net.internal_ip()[source]¶

Return internal IP address

Requires netifaces module to work properly.

Parameters:

interface (str) –
Interface on which IP will be checked. Use auto to automatically detect interface. In this case interfaces with lower numbers will be preferred over interfaces with similar names. Order of preference based on names:
1. eth and enp followed by number or the end of string.
2. ath, wlan and wlp followed by number or the end of string.
3. teredo followed by number or the end of string.
4. Any other interface that is not lo*.
5. lo followed by number or the end of string.
Use default_gateway to detect the interface based on the machine’s default gateway (i.e., the router to which it is connected).
ipv (int) – 4 or 6 for ipv4 and ipv6 respectively, depending on which IP address you need exactly.

powerline.segments.common.net.network_load()¶

Return the network load.

Uses the psutil module if available for multi-platform compatibility, falls back to reading /sys/class/net/interface/statistics/rx,tx_bytes.

Parameters:

interface (str) – Network interface to measure (use the special value “auto” to have powerline try to auto-detect the network interface).
suffix (str) – String appended to each load string.
si_prefix (bool) – Use SI prefix, e.g. MB instead of MiB.
recv_format (str) – Format string that determines how download speed should look like. Receives value as argument.
sent_format (str) – Format string that determines how upload speed should look like. Receives value as argument.
recv_max (float) – Maximum number of received bytes per second. Is only used to compute gradient level.
sent_max (float) – Maximum number of sent bytes per second. Is only used to compute gradient level.

Divider highlight group used: network_load:divider.

Highlight groups used: network_load_sent_gradient (gradient) or network_load_recv_gradient (gradient) or network_load_gradient (gradient), network_load_sent or network_load_recv or network_load.

Current environment¶

class powerline.segments.common.env.CwdSegment[source]¶

argspecobjs()[source]¶

Return a list of valid arguments for inspect.getargspec

Used to determine function arguments.

omitted_args(name, method)[source]¶

List arguments which should be omitted

Returns a tuple with indexes of omitted arguments.

powerline.segments.common.env.cwd()¶

Return the current working directory.

Returns a segment list to create a breadcrumb-like effect.

Parameters:

dir_shorten_len (int) – shorten parent directory names to this length (e.g. /long/path/to/powerline → /l/p/t/powerline)
dir_limit_depth (int) – limit directory depth to this number (e.g. /long/path/to/powerline → ⋯/to/powerline)
use_path_separator (bool) – Use path separator in place of soft divider.
shorten_home (bool) – Shorten home directory to ~.
ellipsis (str) – Specifies what to use in place of omitted directories. Use None to not show this subsegment at all.

Divider highlight group used: cwd:divider.

Highlight groups used: cwd:current_folder or cwd. It is recommended to define all highlight groups.

powerline.segments.common.env.environment(variable=None)[source]¶

Return the value of any defined environment variable

Parameters:: variable (string) – The environment variable to return if found

powerline.segments.common.env.user(hide_domain=False, hide_user=None)[source]¶

Return the current user.

Parameters:

hide_user (str) – Omit showing segment for users with names equal to this string.
hide_domain (bool) – Drop domain component if it exists in a username (delimited by ‘@’).

Highlights the user with the superuser if the effective user ID is 0.

Highlight groups used: superuser or user. It is recommended to define all highlight groups.

powerline.segments.common.env.virtualenv(ignored_names=('venv', '.venv'), ignore_conda=False, ignore_venv=False)[source]¶

Return the name of the current Python or conda virtualenv. :param list ignored_names:

Names of venvs to ignore. Will then get the name of the venv by ascending to the parent directory

Parameters:

ignore_venv (bool) – Whether to ignore virtual environments. Default is False.
ignore_conda (bool) – Whether to ignore conda environments. Default is False.

Battery¶

powerline.segments.common.bat.battery()[source]¶

Return battery charge status.

Parameters:

format (str) – Percent format in case gamify is False. Format arguments: ac_state which is equal to either online or offline string arguments and capacity which is equal to current battery capacity in interval [0, 100].
steps (int) – Number of discrete steps to show between 0% and 100% capacity if gamify is True.
gamify (bool) – Measure in hearts (♥) instead of percentages. For full hearts battery_full highlighting group is preferred, for empty hearts there is battery_empty. battery_online or battery_offline group will be used for leading segment containing online or offline argument contents.
full_heart (str) – Heart displayed for “full” part of battery.
empty_heart (str) – Heart displayed for “used” part of battery. It is also displayed using another gradient level and highlighting group, so it is OK for it to be the same as full_heart as long as necessary highlighting groups are defined.
online (str) – Symbol used if computer is connected to a power supply.
offline (str) – Symbol used if computer is not connected to a power supply.

battery_gradient and battery groups are used in any case, first is preferred.

Highlight groups used: battery_full or battery_gradient (gradient) or battery, battery_empty or battery_gradient (gradient) or battery, battery_online or battery_ac_state or battery_gradient (gradient) or battery, battery_offline or battery_ac_state or battery_gradient (gradient) or battery.

Weather¶

class powerline.segments.common.wthr.WeatherSegment[source]¶

powerline.segments.common.wthr.weather()¶

Return weather from OpenWeatherMaps.

Uses GeoIP lookup from https://freegeoip.app to automatically determine your current location. This should be changed if you’re in a VPN or if your IP address is registered at another location.

Returns a list of colorized icon and temperature segments depending on weather conditions.

Parameters:

unit (str) – temperature unit, can be one of F, C or K
location_query (str) – location query for your current location, e.g. oslo, norway
icons (dict) – dict for overriding default icons, e.g. {'heavy_snow' : u'❆'}
temp_format (str) – format string, receives temp as an argument. Should also hold unit.
temp_coldest (float) – coldest temperature. Any temperature below it will have gradient level equal to zero.
temp_hottest (float) – hottest temperature. Any temperature above it will have gradient level equal to 100. Temperatures between temp_coldest and temp_hottest receive gradient level that indicates relative position in this interval (100 * (cur-coldest) / (hottest-coldest)).

Divider highlight group used: background:divider.

Highlight groups used: weather_conditions or weather, weather_temp_gradient (gradient) or weather. Also uses weather_conditions_{condition} for all weather conditions supported by OpenWeatherMap.

Date and time¶

powerline.segments.common.time.date()[source]¶

Return the current date.

Parameters:

format (str) – strftime-style date format string
istime (bool) – If true then segment uses time highlight group.
timezone (string) – Specify a timezone to use as +HHMM or -HHMM. (Defaults to system defaults.)

Divider highlight group used: time:divider.

Highlight groups used: time or date.

powerline.segments.common.time.fuzzy_time()[source]¶

Display the current time as fuzzy time, e.g. “quarter past six”.

Parameters:

format (string) – Format used to display the fuzzy time. (Ignored when a special time is displayed.)
unicode_text (bool) – If true then hyphenminuses (regular ASCII -) and single quotes are replaced with unicode dashes and apostrophes.
timezone (string) – Specify a timezone to use as +HHMM or -HHMM. (Defaults to system defaults.)
hour_str (string list) – Strings to be used to display the hour, starting with midnight. (This list may contain 12 or 24 entries.)
minute_str (dict) – Dictionary mapping minutes to strings to be used to display them.
special_case_str (dict) – Special strings for special times.

Highlight groups used: fuzzy_time.

Mail¶

class powerline.segments.common.mail.EmailIMAPSegment[source]¶

powerline.segments.common.mail.email_imap_alert()¶

Return unread e-mail count for IMAP servers.

Parameters:

username (str) – login username
password (str) – login password
server (str) – e-mail server
port (int) – e-mail server port
folder (str) – folder to check for e-mails
max_msgs (int) – Maximum number of messages. If there are more messages then max_msgs then it will use gradient level equal to 100, otherwise gradient level is equal to 100 * msgs_num / max_msgs. If not present gradient is not computed.
use_ssl (bool) – If True then use SSL connection. If False then do not use it. Default is True if port is equal to 993 and False otherwise.

Highlight groups used: email_alert_gradient (gradient), email_alert.

Media players¶

class powerline.segments.common.players.ClementinePlayerSegment[source]¶

class powerline.segments.common.players.CmusPlayerSegment[source]¶

get_player_status(pl)[source]¶

Return cmus player information.

cmus-remote -Q returns data with multi-level information i.e.: status playing file <file_name> tag artist <artist_name> tag title <track_title> tag .. tag n set continue <true|false> set repeat <true|false> set .. set n

For the information we are looking for we don’t really care if we’re on the tag level or the set level. The dictionary comprehension in this method takes anything in ignore_levels and brings the key inside that to the first level of the dictionary.

class powerline.segments.common.players.DbusPlayerSegment[source]¶

class powerline.segments.common.players.ITunesPlayerSegment[source]¶

class powerline.segments.common.players.MocPlayerSegment[source]¶

get_player_status(pl)[source]¶

Return Music On Console (mocp) player information.

mocp -i returns current information i.e.

File: filename.format
Title: full title
Artist: artist name
SongTitle: song title
Album: album name
TotalTime: 00:00
TimeLeft: 00:00
TotalSec: 000
CurrentTime: 00:00
CurrentSec: 000
Bitrate: 000kbps
AvgBitrate: 000kbps
Rate: 00kHz

For the information we are looking for we don’t really care if we have extra-timing information or bit rate level. The dictionary comprehension in this method takes anything in ignore_info and brings the key inside that to the right info of the dictionary.

class powerline.segments.common.players.MpdPlayerSegment[source]¶

class powerline.segments.common.players.PlayerSegment[source]¶

argspecobjs()[source]¶

Return a list of valid arguments for inspect.getargspec

Used to determine function arguments.

omitted_args(name, method)[source]¶

List arguments which should be omitted

Returns a tuple with indexes of omitted arguments.

class powerline.segments.common.players.RDIOPlayerSegment[source]¶

class powerline.segments.common.players.RhythmboxPlayerSegment[source]¶

class powerline.segments.common.players.SpotifyAppleScriptPlayerSegment[source]¶

class powerline.segments.common.players.SpotifyDbusPlayerSegment[source]¶

powerline.segments.common.players.clementine()¶

Return clementine player information

Requires dbus python module.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.clementine",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.cmus()¶

Return CMUS player information

Requires cmus-remote command be accessible from $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.cmus",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.dbus_player()¶

Return generic dbus player state

Requires dbus python module. Only for players that support specific protocol: (e.g. like spotify() and clementine()).

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.dbus_player",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

player_name (str) – Player name. Used in error messages only.
bus_name (str) – Dbus bus name.
player_path (str) – Path to the player on the given bus.
iface_prop (str) – Interface properties name for use with dbus.Interface.
iface_player (str) – Player name.

powerline.segments.common.players.itunes()¶

Return iTunes now playing information

Requires osascript.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.itunes",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.mocp()¶

Return MOC (Music On Console) player information

Requires version >= 2.3.0 and mocp executable in $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.mocp",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.mpd()¶

Return Music Player Daemon information

Requires mpd Python module (e.g. python-mpd2 or python-mpd Python package) or alternatively the mpc command to be accessible from $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.mpd",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

host (str) – Host on which mpd runs.
password (str) – Password used for connecting to daemon.
port (int) – Port which should be connected to.

powerline.segments.common.players.rdio()¶

Return rdio player information

Requires osascript available in $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.rdio",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.rhythmbox()¶

Return rhythmbox player information

Requires rhythmbox-client available in $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.rhythmbox",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.spotify()¶

Return spotify player information

Requires dbus python module.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.spotify",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.spotify_apple_script()¶

Return spotify player information

Requires osascript available in $PATH.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.spotify_apple_script",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.

powerline.segments.common.players.spotify_dbus()¶

Return spotify player information

Requires dbus python module.

This player segment should be added like this:

{
        "function": "powerline.segments.common.players.spotify",
        "name": "player"
}

(with additional "args": {…} if needed).

Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.

Parameters:

format (str) –

Format used for displaying data from player. Should be a str.format-like string with the following keyword parameters:

Parameter	Description
state_symbol	Symbol displayed for play/pause/stop states. There is also “fallback” state used in case function failed to get player state. For this state symbol is by default empty. All symbols are defined in `state_symbols` argument.
album	Album that is currently played.
artist	Artist whose song is currently played
title	Currently played composition.
elapsed	Composition duration in format M:SS (minutes:seconds).
total	Composition length in format M:SS.

state_symbols (dict) –

Symbols used for displaying state. Must contain all of the following keys:

Key	Description
play	Displayed when player is playing.
pause	Displayed when player is paused.
stop	Displayed when player is not playing anything.
fallback	Displayed if state is not one of the above or not known.