.gitignore

@@ -1,4 +1,3 @@
-syntax: glob
 *.db
 *.egg-info
 *.log

plexapi/audio.py

@@ -159,7 +159,7 @@ def sonicallySimilar(
 
         return self.fetchItems(
             key,
-            cls=self.__class__,
+            cls=type(self),
             **kwargs,
         )
 
@@ -427,6 +427,7 @@ class Track(
             chapterSource (str): Unknown
             collections (List<:class:`~plexapi.media.Collection`>): List of collection objects.
             duration (int): Length of the track in milliseconds.
+            genres (List<:class:`~plexapi.media.Genre`>): List of genre objects.
             grandparentArt (str): URL to album artist artwork (/library/metadata/<grandparentRatingKey>/art/<artid>).
             grandparentGuid (str): Plex GUID for the album artist (plex://artist/5d07bcb0403c64029053ac4c).
             grandparentKey (str): API URL of the album artist (/library/metadata/<grandparentRatingKey>).
@@ -449,6 +450,8 @@ class Track(
             primaryExtraKey (str) API URL for the primary extra for the track.
             ratingCount (int): Number of listeners who have scrobbled this track, as reported by Last.fm.
             skipCount (int): Number of times the track has been skipped.
+            sourceURI (str): Remote server URI (server://<machineIdentifier>/com.plexapp.plugins.library)
+                (remote playlist item only).
             viewOffset (int): View offset in milliseconds.
             year (int): Year the track was released.
     """
@@ -463,6 +466,7 @@ def _loadData(self, data):
         self.chapterSource = data.attrib.get('chapterSource')
         self.collections = self.findItems(data, media.Collection)
         self.duration = utils.cast(int, data.attrib.get('duration'))
+        self.genres = self.findItems(data, media.Genre)
         self.grandparentArt = data.attrib.get('grandparentArt')
         self.grandparentGuid = data.attrib.get('grandparentGuid')
         self.grandparentKey = data.attrib.get('grandparentKey')
@@ -483,6 +487,7 @@ def _loadData(self, data):
         self.primaryExtraKey = data.attrib.get('primaryExtraKey')
         self.ratingCount = utils.cast(int, data.attrib.get('ratingCount'))
         self.skipCount = utils.cast(int, data.attrib.get('skipCount'))
+        self.sourceURI = data.attrib.get('source')  # remote playlist item
         self.viewOffset = utils.cast(int, data.attrib.get('viewOffset', 0))
         self.year = utils.cast(int, data.attrib.get('year'))
 

plexapi/base.py

@@ -22,12 +22,12 @@
     'lt': lambda v, q: v < q,
     'lte': lambda v, q: v <= q,
     'startswith': lambda v, q: v.startswith(q),
-    'istartswith': lambda v, q: v.lower().startswith(q),
+    'istartswith': lambda v, q: v.lower().startswith(q.lower()),
     'endswith': lambda v, q: v.endswith(q),
-    'iendswith': lambda v, q: v.lower().endswith(q),
+    'iendswith': lambda v, q: v.lower().endswith(q.lower()),
     'exists': lambda v, q: v is not None if q else v is None,
-    'regex': lambda v, q: re.match(q, v),
-    'iregex': lambda v, q: re.match(q, v, flags=re.IGNORECASE),
+    'regex': lambda v, q: bool(re.search(q, v)),
+    'iregex': lambda v, q: bool(re.search(q, v, flags=re.IGNORECASE)),
 }
 
 
@@ -440,7 +440,7 @@ def _getAttrValue(self, elem, attrstr, results=None):
         attrstr = parts[1] if len(parts) == 2 else None
         if attrstr:
             results = [] if results is None else results
-            for child in [c for c in elem if c.tag.lower() == attr.lower()]:
+            for child in (c for c in elem if c.tag.lower() == attr.lower()):
                 results += self._getAttrValue(child, attrstr, results)
             return [r for r in results if r is not None]
         # check were looking for the tag

plexapi/const.py

@@ -4,6 +4,6 @@
 # Library version
 MAJOR_VERSION = 4
 MINOR_VERSION = 15
-PATCH_VERSION = 9
+PATCH_VERSION = 10
 __short_version__ = f"{MAJOR_VERSION}.{MINOR_VERSION}"
 __version__ = f"{__short_version__}.{PATCH_VERSION}"

plexapi/exceptions.py

@@ -29,3 +29,8 @@ class Unsupported(PlexApiException):
 class Unauthorized(BadRequest):
     """ Invalid username/password or token. """
     pass
+
+
+class TwoFactorRequired(Unauthorized):
+    """ Two factor authentication required. """
+    pass

plexapi/mixins.py

@@ -1196,7 +1196,7 @@ class AlbumEditMixins(
 class TrackEditMixins(
     ArtLockMixin, PosterLockMixin, ThemeLockMixin,
     AddedAtMixin, TitleMixin, TrackArtistMixin, TrackNumberMixin, TrackDiscNumberMixin, UserRatingMixin,
-    CollectionMixin, LabelMixin, MoodMixin
+    CollectionMixin, GenreMixin, LabelMixin, MoodMixin
 ):
     pass
 

plexapi/myplex.py

@@ -12,7 +12,7 @@
                      log, logfilter, utils)
 from plexapi.base import PlexObject
 from plexapi.client import PlexClient
-from plexapi.exceptions import BadRequest, NotFound, Unauthorized
+from plexapi.exceptions import BadRequest, NotFound, Unauthorized, TwoFactorRequired
 from plexapi.library import LibrarySection
 from plexapi.server import PlexServer
 from plexapi.sonos import PlexSonosClient
@@ -237,6 +237,8 @@ def query(self, url, method=None, headers=None, timeout=None, **kwargs):
             errtext = response.text.replace('\n', ' ')
             message = f'({response.status_code}) {codename}; {response.url} {errtext}'
             if response.status_code == 401:
+                if "verification code" in response.text:
+                    raise TwoFactorRequired(message)
                 raise Unauthorized(message)
             elif response.status_code == 404:
                 raise NotFound(message)

plexapi/photo.py

@@ -180,6 +180,8 @@ class Photo(
             parentThumb (str): URL to photo album thumbnail image (/library/metadata/<parentRatingKey>/thumb/<thumbid>).
             parentTitle (str): Name of the photo album for the photo.
             ratingKey (int): Unique key identifying the photo.
+            sourceURI (str): Remote server URI (server://<machineIdentifier>/com.plexapp.plugins.library)
+                (remote playlist item only).
             summary (str): Summary of the photo.
             tags (List<:class:`~plexapi.media.Tag`>): List of tag objects.
             thumb (str): URL to thumbnail image (/library/metadata/<ratingKey>/thumb/<thumbid>).
@@ -218,6 +220,7 @@ def _loadData(self, data):
         self.parentThumb = data.attrib.get('parentThumb')
         self.parentTitle = data.attrib.get('parentTitle')
         self.ratingKey = utils.cast(int, data.attrib.get('ratingKey'))
+        self.sourceURI = data.attrib.get('source')  # remote playlist item
         self.summary = data.attrib.get('summary')
         self.tags = self.findItems(data, media.Tag)
         self.thumb = data.attrib.get('thumb')

plexapi/video.py

@@ -368,7 +368,10 @@ class Movie(
             ratingImage (str): Key to critic rating image (rottentomatoes://image.rating.rotten).
             ratings (List<:class:`~plexapi.media.Rating`>): List of rating objects.
             roles (List<:class:`~plexapi.media.Role`>): List of role objects.
+            slug (str): The clean watch.plex.tv URL identifier for the movie.
             similar (List<:class:`~plexapi.media.Similar`>): List of Similar objects.
+            sourceURI (str): Remote server URI (server://<machineIdentifier>/com.plexapp.plugins.library)
+                (remote playlist item only).
             studio (str): Studio that created movie (Di Bonaventura Pictures; 21 Laps Entertainment).
             tagline (str): Movie tag line (Back 2 Work; Who says men can't change?).
             theme (str): URL to theme resource (/library/metadata/<ratingkey>/theme/<themeid>).
@@ -411,7 +414,9 @@ def _loadData(self, data):
         self.ratingImage = data.attrib.get('ratingImage')
         self.ratings = self.findItems(data, media.Rating)
         self.roles = self.findItems(data, media.Role)
+        self.slug = data.attrib.get('slug')
         self.similar = self.findItems(data, media.Similar)
+        self.sourceURI = data.attrib.get('source')  # remote playlist item
         self.studio = data.attrib.get('studio')
         self.tagline = data.attrib.get('tagline')
         self.theme = data.attrib.get('theme')
@@ -531,6 +536,7 @@ class Show(
                 (None = Library default, tmdbAiring = The Movie Database (Aired),
                 aired = TheTVDB (Aired), dvd = TheTVDB (DVD), absolute = TheTVDB (Absolute)).
             similar (List<:class:`~plexapi.media.Similar`>): List of Similar objects.
+            slug (str): The clean watch.plex.tv URL identifier for the show.
             studio (str): Studio that created show (Di Bonaventura Pictures; 21 Laps Entertainment).
             subtitleLanguage (str): Setting that indicates the preferred subtitle language.
             subtitleMode (int): Setting that indicates the auto-select subtitle mode.
@@ -580,6 +586,7 @@ def _loadData(self, data):
         self.seasonCount = utils.cast(int, data.attrib.get('seasonCount', self.childCount))
         self.showOrdering = data.attrib.get('showOrdering')
         self.similar = self.findItems(data, media.Similar)
+        self.slug = data.attrib.get('slug')
         self.studio = data.attrib.get('studio')
         self.subtitleLanguage = data.attrib.get('subtitleLanguage', '')
         self.subtitleMode = utils.cast(int, data.attrib.get('subtitleMode', '-1'))
@@ -717,6 +724,7 @@ class Season(
             parentIndex (int): Plex index number for the show.
             parentKey (str): API URL of the show (/library/metadata/<parentRatingKey>).
             parentRatingKey (int): Unique key identifying the show.
+            parentSlug (str): The clean watch.plex.tv URL identifier for the show.
             parentStudio (str): Studio that created show.
             parentTheme (str): URL to show theme resource (/library/metadata/<parentRatingkey>/theme/<themeid>).
             parentThumb (str): URL to show thumbnail image (/library/metadata/<parentRatingKey>/thumb/<thumbid>).
@@ -746,6 +754,7 @@ def _loadData(self, data):
         self.parentIndex = utils.cast(int, data.attrib.get('parentIndex'))
         self.parentKey = data.attrib.get('parentKey')
         self.parentRatingKey = utils.cast(int, data.attrib.get('parentRatingKey'))
+        self.parentSlug = data.attrib.get('parentSlug')
         self.parentStudio = data.attrib.get('parentStudio')
         self.parentTheme = data.attrib.get('parentTheme')
         self.parentThumb = data.attrib.get('parentThumb')
@@ -877,6 +886,7 @@ class Episode(
             grandparentGuid (str): Plex GUID for the show (plex://show/5d9c086fe9d5a1001f4d9fe6).
             grandparentKey (str): API URL of the show (/library/metadata/<grandparentRatingKey>).
             grandparentRatingKey (int): Unique key identifying the show.
+            grandparentSlug (str): The clean watch.plex.tv URL identifier for the show.
             grandparentTheme (str): URL to show theme resource (/library/metadata/<grandparentRatingkey>/theme/<themeid>).
             grandparentThumb (str): URL to show thumbnail image (/library/metadata/<grandparentRatingKey>/thumb/<thumbid>).
             grandparentTitle (str): Name of the show for the episode.
@@ -898,6 +908,8 @@ class Episode(
             ratings (List<:class:`~plexapi.media.Rating`>): List of rating objects.
             roles (List<:class:`~plexapi.media.Role`>): List of role objects.
             skipParent (bool): True if the show's seasons are set to hidden.
+            sourceURI (str): Remote server URI (server://<machineIdentifier>/com.plexapp.plugins.library)
+                (remote playlist item only).
             viewOffset (int): View offset in milliseconds.
             writers (List<:class:`~plexapi.media.Writer`>): List of writers objects.
             year (int): Year the episode was released.
@@ -922,6 +934,7 @@ def _loadData(self, data):
         self.grandparentGuid = data.attrib.get('grandparentGuid')
         self.grandparentKey = data.attrib.get('grandparentKey')
         self.grandparentRatingKey = utils.cast(int, data.attrib.get('grandparentRatingKey'))
+        self.grandparentSlug = data.attrib.get('grandparentSlug')
         self.grandparentTheme = data.attrib.get('grandparentTheme')
         self.grandparentThumb = data.attrib.get('grandparentThumb')
         self.grandparentTitle = data.attrib.get('grandparentTitle')
@@ -940,6 +953,7 @@ def _loadData(self, data):
         self.ratings = self.findItems(data, media.Rating)
         self.roles = self.findItems(data, media.Role)
         self.skipParent = utils.cast(bool, data.attrib.get('skipParent', '0'))
+        self.sourceURI = data.attrib.get('source')  # remote playlist item
         self.viewOffset = utils.cast(int, data.attrib.get('viewOffset', 0))
         self.writers = self.findItems(data, media.Writer)
         self.year = utils.cast(int, data.attrib.get('year'))

requirements_dev.txt

@@ -14,5 +14,5 @@ requests==2.31.0
 requests-mock==1.11.0
 sphinx==7.1.2
 sphinx-rtd-theme==2.0.0
-tqdm==4.66.1
+tqdm==4.66.2
 websocket-client==1.7.0

tests/test_audio.py

@@ -278,6 +278,7 @@ def test_audio_Track_attrs(album):
         assert utils.is_art(track.art)
     assert track.chapterSource is None
     assert utils.is_int(track.duration)
+    assert track.genres == []
     if track.grandparentArt:
         assert utils.is_art(track.grandparentArt)
     assert utils.is_metadata(track.grandparentKey)
@@ -422,6 +423,7 @@ def test_audio_Track_mixins_fields(track):
 
 def test_audio_Track_mixins_tags(track):
     test_mixins.edit_collection(track)
+    test_mixins.edit_genre(track)
     test_mixins.edit_label(track)
     test_mixins.edit_mood(track)
 

tests/test_history.py

@@ -5,7 +5,7 @@
 def test_history_Movie(movie):
     movie.markPlayed()
     history = movie.history()
-    assert len(history)
+    assert not len(history)
     movie.markUnplayed()
 
 
@@ -16,8 +16,7 @@ def test_history_Show(show):
     show.markUnplayed()
 
 
-def test_history_Season(show):
-    season = show.season("Season 1")
+def test_history_Season(season):
     season.markPlayed()
     history = season.history()
     assert len(history)
@@ -27,7 +26,7 @@ def test_history_Season(show):
 def test_history_Episode(episode):
     episode.markPlayed()
     history = episode.history()
-    assert len(history)
+    assert not len(history)
     episode.markUnplayed()
 
 
@@ -48,49 +47,45 @@ def test_history_Album(album):
 def test_history_Track(track):
     track.markPlayed()
     history = track.history()
-    assert len(history)
+    assert not len(history)
     track.markUnplayed()
 
 
-def test_history_MyAccount(account, movie, show):
-    movie.markPlayed()
+def test_history_MyAccount(account, show):
     show.markPlayed()
     history = account.history()
     assert len(history)
-    movie.markUnplayed()
     show.markUnplayed()
 
 
-def test_history_MyLibrary(plex, movie, show):
-    movie.markPlayed()
+def test_history_MyLibrary(plex, show):
     show.markPlayed()
     history = plex.library.history()
     assert len(history)
-    movie.markUnplayed()
     show.markUnplayed()
 
 
-def test_history_MySection(plex, movie):
-    movie.markPlayed()
-    history = plex.library.section("Movies").history()
+def test_history_MySection(tvshows, show):
+    show.markPlayed()
+    history = tvshows.history()
     assert len(history)
-    movie.markUnplayed()
+    show.markUnplayed()
 
 
-def test_history_MyServer(plex, movie):
-    movie.markPlayed()
+def test_history_MyServer(plex, show):
+    show.markPlayed()
     history = plex.history()
     assert len(history)
-    movie.markUnplayed()
+    show.markUnplayed()
 
 
-def test_history_PlexHistory(plex, movie):
-    movie.markPlayed()
+def test_history_PlexHistory(plex, show):
+    show.markPlayed()
     history = plex.history()
     assert len(history)
 
     hist = history[0]
-    assert hist.source() == movie
+    assert hist.source().show() == show
     assert hist.accountID
     assert hist.deviceID
     assert hist.historyKey

tests/test_video.py

@@ -92,6 +92,7 @@ def test_video_Movie_attrs(movies):
         assert utils.is_metadata(movie.primaryExtraKey)
     assert movie.ratingKey >= 1
     assert movie._server._baseurl == utils.SERVER_BASEURL
+    assert movie.slug == "sita-sings-the-blues"
     assert movie.studio == "Nina Paley"
     assert utils.is_string(movie.summary, gte=100)
     assert movie.tagline == "The Greatest Break-Up Story Ever Told."
@@ -788,6 +789,7 @@ def test_video_Show_attrs(show):
     assert show._server._baseurl == utils.SERVER_BASEURL
     assert utils.is_int(show.seasonCount)
     assert show.showOrdering in (None, 'aired')
+    assert show.slug == "game-of-thrones"
     assert show.studio == "Revolution Sun Studios"
     assert utils.is_string(show.summary, gte=100)
     assert show.subtitleLanguage == ''
@@ -1006,6 +1008,7 @@ def test_video_Season_attrs(show):
     assert season.parentIndex == 1
     assert utils.is_metadata(season.parentKey)
     assert utils.is_int(season.parentRatingKey)
+    assert season.parentSlug == "game-of-thrones"
     assert season.parentStudio == "Revolution Sun Studios"
     assert utils.is_metadata(season.parentTheme)
     if season.parentThumb:
@@ -1182,6 +1185,7 @@ def test_video_Episode_attrs(episode):
     assert episode.grandparentGuid == "plex://show/5d9c086c46115600200aa2fe"
     assert utils.is_metadata(episode.grandparentKey)
     assert utils.is_int(episode.grandparentRatingKey)
+    assert episode.grandparentSlug == "game-of-thrones"
     assert utils.is_metadata(episode.grandparentTheme)
     if episode.grandparentThumb:
         assert utils.is_thumb(episode.grandparentThumb)

tools/plex-gettoken.py

@@ -4,11 +4,16 @@
 Plex-GetToken is a simple method to retrieve a Plex account token.
 """
 from getpass import getpass
+from plexapi.exceptions import TwoFactorRequired
 from plexapi.myplex import MyPlexAccount
 
 username = input("Plex username: ")
 password = getpass("Plex password: ")
-code = input("Plex 2FA code (leave blank for none): ")
 
-account = MyPlexAccount(username, password, code=code)
+try:
+    account = MyPlexAccount(username, password)
+except TwoFactorRequired:
+    code = input("Plex 2FA code: ")
+    account = MyPlexAccount(username, password, code=code)
+
 print(account.authenticationToken)