sublime_music.ui.util module

sublime_music.ui.util.async_callback(future_fn, before_download=None, on_failure=None)

Defines the async_callback decorator.

When a function is annotated with this decorator, the function becomes the done callback for the given result-generating lambda function. The annotated function will be called with the result of the Result generated by said lambda function.

Parameters

• future_fn (Callable[[...], sublime_music.adapters.manager.Result]) – a function which generates an AdapterManager.Result.

• before_download (Optional[Callable[[Any], None]]) –

• on_failure (Optional[Callable[[Any, Exception], None]]) –

Return type

Callable[[Callable], Callable]

sublime_music.ui.util.diff_model_store(store_to_edit, new_store)

The diff here is that if there are any differences, then we refresh the entire list. This is because it is too hard to do editing.

Parameters

• store_to_edit (Any) –

• new_store (Iterable[Any]) –

sublime_music.ui.util.diff_song_store(store_to_edit, new_store)

Diffing song stores is nice, because we can easily make edits by modifying the underlying store.

Parameters

• store_to_edit (Any) –

• new_store (Iterable[Any]) –

sublime_music.ui.util.dot_join(*items)

Joins the given strings with a dot character. Filters out None values.

>>> dot_join(None, "foo", "bar", None, "baz")
'foo  •  bar  •  baz'

Parameters

items (Any) –

Return type

str

sublime_music.ui.util.format_sequence_duration(duration)

Formats duration in English.

>>> format_sequence_duration(timedelta(seconds=90))
'1 minute, 30 seconds'
>>> format_sequence_duration(timedelta(seconds=(60 * 60 + 120)))
'1 hour, 2 minutes'
>>> format_sequence_duration(None)
'0 seconds'

Parameters

duration (Optional[datetime.timedelta]) –

Return type

str

sublime_music.ui.util.format_song_duration(duration_secs)

Formats the song duration as mins:seconds with the seconds being zero-padded if necessary.

>>> format_song_duration(80)
'1:20'
>>> format_song_duration(62)
'1:02'
>>> format_song_duration(timedelta(seconds=68.2))
'1:08'
>>> format_song_duration(None)
'-:--'

Parameters

duration_secs (Optional[Union[int, datetime.timedelta]]) –

Return type

str

sublime_music.ui.util.get_cached_status_icons(song_ids)

Parameters

song_ids (List[str]) –

Return type

List[str]

sublime_music.ui.util.pluralize(string, number, pluralized_form=None)

Pluralize the given string given the count as a number.

>>> pluralize('foo', 1)
'foo'
>>> pluralize('foo', 2)
'foos'
>>> pluralize('foo', 0)
'foos'

Parameters

• string (str) –

• number (int) –

• pluralized_form (Optional[str]) –

Return type

str

sublime_music.ui.util.show_song_popover(song_ids, x, y, relative_to, offline_mode, position=<enum GTK_POS_BOTTOM of type Gtk.PositionType>, on_download_state_change=<function <lambda>>, on_remove_downloads_click=<function <lambda>>, on_playlist_state_change=<function <lambda>>, show_remove_from_playlist_button=False, extra_menu_items=None)

Parameters

• song_ids (List[str]) –

• x (int) –

• y (int) –

• relative_to (Any) –

• offline_mode (bool) –

• position (gi.repository.Gtk.PositionType) –

• on_download_state_change (Callable[[str], None]) –

• on_remove_downloads_click (Callable[[], Any]) –

• on_playlist_state_change (Callable[[], None]) –

• show_remove_from_playlist_button (bool) –

• extra_menu_items (Optional[List[Tuple[gi.repository.Gtk.ModelButton, Any]]]) –