andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

mpd: Add browse() helper docs

Browse Source
This commit is contained in:
Stein Magnus Jodal 2014-12-13 01:26:36 +01:00
parent be341fcd04
commit 33e3fe9173
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
mopidy/mpd/dispatcher.py
View File

@ -292,6 +292,24 @@ class MpdContext(object):
return self._name_from_uri[uri] return self._name_from_uri[uri]
def browse(self, path, recursive=True, lookup=True): def browse(self, path, recursive=True, lookup=True):
"""
Browse the contents of a given directory path.
Returns a sequence of two-tuples ``(path, data)``.
If ``recursive`` is true, it returns results for all entries in the
given path.
If ``lookup`` is true and the ``path`` is to a track, the returned
``data`` is a future which will contain the
:class:`mopidy.models.Track` model. If ``lookup`` is false and the
``path`` is to a track, the returned ``data`` will be a
:class:`mopidy.models.Ref` for the track.
For all entries that are not tracks, the returned ``data`` will be
:class:`None`.
"""
path_parts = re.findall(r'[^/]+', path or '') path_parts = re.findall(r'[^/]+', path or '')
root_path = '/'.join([''] + path_parts) root_path = '/'.join([''] + path_parts)