Merge pull request beetbox#4412 from beetbox/album-items

Document Album.items() / LibModel.items() conflict
arsaboo · Aug 21, 2022 · 6e0f7a1 · 6e0f7a1
2 parents f0a6bbb + bf8fbed
commit 6e0f7a1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/beets/library.py b/beets/library.py
@@ -1145,6 +1145,11 @@ def _getters(cls):
     def items(self):
         """Return an iterable over the items associated with this
         album.
+
+        This method conflicts with :meth:`LibModel.items`, which is
+        inherited from :meth:`beets.dbcore.Model.items`.
+        Since :meth:`Album.items` predates these methods, and is
+        likely to be used by plugins, we keep this interface as-is.
         """
         return self._db.items(dbcore.MatchQuery('album_id', self.id))
 

diff --git a/docs/dev/library.rst b/docs/dev/library.rst
@@ -99,6 +99,10 @@ synchronized (via load or store) with the database.
 
     .. automethod:: items
 
+    .. note::
+       The :py:meth:`Album.items` method is not inherited from
+       :py:meth:`LibModel.items` for historical reasons.
+
     .. automethod:: get
 
 Item
@@ -207,6 +211,8 @@ metadata field.
 
     .. automethod:: item_dir
 
+    .. automethod:: items
+
     Albums extend the normal model interface to also forward changes to their
     items: