Merge branch 'develop' into feature/new-playlists-api

Conflicts:
	docs/changelog.rst
This commit is contained in:
Stein Magnus Jodal 2015-03-23 21:45:32 +01:00
commit 07cf962434
6 changed files with 77 additions and 60 deletions

View File

@ -77,6 +77,18 @@ v1.0.0 (UNRELEASED)
:meth:`mopidy.core.LibraryController.find_exact` to normalize and warn about
bad queries from clients. (Fixes: :issue:`1067`, PR: :issue:`1073`)
- Reduced API surface of core. (Fixes: :issue:`1070`, PR: :issue:`1076`)
- Made ``mopidy.core.PlaybackController.change_track`` internal.
- Removed ``on_error_step`` from :meth:`mopidy.core.PlaybackController.play`
- Made the following event triggers internal:
- ``mopidy.core.PlaybackController.on_end_of_track``
- ``mopidy.core.PlaybackController.on_stream_changed``
- ``mopidy.core.PlaybackController.on_tracklist_changed``
- Made ``mopidy.core.PlaybackController.set_current_tl_track`` internal.
- Add :meth:`mopidy.core.PlaylistsController.as_list`. (Fixes: :issue:`1057`,
PR: :issue:`1075`)

View File

@ -84,10 +84,10 @@ class Core(
"""
def reached_end_of_stream(self):
self.playback.on_end_of_track()
self.playback._on_end_of_track()
def stream_changed(self, uri):
self.playback.on_stream_changed(uri)
self.playback._on_stream_changed(uri)
def state_changed(self, old_state, new_state, target_state):
# XXX: This is a temporary fix for issue #232 while we wait for a more

View File

@ -41,15 +41,14 @@ class PlaybackController(object):
"""
return self._current_tl_track
def set_current_tl_track(self, value):
def _set_current_tl_track(self, value):
"""Set the currently playing or selected track.
*Internal:* This is only for use by Mopidy's test suite.
"""
self._current_tl_track = value
current_tl_track = deprecated_property(
get_current_tl_track, set_current_tl_track)
current_tl_track = deprecated_property(get_current_tl_track)
"""
.. deprecated:: 1.0
Use :meth:`get_current_tl_track` instead.
@ -183,7 +182,7 @@ class PlaybackController(object):
# Methods
# TODO: remove this.
def change_track(self, tl_track, on_error_step=1):
def _change_track(self, tl_track, on_error_step=1):
"""
Change to the given track, keeping the current playback state.
@ -195,14 +194,14 @@ class PlaybackController(object):
"""
old_state = self.get_state()
self.stop()
self.set_current_tl_track(tl_track)
self._set_current_tl_track(tl_track)
if old_state == PlaybackState.PLAYING:
self.play(on_error_step=on_error_step)
self._play(on_error_step=on_error_step)
elif old_state == PlaybackState.PAUSED:
self.pause()
# TODO: this is not really end of track, this is on_need_next_track
def on_end_of_track(self):
def _on_end_of_track(self):
"""
Tell the playback controller that end of track is reached.
@ -215,14 +214,14 @@ class PlaybackController(object):
next_tl_track = self.core.tracklist.eot_track(original_tl_track)
if next_tl_track:
self.change_track(next_tl_track)
self._change_track(next_tl_track)
else:
self.stop()
self.set_current_tl_track(None)
self._set_current_tl_track(None)
self.core.tracklist._mark_played(original_tl_track)
def on_tracklist_change(self):
def _on_tracklist_change(self):
"""
Tell the playback controller that the current playlist has changed.
@ -231,9 +230,9 @@ class PlaybackController(object):
tracklist = self.core.tracklist.get_tl_tracks()
if self.get_current_tl_track() not in tracklist:
self.stop()
self.set_current_tl_track(None)
self._set_current_tl_track(None)
def on_stream_changed(self, uri):
def _on_stream_changed(self, uri):
self._stream_title = None
def next(self):
@ -250,10 +249,10 @@ class PlaybackController(object):
# TODO: switch to:
# backend.play(track)
# wait for state change?
self.change_track(next_tl_track)
self._change_track(next_tl_track)
else:
self.stop()
self.set_current_tl_track(None)
self._set_current_tl_track(None)
self.core.tracklist._mark_played(original_tl_track)
@ -267,20 +266,17 @@ class PlaybackController(object):
self.set_state(PlaybackState.PAUSED)
self._trigger_track_playback_paused()
def play(self, tl_track=None, on_error_step=1):
def play(self, tl_track=None):
"""
Play the given track, or if the given track is :class:`None`, play the
currently active track.
:param tl_track: track to play
:type tl_track: :class:`mopidy.models.TlTrack` or :class:`None`
:param on_error_step: direction to step at play error, 1 for next
track (default), -1 for previous track. **INTERNAL**
:type on_error_step: int, -1 or 1
"""
self._play(tl_track, on_error_step=1)
assert on_error_step in (-1, 1)
def _play(self, tl_track=None, on_error_step=1):
if tl_track is None:
if self.get_state() == PlaybackState.PAUSED:
return self.resume()
@ -305,7 +301,7 @@ class PlaybackController(object):
if self.get_state() == PlaybackState.PLAYING:
self.stop()
self.set_current_tl_track(tl_track)
self._set_current_tl_track(tl_track)
self.set_state(PlaybackState.PLAYING)
backend = self._get_backend()
success = False
@ -344,7 +340,7 @@ class PlaybackController(object):
# TODO: switch to:
# self.play(....)
# wait for state change?
self.change_track(
self._change_track(
self.core.tracklist.previous_track(tl_track), on_error_step=-1)
def resume(self):

View File

@ -67,7 +67,7 @@ class TracklistController(object):
def _increase_version(self):
self._version += 1
self.core.playback.on_tracklist_change()
self.core.playback._on_tracklist_change()
self._trigger_tracklist_changed()
version = deprecated_property(get_version)

View File

@ -50,8 +50,14 @@ class CorePlaybackTest(unittest.TestCase):
self.unplayable_tl_track = self.tl_tracks[2]
self.duration_less_tl_track = self.tl_tracks[4]
def trigger_end_of_track(self):
self.core.playback._on_end_of_track()
def set_current_tl_track(self, tl_track):
self.core.playback._set_current_tl_track(tl_track)
def test_get_current_tl_track_none(self):
self.core.playback.set_current_tl_track(None)
self.set_current_tl_track(None)
self.assertEqual(
self.core.playback.get_current_tl_track(), None)
@ -214,7 +220,7 @@ class CorePlaybackTest(unittest.TestCase):
self.playback2.pause.assert_called_once_with()
def test_pause_changes_state_even_if_track_is_unplayable(self):
self.core.playback.current_tl_track = self.unplayable_tl_track
self.set_current_tl_track(self.unplayable_tl_track)
self.core.playback.pause()
self.assertEqual(self.core.playback.state, core.PlaybackState.PAUSED)
@ -257,7 +263,7 @@ class CorePlaybackTest(unittest.TestCase):
self.playback2.resume.assert_called_once_with()
def test_resume_does_nothing_if_track_is_unplayable(self):
self.core.playback.current_tl_track = self.unplayable_tl_track
self.set_current_tl_track(self.unplayable_tl_track)
self.core.playback.state = core.PlaybackState.PAUSED
self.core.playback.resume()
@ -300,7 +306,7 @@ class CorePlaybackTest(unittest.TestCase):
self.playback2.stop.assert_called_once_with()
def test_stop_changes_state_even_if_track_is_unplayable(self):
self.core.playback.current_tl_track = self.unplayable_tl_track
self.set_current_tl_track(self.unplayable_tl_track)
self.core.playback.state = core.PlaybackState.PAUSED
self.core.playback.stop()
@ -419,7 +425,7 @@ class CorePlaybackTest(unittest.TestCase):
tl_track = self.tl_tracks[0]
self.core.playback.play(tl_track)
self.core.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertIn(tl_track, self.core.tracklist.tl_tracks)
@ -428,7 +434,7 @@ class CorePlaybackTest(unittest.TestCase):
self.core.playback.play(tl_track)
self.core.tracklist.consume = True
self.core.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertNotIn(tl_track, self.core.tracklist.tl_tracks)
@ -438,7 +444,7 @@ class CorePlaybackTest(unittest.TestCase):
self.core.playback.play(self.tl_tracks[0])
listener_mock.reset_mock()
self.core.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertListEqual(
listener_mock.send.mock_calls,
@ -495,7 +501,7 @@ class CorePlaybackTest(unittest.TestCase):
self.playback2.seek.assert_called_once_with(10000)
def test_seek_fails_for_unplayable_track(self):
self.core.playback.current_tl_track = self.unplayable_tl_track
self.set_current_tl_track(self.unplayable_tl_track)
self.core.playback.state = core.PlaybackState.PLAYING
success = self.core.playback.seek(1000)
@ -504,7 +510,7 @@ class CorePlaybackTest(unittest.TestCase):
self.assertFalse(self.playback2.seek.called)
def test_seek_fails_for_track_without_duration(self):
self.core.playback.current_tl_track = self.duration_less_tl_track
self.set_current_tl_track(self.duration_less_tl_track)
self.core.playback.state = core.PlaybackState.PLAYING
success = self.core.playback.seek(1000)
@ -554,7 +560,7 @@ class CorePlaybackTest(unittest.TestCase):
self.playback2.get_time_position.assert_called_once_with()
def test_time_position_returns_0_if_track_is_unplayable(self):
self.core.playback.current_tl_track = self.unplayable_tl_track
self.set_current_tl_track(self.unplayable_tl_track)
result = self.core.playback.time_position

View File

@ -39,6 +39,9 @@ class LocalPlaybackProviderTest(unittest.TestCase):
track = Track(uri=uri, length=4464)
self.tracklist.add([track])
def trigger_end_of_track(self):
self.playback._on_end_of_track()
def setUp(self): # noqa: N802
self.audio = dummy_audio.create_proxy()
self.backend = actor.LocalBackend.start(
@ -163,7 +166,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
@populate_tracklist
def test_current_track_after_completed_playlist(self):
self.playback.play(self.tracklist.tl_tracks[-1])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
self.assertEqual(self.playback.current_track, None)
@ -406,7 +409,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
old_position = self.tracklist.index(tl_track)
old_uri = tl_track.track.uri
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertEqual(
@ -416,11 +419,11 @@ class LocalPlaybackProviderTest(unittest.TestCase):
@populate_tracklist
def test_end_of_track_return_value(self):
self.playback.play()
self.assertEqual(self.playback.on_end_of_track(), None)
self.assertEqual(self.trigger_end_of_track(), None)
@populate_tracklist
def test_end_of_track_does_not_trigger_playback(self):
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@populate_tracklist
@ -433,7 +436,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
tl_track = self.playback.current_tl_track
self.assertEqual(self.tracklist.index(tl_track), i)
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@ -442,7 +445,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.playback.play()
for _ in self.tracks:
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, None)
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@ -452,7 +455,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.assertEqual(self.playback.current_track, self.tracks[0])
def test_end_of_track_for_empty_playlist(self):
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@populate_tracklist
@ -462,7 +465,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.backend.playback.play = lambda: return_values.pop()
self.playback.play()
self.assertEqual(self.playback.current_track, self.tracks[0])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertNotEqual(self.playback.current_track, self.tracks[1])
self.assertEqual(self.playback.current_track, self.tracks[2])
@ -482,7 +485,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
@populate_tracklist
def test_end_of_track_track_after_previous(self):
self.playback.play()
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.playback.previous()
tl_track = self.playback.current_tl_track
self.assertEqual(
@ -496,7 +499,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
def test_end_of_track_track_at_end_of_playlist(self):
self.playback.play()
for _ in self.tracklist.tl_tracks[1:]:
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertEqual(self.tracklist.next_track(tl_track), None)
@ -505,7 +508,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.repeat = True
self.playback.play()
for _ in self.tracks[1:]:
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertEqual(
self.tracklist.next_track(tl_track), self.tl_tracks[0])
@ -524,7 +527,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
def test_end_of_track_with_consume(self):
self.tracklist.consume = True
self.playback.play()
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertNotIn(self.tracks[0], self.tracklist.tracks)
@populate_tracklist
@ -535,7 +538,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.random = True
self.playback.play()
self.assertEqual(self.playback.current_track, self.tracks[-1])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, self.tracks[-2])
@populate_tracklist
@ -654,19 +657,19 @@ class LocalPlaybackProviderTest(unittest.TestCase):
@populate_tracklist
def test_tracklist_position_at_end_of_playlist(self):
self.playback.play(self.tracklist.tl_tracks[-1])
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertEqual(self.tracklist.index(tl_track), None)
def test_on_tracklist_change_gets_called(self):
callback = self.playback.on_tracklist_change
callback = self.playback._on_tracklist_change
def wrapper():
wrapper.called = True
return callback()
wrapper.called = False
self.playback.on_tracklist_change = wrapper
self.playback._on_tracklist_change = wrapper
self.tracklist.add([Track()])
self.assert_(wrapper.called)
@ -917,7 +920,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.consume = True
self.playback.play()
for _ in range(len(self.tracklist.tracks)):
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(len(self.tracklist.tracks), 0)
@populate_tracklist
@ -944,7 +947,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
@populate_tracklist
def test_end_of_song_starts_next_track(self):
self.playback.play()
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, self.tracks[1])
@populate_tracklist
@ -953,7 +956,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.repeat = True
self.playback.play()
self.assertEqual(self.playback.current_track, self.tracks[0])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, self.tracks[0])
@populate_tracklist
@ -963,7 +966,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.random = True
self.playback.play()
current_track = self.playback.current_track
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, current_track)
@populate_tracklist
@ -971,7 +974,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.single = True
self.playback.play()
self.assertEqual(self.playback.current_track, self.tracks[0])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, None)
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@ -980,14 +983,14 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.single = True
self.tracklist.random = True
self.playback.play()
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.current_track, None)
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
@populate_tracklist
def test_end_of_playlist_stops(self):
self.playback.play(self.tracklist.tl_tracks[-1])
self.playback.on_end_of_track()
self.trigger_end_of_track()
self.assertEqual(self.playback.state, PlaybackState.STOPPED)
def test_repeat_off_by_default(self):
@ -1013,7 +1016,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.random = True
self.playback.play()
for _ in self.tracks[1:]:
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertEqual(self.tracklist.eot_track(tl_track), None)
@ -1034,7 +1037,7 @@ class LocalPlaybackProviderTest(unittest.TestCase):
self.tracklist.random = True
self.playback.play()
for _ in self.tracks:
self.playback.on_end_of_track()
self.trigger_end_of_track()
tl_track = self.playback.current_tl_track
self.assertNotEqual(self.tracklist.eot_track(tl_track), None)
self.assertEqual(self.playback.state, PlaybackState.STOPPED)