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

Use ` instead of * for plugin event names

Browse source
This commit is contained in:
Adrian Sampson 2015-11-07 12:12:48 -08:00
parent 4e20ddcef9
commit cb6edb46ef
1 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
docs/dev/plugins.rst
View file

@ -133,39 +133,39 @@ registration process in this case::
The events currently available are:
* *pluginload*: called after all the plugins have been loaded after the ``beet``
* `pluginload`: called after all the plugins have been loaded after the ``beet``
command starts
* *import*: called after a ``beet import`` command finishes (the ``lib`` keyword
* `import`: called after a ``beet import`` command finishes (the ``lib`` keyword
argument is a Library object; ``paths`` is a list of paths (strings) that were
imported)
* *album_imported*: called with an ``Album`` object every time the ``import``
* `album_imported`: called with an ``Album`` object every time the ``import``
command finishes adding an album to the library. Parameters: ``lib``,
``album``
* *item_copied*: called with an ``Item`` object whenever its file is copied.
* `item_copied`: called with an ``Item`` object whenever its file is copied.
Parameters: ``item``, ``source`` path, ``destination`` path
* *item_imported*: called with an ``Item`` object every time the importer adds a
* `item_imported`: called with an ``Item`` object every time the importer adds a
singleton to the library (not called for full-album imports). Parameters:
``lib``, ``item``
* *before_item_moved*: called with an ``Item`` object immediately before its
* `before_item_moved`: called with an ``Item`` object immediately before its
file is moved. Parameters: ``item``, ``source`` path, ``destination`` path
* *item_moved*: called with an ``Item`` object whenever its file is moved.
* `item_moved`: called with an ``Item`` object whenever its file is moved.
Parameters: ``item``, ``source`` path, ``destination`` path
* *item_linked*: called with an ``Item`` object whenever a symlink is created
* `item_linked`: called with an ``Item`` object whenever a symlink is created
for a file.
Parameters: ``item``, ``source`` path, ``destination`` path
* *item_removed*: called with an ``Item`` object every time an item (singleton
* `item_removed`: called with an ``Item`` object every time an item (singleton
or album's part) is removed from the library (even when its file is not
deleted from disk).
* *write*: called with an ``Item`` object, a ``path``, and a ``tags``
* `write`: called with an ``Item`` object, a ``path``, and a ``tags``
dictionary just before a file's metadata is written to disk (i.e.,
just before the file on disk is opened). Event handlers may change
the ``tags`` dictionary to customize the tags that are written to the
@ -174,55 +174,55 @@ The events currently available are:
operation. Beets will catch that exception, print an error message
and continue.
* *after_write*: called with an ``Item`` object after a file's metadata is
* `after_write`: called with an ``Item`` object after a file's metadata is
written to disk (i.e., just after the file on disk is closed).
* *import_task_created*: called immediately after an import task is
* `import_task_created`: called immediately after an import task is
initialized. Plugins can use this to, for example, change imported files of a
task before anything else happens. It's also possible to replace the task
with another task by returning a list of tasks. This list can contain zero
or more `ImportTask`s. Returning an empty list will stop the task.
Parameters: ``task`` (an `ImportTask`) and ``session`` (an `ImportSession`).
* *import_task_start*: called when before an import task begins processing.
* `import_task_start`: called when before an import task begins processing.
Parameters: ``task`` and ``session``.
* *import_task_apply*: called after metadata changes have been applied in an
* `import_task_apply`: called after metadata changes have been applied in an
import task. This is called on the same thread as the UI, so use this
sparingly and only for tasks that can be done quickly. For most plugins, an
import pipeline stage is a better choice (see :ref:`plugin-stage`).
Parameters: ``task`` and ``session``.
* *import_task_choice*: called after a decision has been made about an import
* `import_task_choice`: called after a decision has been made about an import
task. This event can be used to initiate further interaction with the user.
Use ``task.choice_flag`` to determine or change the action to be
taken. Parameters: ``task`` and ``session``.
* *import_task_files*: called after an import task finishes manipulating the
* `import_task_files`: called after an import task finishes manipulating the
filesystem (copying and moving files, writing metadata tags). Parameters:
``task`` and ``session``.
* *library_opened*: called after beets starts up and initializes the main
* `library_opened`: called after beets starts up and initializes the main
Library object. Parameter: ``lib``.
* *database_change*: a modification has been made to the library database. The
* `database_change`: a modification has been made to the library database. The
change might not be committed yet. Parameters: ``lib`` and ``model``.
* *cli_exit*: called just before the ``beet`` command-line program exits.
* `cli_exit`: called just before the ``beet`` command-line program exits.
Parameter: ``lib``.
* *import_begin*: called just before a ``beet import`` session starts up.
* `import_begin`: called just before a ``beet import`` session starts up.
Parameter: ``session``.
* *trackinfo_received*: called after metadata for a track item has been
* `trackinfo_received`: called after metadata for a track item has been
fetched from a data source, such as MusicBrainz. You can modify the tags
that the rest of the pipeline sees on a ``beet import`` operation or during
later adjustments, such as ``mbsync``. Slow handlers of the event can impact
the operation, since the event is fired for any fetched possible match
*before* the user (or the autotagger machinery) gets to see the match.
`before` the user (or the autotagger machinery) gets to see the match.
Parameter: ``info``.
* *albuminfo_received*: like *trackinfo_received*, the event indicates new
* `albuminfo_received`: like `trackinfo_received`, the event indicates new
metadata for album items. The parameter is an ``AlbumInfo`` object instead
of a ``TrackInfo``.
Parameter: ``info``.