Code Reference#

playlist_along.__main__#

Script entry point.

playlist_along.__main__.main()#

Calls ‘cli_main’ click group.

Return type

None

playlist_along.cli#

CLI main click group.

playlist_along.playlist#

Playlist module.

class playlist_along.playlist.Playlist(path=None)#

Playlist object class.

Parameters

path (Optional[str]) –

playlist_along.playlist.clean_m3u_from_extended_tag(content)#

Remove #EXTM3U and empty lines.

Parameters

content (str) –

Return type

str

Delete lines with any links.

Parameters

content (str) –

Return type

str

playlist_along.playlist.copy_local_tracks_to_folder(tracklist, dest)#

Copy local files from list to a new destination.

Parameters

  • tracklist (List[str]) –

  • dest (str) –

Return type

None

playlist_along.playlist.get_full_content_of_playlist(path, encoding=None)#

Return full content (text) of a playlist.

Parameters

  • path (Path) –

  • encoding (Optional[str]) –

Return type

Tuple[str, str]

playlist_along.playlist.get_local_tracks_without_comment_lines(playlist_content)#

Return list of tracks.

Parameters

playlist_content (str) –

Return type

List[str]

playlist_along.playlist.get_only_track_paths_from_m3u(path, encoding=None)#

Return list of paths (without #M3U tags).

Parameters

  • path (Path) –

  • encoding (Optional[str]) –

Return type

List[str]

playlist_along.playlist.get_playlist_for_vlc_android(path)#

Return converted playlist and its encoding.

Parameters

path (Path) –

Return type

Tuple[str, str]

playlist_along.playlist.is_file_too_small(file)#

Return True if file is less than 7 bytes.

Parameters

file (Path) –

Return type

bool

playlist_along.playlist.make_relatives_paths_in_playlist(content)#

Remain only filenames from absolute paths.

Parameters

content (str) –

Return type

str

playlist_along.playlist.save_playlist_content(content, dest, encoding=None, origin=None, yes_dir=None)#

Save playlist content to new destination.

Parameters

  • content (str) –

  • dest (Path) –

  • encoding (Optional[str]) –

  • origin (Optional[Path]) –

  • yes_dir (Optional[bool]) –

Return type

None

playlist_along.playlist.substitute_vlc_invalid_characters(content)#

Substitute [ and ] and # in filenames.

Parameters

content (str) –

Return type

str

playlist_along.playlist.validate_file_callback(ctx, param, value=None)#

Validate supported playlist formats.

Parameters

  • ctx (Context) –

  • param (Union[Option, Parameter]) –

  • value (Optional[Any]) –

Return type

Any