mirror of
https://github.com/beetbox/beets.git
synced 2026-03-16 18:34:05 +01:00
35361a63b6
These functions now accept both an ID and data_source parameter, enabling plugins like mbsync and missing to retrieve metadata from the correct source. Update mbsync and missing plugins to use the restored functions with explicit data_source parameters. Add data_source validation to prevent lookups when the source is not specified. Add get_metadata_source helper function to retrieve plugins by their data_source name, cached for performance.
119 lines
2.9 KiB
ReStructuredText
119 lines
2.9 KiB
ReStructuredText
Missing Plugin
|
|
==============
|
|
|
|
This plugin adds a new command, ``missing`` or ``miss``, which finds and lists
|
|
missing tracks for albums in your collection. Each album requires one network
|
|
call to album data source.
|
|
|
|
Usage
|
|
-----
|
|
|
|
The ``beet missing`` command fetches album information from the origin data
|
|
source and lists names of the **tracks** that are missing from your library.
|
|
Track-level checks use the album's stored ``data_source`` and fall back to
|
|
``MusicBrainz`` when no source is stored.
|
|
|
|
It can also list the names of missing **albums** for each artist, although this
|
|
is limited to albums from the MusicBrainz data source only.
|
|
|
|
You can customize the output format, show missing counts instead of track
|
|
titles, or display the total number of missing entities across your entire
|
|
library:
|
|
|
|
::
|
|
|
|
-f FORMAT, --format=FORMAT
|
|
print with custom FORMAT
|
|
-c, --count count missing tracks per album
|
|
-t, --total count totals across the entire library
|
|
-a, --album show missing albums for artist instead of tracks for album
|
|
|
|
…or by editing the corresponding configuration options.
|
|
|
|
.. warning::
|
|
|
|
Option ``-c`` is ignored when used with ``-a``.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
To configure the plugin, make a ``missing:`` section in your configuration file.
|
|
The available options are:
|
|
|
|
- **count**: Print a count of missing tracks per album, with the global
|
|
``format_album`` used for formatting. Default: ``no``.
|
|
- **total**: Print a single count of missing tracks in all albums. Default:
|
|
``no``.
|
|
|
|
Formatting
|
|
~~~~~~~~~~
|
|
|
|
- This plugin uses global formatting options from the main configuration; see
|
|
:ref:`format_item` and :ref:`format_album`:
|
|
- :ref:`format_item`: Used when listing missing tracks (default item format).
|
|
- :ref:`format_album`: Used when showing counts (``-c``) or missing albums
|
|
(``-a``).
|
|
|
|
Here's an example
|
|
|
|
::
|
|
|
|
format_album: $albumartist - $album
|
|
format_item: $artist - $album - $title
|
|
missing:
|
|
count: no
|
|
total: no
|
|
|
|
Template Fields
|
|
---------------
|
|
|
|
With this plugin enabled, the ``$missing`` template field expands to the number
|
|
of tracks missing from each album.
|
|
|
|
Examples
|
|
--------
|
|
|
|
List all missing tracks in your collection:
|
|
|
|
::
|
|
|
|
beet missing
|
|
|
|
List all missing albums in your collection:
|
|
|
|
::
|
|
|
|
beet missing -a
|
|
|
|
List all missing tracks from 2008:
|
|
|
|
::
|
|
|
|
beet missing year:2008
|
|
|
|
Print out a unicode histogram of the missing track years using spark_:
|
|
|
|
::
|
|
|
|
beet missing -f '$year' | spark
|
|
▆▁▆█▄▇▇▄▇▇▁█▇▆▇▂▄█▁██▂█▁▁██▁█▂▇▆▂▇█▇▇█▆▆▇█▇█▇▆██▂▇
|
|
|
|
Print out a listing of all albums with missing tracks, and respective counts:
|
|
|
|
::
|
|
|
|
beet missing -c
|
|
|
|
Print out a count of the total number of missing tracks:
|
|
|
|
::
|
|
|
|
beet missing -t
|
|
|
|
Call this plugin from other beet commands:
|
|
|
|
::
|
|
|
|
beet ls -a -f '$albumartist - $album: $missing'
|
|
|
|
.. _spark: https://github.com/holman/spark
|