Add libtype argument for creating smart playlists (#799)

* Add libtype keyword argument for smart playlists

* Update docs, remove libtype collection from smart playlists/collections

* Cannot create a smart playlist or collection from other collections

* Update smart playlist filter test for libtype

Author: JonnyWong16

plexapi/collection.py

@@ -442,7 +442,7 @@ def create(cls, server, title, section, items=None, smart=False, limit=None,
                 smart (bool): True to create a smart collection. Default False.
                 limit (int): Smart collections only, limit the number of items in the collection.
                 libtype (str): Smart collections only, the specific type of content to filter
-                    (movie, show, season, episode, artist, album, track, photoalbum, photo, collection).
+                    (movie, show, season, episode, artist, album, track, photoalbum, photo).
                 sort (str or list, optional): Smart collections only, a string of comma separated sort fields
                     or a list of sort fields in the format ``column:dir``.
                     See :func:`~plexapi.library.LibrarySection.search` for more info.

plexapi/playlist.py

@@ -341,13 +341,15 @@ def _create(cls, server, title, items):
         return cls(server, data, initpath=key)
 
     @classmethod
-    def _createSmart(cls, server, title, section, limit=None, sort=None, filters=None, **kwargs):
+    def _createSmart(cls, server, title, section, limit=None, libtype=None, sort=None, filters=None, **kwargs):
         """ Create a smart playlist. """
         if not isinstance(section, LibrarySection):
             section = server.library.section(section)
 
+        libtype = libtype or section.METADATA_TYPE
+
         searchKey = section._buildSearchKey(
-            sort=sort, libtype=section.METADATA_TYPE, limit=limit, filters=filters, **kwargs)
+            sort=sort, libtype=libtype, limit=limit, filters=filters, **kwargs)
         uri = '%s%s' % (server._uriRoot(), searchKey)
 
         key = '/playlists%s' % utils.joinArgs({
@@ -361,7 +363,7 @@ def _createSmart(cls, server, title, section, limit=None, sort=None, filters=Non
 
     @classmethod
     def create(cls, server, title, section=None, items=None, smart=False, limit=None,
-               sort=None, filters=None, **kwargs):
+               libtype=None, sort=None, filters=None, **kwargs):
         """ Create a playlist.
 
             Parameters:
@@ -373,6 +375,8 @@ def create(cls, server, title, section=None, items=None, smart=False, limit=None
                     :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be added to the playlist.
                 smart (bool): True to create a smart playlist. Default False.
                 limit (int): Smart playlists only, limit the number of items in the playlist.
+                libtype (str): Smart playlists only, the specific type of content to filter
+                    (movie, show, season, episode, artist, album, track, photoalbum, photo).
                 sort (str or list, optional): Smart playlists only, a string of comma separated sort fields
                     or a list of sort fields in the format ``column:dir``.
                     See :func:`~plexapi.library.LibrarySection.search` for more info.
@@ -389,7 +393,7 @@ def create(cls, server, title, section=None, items=None, smart=False, limit=None
                 :class:`~plexapi.playlist.Playlist`: A new instance of the created Playlist.
         """
         if smart:
-            return cls._createSmart(server, title, section, limit, sort, filters, **kwargs)
+            return cls._createSmart(server, title, section, limit, libtype, sort, filters, **kwargs)
         else:
             return cls._create(server, title, items)
 

plexapi/server.py

@@ -427,7 +427,7 @@ def createCollection(self, title, section, items=None, smart=False, limit=None,
                 smart (bool): True to create a smart collection. Default False.
                 limit (int): Smart collections only, limit the number of items in the collection.
                 libtype (str): Smart collections only, the specific type of content to filter
-                    (movie, show, season, episode, artist, album, track, photoalbum, photo, collection).
+                    (movie, show, season, episode, artist, album, track, photoalbum, photo).
                 sort (str or list, optional): Smart collections only, a string of comma separated sort fields
                     or a list of sort fields in the format ``column:dir``.
                     See :func:`~plexapi.library.LibrarySection.search` for more info.
@@ -448,7 +448,7 @@ def createCollection(self, title, section, items=None, smart=False, limit=None,
             libtype=libtype, sort=sort, filters=filters, **kwargs)
 
     def createPlaylist(self, title, section=None, items=None, smart=False, limit=None,
-                       sort=None, filters=None, **kwargs):
+                       libtype=None, sort=None, filters=None, **kwargs):
         """ Creates and returns a new :class:`~plexapi.playlist.Playlist`.
 
             Parameters:
@@ -459,6 +459,8 @@ def createPlaylist(self, title, section=None, items=None, smart=False, limit=Non
                     :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be added to the playlist.
                 smart (bool): True to create a smart playlist. Default False.
                 limit (int): Smart playlists only, limit the number of items in the playlist.
+                libtype (str): Smart playlists only, the specific type of content to filter
+                    (movie, show, season, episode, artist, album, track, photoalbum, photo).
                 sort (str or list, optional): Smart playlists only, a string of comma separated sort fields
                     or a list of sort fields in the format ``column:dir``.
                     See :func:`~plexapi.library.LibrarySection.search` for more info.
@@ -476,7 +478,7 @@ def createPlaylist(self, title, section=None, items=None, smart=False, limit=Non
         """
         return Playlist.create(
             self, title, section=section, items=items, smart=smart, limit=limit,
-            sort=sort, filters=filters, **kwargs)
+            libtype=libtype, sort=sort, filters=filters, **kwargs)
 
     def createPlayQueue(self, item, **kwargs):
         """ Creates and returns a new :class:`~plexapi.playqueue.PlayQueue`.

tests/test_playlist.py

@@ -189,10 +189,12 @@ def test_Playlist_smartFilters(plex, tvshows):
             smart=True,
             section=tvshows,
             limit=5,
+            libtype='show',
             sort=["season.index:nullsLast", "episode.index:nullsLast", "show.titleSort"],
             filters={"or": [{"show.title": "game"}, {'show.title': "100"}]}
         )
         filters = playlist.filters()
+        filters['libtype'] = tvshows.METADATA_TYPE  # Override libtype to check playlist items
         assert tvshows.search(**filters) == playlist.items()
     finally:
         playlist.delete()