Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-30 12:32:33 +01:00
Code Issues Projects Releases Wiki Activity

Prompt event documentation and mbsubmit fixes

Browse source 
* Fixes for documentation of the prompt event (missing reserved letter, typos).
* Update sample mbsubmit plugin to conform to the new PromptChoice structure.
This commit is contained in:
Diego Moreda 2015-12-16 19:26:39 +01:00
parent b7747013d3
commit 6f8a1aa40a
2 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
beetsplug/mbsubmit.py
View file

@ -40,10 +40,8 @@ class MBSubmitPlugin(BeetsPlugin):
def before_choose_candidate_event(self, session, task):
if not task.candidates or task.rec == Recommendation.none:
return [PromptChoice(self, 'PRINT', 'p', 'Print tracks',
self.print_tracks),
PromptChoice(self, 'PRINT_SKIP', 'k',
'print tracks and sKip',
return [PromptChoice('p', 'Print tracks', self.print_tracks),
PromptChoice('k', 'print tracks and sKip',
self.print_tracks_and_skip)]
# Callbacks for choices.

11
docs/dev/plugins.rst
View file

@ -547,6 +547,7 @@ a list of ``PromptChoices`` that represent the additional choices that your
plugin shall expose to the user::
from beets.plugins import BeetsPlugin
from beets.ui.commands import PromptChoice
class ExamplePlugin(BeetsPlugin):
def __init__(self):
@ -555,14 +556,14 @@ plugin shall expose to the user::
self.before_choose_candidate_event)
def before_choose_candidate_event(self, session, task):
return [PromptChoice(self, 'PRINT_FOO', 'p', 'Print foo', self.foo),
PromptChoice(self, 'DO_BAR', 'd', 'Do bar', self.bar)]
return [PromptChoice('p', 'Print foo', self.foo),
PromptChoice('d', 'Do bar', self.bar)]
def foo(self, session, task):
print('User has chosen "Print foo"!')
def bar(self, session, task):
print('User has chosen "do Bar"!')
print('User has chosen "Do bar"!')
The previous example modifies the standard prompt::
@ -585,11 +586,11 @@ Please make sure that the short letter for each of the choices provided by the
plugin is not already in use: the importer will raise an exception if two or
more choices try to use the same short letter. As a reference, the following
characters are used by the choices on the core importer prompt, and hence
should not be used: ``s``, ``u``, ``t``, ``g``, ``e``, ``i``, ``b``.
should not be used: ``a``, ``s``, ``u``, ``t``, ``g``, ``e``, ``i``, ``b``.
Additionally, the callback function can optionally specify the next action to
be performed by returning one of the values from ``importer.action``, which
will be passed to the main loop upon the callback has been processed. Note that
``action.MANUAL`` and ``action.MANUAL_ID`` will have no effect even if
returned by the callback, due to the current arquitecture of the import
returned by the callback, due to the current architecture of the import
process.