Merge pull request #384 from blacktwin/patch-8

upload, select, remove subtitles

Author: Hellowlol

plexapi/video.py

@@ -3,6 +3,7 @@
 from plexapi.exceptions import BadRequest, NotFound
 from plexapi.base import Playable, PlexPartialObject
 from plexapi.compat import quote_plus
+import os
 
 
 class Video(PlexPartialObject):
@@ -89,6 +90,37 @@ def _defaultSyncTitle(self):
         """ Returns str, default title for a new syncItem. """
         return self.title
 
+    def subtitleStreams(self):
+        """ Returns a list of :class:`~plexapi.media.SubtitleStream` objects for all MediaParts. """
+        streams = []
+
+        parts = self.iterParts()
+        for part in parts:
+            streams += part.subtitleStreams()
+        return streams
+
+    def uploadSubtitles(self, filepath):
+        """ Upload Subtitle file for video. """
+        url = '%s/subtitles' % self.key
+        filename = os.path.basename(filepath)
+        subFormat = os.path.splitext(filepath)[1][1:]
+        with open(filepath, 'rb') as subfile:
+            params = {'title': filename,
+                      'format': subFormat
+                      }
+            headers = {'Accept': 'text/plain, */*'}
+            self._server.query(url, self._server._session.post, data=subfile, params=params, headers=headers)
+
+    def removeSubtitles(self, streamID=None, streamTitle=None):
+        """ Remove Subtitle from movie's subtitles listing.
+
+            Note: If subtitle file is located inside video directory it will bbe deleted.
+            Files outside of video directory are not effected.
+        """
+        for stream in self.subtitleStreams():
+            if streamID == stream.id or streamTitle == stream.title:
+                self._server.query(stream.key, self._server._session.delete)
+
     def posters(self):
         """ Returns list of available poster objects. :class:`~plexapi.media.Poster`:"""
 
@@ -224,14 +256,6 @@ def locations(self):
         """
         return [part.file for part in self.iterParts() if part]
 
-    def subtitleStreams(self):
-        """ Returns a list of :class:`~plexapi.media.SubtitleStream` objects for all MediaParts. """
-        streams = []
-        for elem in self.media:
-            for part in elem.parts:
-                streams += part.subtitleStreams()
-        return streams
-
     def _prettyfilename(self):
         # This is just for compat.
         return self.title

tests/conftest.py

@@ -7,6 +7,12 @@
 from functools import partial
 from os import environ
 from plexapi.myplex import MyPlexAccount
+
+try:
+    from unittest.mock import patch, MagicMock, mock_open
+except ImportError:
+    from mock import patch, MagicMock, mock_open
+
 from plexapi import compat
 from plexapi.compat import patch, MagicMock
 from plexapi.client import PlexClient
@@ -219,6 +225,14 @@ def photoalbum(photos):
         return photos.get('Cats')
     except Exception:
         return photos.get('photo_album1')
+    
+@pytest.fixture()
+def subtitle():
+    mopen = mock_open()
+    with patch('__main__.open', mopen):
+        with open('subtitle.srt', 'w') as handler:
+            handler.write('test')
+        return handler
 
 
 @pytest.fixture()

tests/test_video.py

@@ -83,6 +83,30 @@ def test_video_Movie_download(monkeydownload, tmpdir, movie):
 def test_video_Movie_subtitlestreams(movie):
     assert not movie.subtitleStreams()
 
+def test_video_Episode_subtitlestreams(episode):
+    assert not episode.subtitleStreams()
+
+def test_video_Movie_upload_select_remove_subtitle(movie, subtitle):
+    import os
+    filepath = os.path.realpath(subtitle.name)
+    movie.uploadSubtitles(filepath)
+    subtitles = [sub.title for sub in movie.subtitleStreams()]
+    subname = subtitle.name.rsplit('.', 1)[0]
+    assert subname in subtitles
+
+    subtitleSelection = movie.subtitleStreams()[0]
+    parts = [part for part in movie.iterParts()]
+    parts[0].setDefaultSubtitleStream(subtitleSelection)
+
+    subtitleSelection = movie.subtitleStreams()[0]
+    assert subtitleSelection.selected
+
+    movie.removeSubtitles(streamTitle=subname)
+    subtitles = [sub.title for sub in movie.subtitleStreams()]
+    assert subname not in subtitles
+
+    if subtitle:
+        os.remove(filepath)
 
 def test_video_Movie_attrs(movies):
     movie = movies.get('Sita Sings the Blues')