Add extras and hubs mixins (#890)

Author: JonnyWong16

plexapi/audio.py

@@ -2,11 +2,11 @@
 import os
 from urllib.parse import quote_plus
 
-from plexapi import library, media, utils
+from plexapi import media, utils
 from plexapi.base import Playable, PlexPartialObject
 from plexapi.exceptions import BadRequest
 from plexapi.mixins import (
-    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, RatingMixin,
+    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin,
     ArtUrlMixin, ArtMixin, PosterUrlMixin, PosterMixin, ThemeMixin, ThemeUrlMixin,
     OriginallyAvailableMixin, SortTitleMixin, StudioMixin, SummaryMixin, TitleMixin,
     TrackArtistMixin, TrackDiscNumberMixin, TrackNumberMixin,
@@ -131,7 +131,7 @@ def sync(self, bitrate, client=None, clientId=None, limit=None, title=None):
 @utils.registerPlexObject
 class Artist(
     Audio,
-    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, RatingMixin,
+    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeMixin,
     SortTitleMixin, SummaryMixin, TitleMixin,
     CollectionMixin, CountryMixin, GenreMixin, LabelMixin, MoodMixin, SimilarArtistMixin, StyleMixin
@@ -174,11 +174,6 @@ def __iter__(self):
         for album in self.albums():
             yield album
 
-    def hubs(self):
-        """ Returns a list of :class:`~plexapi.library.Hub` objects. """
-        data = self._server.query(self._details_key)
-        return self.findItems(data, library.Hub, rtag='Related')
-
     def album(self, title):
         """ Returns the :class:`~plexapi.audio.Album` that matches the specified title.
 
@@ -359,7 +354,7 @@ def _defaultSyncTitle(self):
 @utils.registerPlexObject
 class Track(
     Audio, Playable,
-    RatingMixin,
+    ExtrasMixin, RatingMixin,
     ArtUrlMixin, PosterUrlMixin, ThemeUrlMixin,
     TitleMixin, TrackArtistMixin, TrackNumberMixin, TrackDiscNumberMixin,
     CollectionMixin, LabelMixin, MoodMixin

plexapi/collection.py

@@ -6,7 +6,7 @@
 from plexapi.exceptions import BadRequest, NotFound, Unsupported
 from plexapi.library import LibrarySection
 from plexapi.mixins import (
-    AdvancedSettingsMixin, SmartFilterMixin, RatingMixin,
+    AdvancedSettingsMixin, SmartFilterMixin, HubsMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeMixin,
     ContentRatingMixin, SortTitleMixin, SummaryMixin, TitleMixin,
     LabelMixin
@@ -18,7 +18,7 @@
 @utils.registerPlexObject
 class Collection(
     PlexPartialObject,
-    AdvancedSettingsMixin, SmartFilterMixin, RatingMixin,
+    AdvancedSettingsMixin, SmartFilterMixin, HubsMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeMixin,
     ContentRatingMixin, SortTitleMixin, SummaryMixin, TitleMixin,
     LabelMixin

plexapi/mixins.py

@@ -234,6 +234,26 @@ def fixMatch(self, searchResult=None, auto=False, agent=None):
         self._server.query(data, method=self._server._session.put)
 
 
+class ExtrasMixin(object):
+    """ Mixin for Plex objects that can have extras. """
+
+    def extras(self):
+        """ Returns a list of :class:`~plexapi.video.Extra` objects. """
+        from plexapi.video import Extra
+        data = self._server.query(self._details_key)
+        return self.findItems(data, Extra, rtag='Extras')
+
+
+class HubsMixin(object):
+    """ Mixin for Plex objects that can have related hubs. """
+
+    def hubs(self):
+        """ Returns a list of :class:`~plexapi.library.Hub` objects. """
+        from plexapi.library import Hub
+        data = self._server.query(self._details_key)
+        return self.findItems(data, Hub, rtag='Related')
+
+
 class RatingMixin(object):
     """ Mixin for Plex objects that can have user star ratings. """
 

plexapi/video.py

@@ -2,11 +2,11 @@
 import os
 from urllib.parse import quote_plus, urlencode
 
-from plexapi import library, media, utils
+from plexapi import media, utils
 from plexapi.base import Playable, PlexPartialObject
 from plexapi.exceptions import BadRequest
 from plexapi.mixins import (
-    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, RatingMixin,
+    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin,
     ArtUrlMixin, ArtMixin, BannerMixin, PosterUrlMixin, PosterMixin, ThemeUrlMixin, ThemeMixin,
     ContentRatingMixin, OriginallyAvailableMixin, OriginalTitleMixin, SortTitleMixin, StudioMixin,
     SummaryMixin, TaglineMixin, TitleMixin,
@@ -267,7 +267,7 @@ def sync(self, videoQuality, client=None, clientId=None, limit=None, unwatched=F
 @utils.registerPlexObject
 class Movie(
     Video, Playable,
-    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, RatingMixin,
+    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeMixin,
     ContentRatingMixin, OriginallyAvailableMixin, OriginalTitleMixin, SortTitleMixin, StudioMixin,
     SummaryMixin, TaglineMixin, TitleMixin,
@@ -377,21 +377,11 @@ def reviews(self):
         data = self._server.query(self._details_key)
         return self.findItems(data, media.Review, rtag='Video')
 
-    def extras(self):
-        """ Returns a list of :class:`~plexapi.video.Extra` objects. """
-        data = self._server.query(self._details_key)
-        return self.findItems(data, Extra, rtag='Extras')
-
-    def hubs(self):
-        """ Returns a list of :class:`~plexapi.library.Hub` objects. """
-        data = self._server.query(self._details_key)
-        return self.findItems(data, library.Hub, rtag='Related')
-
 
 @utils.registerPlexObject
 class Show(
     Video,
-    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, RatingMixin,
+    AdvancedSettingsMixin, SplitMergeMixin, UnmatchMatchMixin, ExtrasMixin, HubsMixin, RatingMixin,
     ArtMixin, BannerMixin, PosterMixin, ThemeMixin,
     ContentRatingMixin, OriginallyAvailableMixin, OriginalTitleMixin, SortTitleMixin, StudioMixin,
     SummaryMixin, TaglineMixin, TitleMixin,
@@ -501,11 +491,6 @@ def isWatched(self):
         """ Returns True if the show is fully watched. """
         return bool(self.viewedLeafCount == self.leafCount)
 
-    def hubs(self):
-        """ Returns a list of :class:`~plexapi.library.Hub` objects. """
-        data = self._server.query(self._details_key)
-        return self.findItems(data, library.Hub, rtag='Related')
-
     def onDeck(self):
         """ Returns show's On Deck :class:`~plexapi.video.Video` object or `None`.
             If show is unwatched, return will likely be the first episode.
@@ -594,7 +579,7 @@ def download(self, savepath=None, keep_original_name=False, subfolders=False, **
 @utils.registerPlexObject
 class Season(
     Video,
-    RatingMixin,
+    ExtrasMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeUrlMixin,
     SummaryMixin, TitleMixin,
     CollectionMixin, LabelMixin
@@ -737,7 +722,7 @@ def _defaultSyncTitle(self):
 @utils.registerPlexObject
 class Episode(
     Video, Playable,
-    RatingMixin,
+    ExtrasMixin, RatingMixin,
     ArtMixin, PosterMixin, ThemeUrlMixin,
     ContentRatingMixin, OriginallyAvailableMixin, SortTitleMixin, SummaryMixin, TitleMixin,
     CollectionMixin, DirectorMixin, LabelMixin, WriterMixin