Use 'mute' instead of 'muted', to avoid changing old APIs

This commit is contained in:
Stein Magnus Jodal 2014-07-12 03:14:19 +02:00
parent 249114b051
commit d15d66f070
6 changed files with 20 additions and 21 deletions

View File

@ -88,9 +88,9 @@ class Core(
# Forward event from mixer to frontends
CoreListener.send('volume_changed', volume=volume)
def mute_changed(self, muted):
def mute_changed(self, mute):
# Forward event from mixer to frontends
CoreListener.send('mute_changed', mute=muted)
CoreListener.send('mute_changed', mute=mute)
class Backends(list):

View File

@ -150,7 +150,6 @@ class CoreListener(listener.Listener):
:param mute: the new mute state
:type mute: boolean
"""
# TODO Change 'mute' arg to 'muted' next time we break this API
pass
def seeked(self, time_position):

View File

@ -83,19 +83,19 @@ class Mixer(object):
"""
return None
def set_mute(self, muted):
def set_mute(self, mute):
"""
Mute or unmute the mixer.
*MAY be implemented by subclass.*
:param muted: :class:`True` to mute, :class:`False` to unmute
:type muted: bool
:param mute: :class:`True` to mute, :class:`False` to unmute
:type mute: bool
:rtype: :class:`True` if success, :class:`False` if failure
"""
return False
def trigger_mute_changed(self, muted):
def trigger_mute_changed(self, mute):
"""
Send ``mute_changed`` event to all mixer listeners.
@ -103,8 +103,8 @@ class Mixer(object):
changed, either because of a call to :meth:`set_mute` or because or
any external entity changing the mute state.
"""
logger.debug('Mixer event: mute_changed(muted=%s)', muted)
MixerListener.send('mute_changed', muted=muted)
logger.debug('Mixer event: mute_changed(mute=%s)', mute)
MixerListener.send('mute_changed', mute=mute)
def trigger_events_for_any_changes(self):
"""
@ -117,17 +117,17 @@ class Mixer(object):
if not hasattr(self, '_last_volume'):
self._last_volume = None
if not hasattr(self, '_last_muted'):
self._last_muted = None
if not hasattr(self, '_last_mute'):
self._last_mute = None
old_volume, self._last_volume = self._last_volume, self.get_volume()
old_muted, self._last_muted = self._last_muted, self.get_mute()
old_mute, self._last_mute = self._last_mute, self.get_mute()
if old_volume != self._last_volume:
self.trigger_volume_changed(self._last_volume)
if old_muted != self._last_muted:
self.trigger_mute_changed(self._last_muted)
if old_mute != self._last_mute:
self.trigger_mute_changed(self._last_mute)
class MixerListener(listener.Listener):
@ -157,13 +157,13 @@ class MixerListener(listener.Listener):
"""
pass
def mute_changed(self, muted):
def mute_changed(self, mute):
"""
Called after the mute state has changed.
*MAY* be implemented by actor.
:param muted: :class:`True` if muted, :class:`False` if not muted
:type muted: bool
:param mute: :class:`True` if muted, :class:`False` if not muted
:type mute: bool
"""
pass

View File

@ -37,8 +37,8 @@ class SoftwareMixer(pykka.ThreadingActor, mixer.Mixer):
return None
return self.audio.get_mute().get()
def set_mute(self, muted):
def set_mute(self, mute):
if self.audio is None:
return False
self.audio.set_mute(muted)
self.audio.set_mute(mute)
return True

View File

@ -32,7 +32,7 @@ class BackendEventsTest(unittest.TestCase):
self.assertEqual(send.call_args[1]['volume'], 60)
def test_forwards_mixer_mute_changed_event_to_frontends(self, send):
self.core.mute_changed(muted=True).get()
self.core.mute_changed(mute=True).get()
self.assertEqual(send.call_args[0][0], 'mute_changed')
self.assertEqual(send.call_args[1]['mute'], True)

View File

@ -23,4 +23,4 @@ class MixerListenerTest(unittest.TestCase):
self.listener.volume_changed(volume=60)
def test_listener_has_default_impl_for_mute_changed(self):
self.listener.mute_changed(muted=True)
self.listener.mute_changed(mute=True)