From 176fa07e8034cbbdfbc952745e356abefc432b0a Mon Sep 17 00:00:00 2001
From: croneter <croneter@users.noreply.github.com>
Date: Mon, 13 Sep 2021 11:24:06 +0200
Subject: [PATCH] Refactoring: move all exceptions in a single module

---
 resources/lib/db.py                 |  8 +-------
 resources/lib/exceptions.py         | 32 +++++++++++++++++++++++++++++
 resources/lib/kodimonitor.py        |  5 +++--
 resources/lib/playback.py           |  5 +++--
 resources/lib/playlist_func.py      |  8 +-------
 resources/lib/playlists/__init__.py |  4 ++--
 resources/lib/playlists/common.py   |  9 ++------
 resources/lib/playlists/db.py       |  5 +++--
 resources/lib/playlists/kodi_pl.py  |  4 +++-
 resources/lib/playlists/plex_pl.py  |  3 ++-
 resources/lib/playlists/pms.py      |  4 ++--
 resources/lib/playqueue.py          |  9 ++++----
 resources/lib/plex_companion.py     |  5 +++--
 resources/lib/subtitles.py          |  5 +----
 14 files changed, 63 insertions(+), 43 deletions(-)
 create mode 100644 resources/lib/exceptions.py

diff --git a/resources/lib/db.py b/resources/lib/db.py
index d6b1bfaf..140493a3 100644
--- a/resources/lib/db.py
+++ b/resources/lib/db.py
@@ -4,19 +4,13 @@ import sqlite3
 from functools import wraps
 
 from . import variables as v, app
+from .exceptions import LockedDatabase
 
 DB_WRITE_ATTEMPTS = 100
 DB_WRITE_ATTEMPTS_TIMEOUT = 1  # in seconds
 DB_CONNECTION_TIMEOUT = 10
 
 
-class LockedDatabase(Exception):
-    """
-    Dedicated class to make sure we're not silently catching locked DBs.
-    """
-    pass
-
-
 def catch_operationalerrors(method):
     """
     sqlite.OperationalError is raised immediately if another DB connection
diff --git a/resources/lib/exceptions.py b/resources/lib/exceptions.py
new file mode 100644
index 00000000..396277a0
--- /dev/null
+++ b/resources/lib/exceptions.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, division, unicode_literals
+
+
+class PlaylistError(Exception):
+    """
+    Exception for our playlist constructs
+    """
+    pass
+
+
+class LockedDatabase(Exception):
+    """
+    Dedicated class to make sure we're not silently catching locked DBs.
+    """
+    pass
+
+
+class SubtitleError(Exception):
+    """
+    Exceptions relating to subtitles
+    """
+    pass
+
+
+class ProcessingNotDone(Exception):
+    """
+    Exception to detect whether we've completed our sync and did not have to
+    abort or suspend.
+    """
+    pass
diff --git a/resources/lib/kodimonitor.py b/resources/lib/kodimonitor.py
index e387675b..d9e5d8b0 100644
--- a/resources/lib/kodimonitor.py
+++ b/resources/lib/kodimonitor.py
@@ -20,6 +20,7 @@ from .downloadutils import DownloadUtils as DU
 from . import utils, timing, plex_functions as PF
 from . import json_rpc as js, playqueue as PQ, playlist_func as PL
 from . import backgroundthread, app, variables as v
+from . import exceptions
 
 LOG = getLogger('PLEX.kodimonitor')
 
@@ -181,7 +182,7 @@ class KodiMonitor(xbmc.Monitor):
         try:
             for i, item in enumerate(items):
                 PL.add_item_to_plex_playqueue(playqueue, i + 1, kodi_item=item)
-        except PL.PlaylistError:
+        except exceptions.PlaylistError:
             LOG.info('Could not build Plex playlist for: %s', items)
 
     def _json_item(self, playerid):
@@ -318,7 +319,7 @@ class KodiMonitor(xbmc.Monitor):
                 return
             try:
                 item = PL.init_plex_playqueue(playqueue, plex_id=plex_id)
-            except PL.PlaylistError:
+            except exceptions.PlaylistError:
                 LOG.info('Could not initialize the Plex playlist')
                 return
             item.file = path
diff --git a/resources/lib/playback.py b/resources/lib/playback.py
index 310f8b0f..1ce775a7 100644
--- a/resources/lib/playback.py
+++ b/resources/lib/playback.py
@@ -16,6 +16,7 @@ from .kodi_db import KodiVideoDB
 from . import plex_functions as PF, playlist_func as PL, playqueue as PQ
 from . import json_rpc as js, variables as v, utils, transfer
 from . import playback_decision, app
+from . import exceptions
 
 ###############################################################################
 LOG = getLogger('PLEX.playback')
@@ -192,7 +193,7 @@ def _playback_init(plex_id, plex_type, playqueue, pos, resume):
         # Special case - we already got a filled Kodi playqueue
         try:
             _init_existing_kodi_playlist(playqueue, pos)
-        except PL.PlaylistError:
+        except exceptions.PlaylistError:
             LOG.error('Playback_init for existing Kodi playlist failed')
             _ensure_resolve(abort=True)
             return
@@ -312,7 +313,7 @@ def _init_existing_kodi_playlist(playqueue, pos):
     kodi_items = js.playlist_get_items(playqueue.playlistid)
     if not kodi_items:
         LOG.error('No Kodi items returned')
-        raise PL.PlaylistError('No Kodi items returned')
+        raise exceptions.PlaylistError('No Kodi items returned')
     item = PL.init_plex_playqueue(playqueue, kodi_item=kodi_items[pos])
     item.force_transcode = app.PLAYSTATE.force_transcode
     # playqueue.py will add the rest - this will likely put the PMS under
diff --git a/resources/lib/playlist_func.py b/resources/lib/playlist_func.py
index 80bd387a..2aad50df 100644
--- a/resources/lib/playlist_func.py
+++ b/resources/lib/playlist_func.py
@@ -15,19 +15,13 @@ from . import utils
 from . import json_rpc as js
 from . import variables as v
 from . import app
+from .exceptions import PlaylistError
 from .subtitles import accessible_plex_subtitles
 
 
 LOG = getLogger('PLEX.playlist_func')
 
 
-class PlaylistError(Exception):
-    """
-    Exception for our playlist constructs
-    """
-    pass
-
-
 class Playqueue_Object(object):
     """
     PKC object to represent PMS playQueues and Kodi playlist for queueing
diff --git a/resources/lib/playlists/__init__.py b/resources/lib/playlists/__init__.py
index 5e612a4c..2ca77fea 100644
--- a/resources/lib/playlists/__init__.py
+++ b/resources/lib/playlists/__init__.py
@@ -15,13 +15,13 @@ from __future__ import absolute_import, division, unicode_literals
 from logging import getLogger
 from sqlite3 import OperationalError
 
-from .common import Playlist, PlaylistError, PlaylistObserver, \
-    kodi_playlist_hash
+from .common import Playlist, PlaylistObserver, kodi_playlist_hash
 from . import pms, db, kodi_pl, plex_pl
 
 from ..watchdog import events
 from ..plex_api import API
 from .. import utils, path_ops, variables as v, app
+from ..exceptions import PlaylistError
 
 ###############################################################################
 LOG = getLogger('PLEX.playlists')
diff --git a/resources/lib/playlists/common.py b/resources/lib/playlists/common.py
index 96ca151b..7dae1e9a 100644
--- a/resources/lib/playlists/common.py
+++ b/resources/lib/playlists/common.py
@@ -12,6 +12,8 @@ from ..watchdog.observers import Observer
 from ..watchdog.utils.bricks import OrderedSetQueue
 
 from .. import path_ops, variables as v, app
+from ..exceptions import PlaylistError
+
 ###############################################################################
 LOG = getLogger('PLEX.playlists.common')
 
@@ -20,13 +22,6 @@ SIMILAR_EVENTS = (events.EVENT_TYPE_CREATED, events.EVENT_TYPE_MODIFIED)
 ###############################################################################
 
 
-class PlaylistError(Exception):
-    """
-    The one main exception thrown if anything goes awry
-    """
-    pass
-
-
 class Playlist(object):
     """
     Class representing a synced Playlist with info for both Kodi and Plex.
diff --git a/resources/lib/playlists/db.py b/resources/lib/playlists/db.py
index 673fc02a..66e4d888 100644
--- a/resources/lib/playlists/db.py
+++ b/resources/lib/playlists/db.py
@@ -7,10 +7,11 @@ module
 from __future__ import absolute_import, division, unicode_literals
 from logging import getLogger
 
-from .common import Playlist, PlaylistError
+from .common import Playlist
 from ..plex_db import PlexDB
 from ..kodi_db import kodiid_from_filename
 from .. import path_ops, utils, variables as v
+from ..exceptions import PlaylistError
 ###############################################################################
 LOG = getLogger('PLEX.playlists.db')
 
@@ -121,7 +122,7 @@ def m3u_to_plex_ids(playlist):
 def playlist_file_to_plex_ids(playlist):
     """
     Takes the playlist file located at path [unicode] and parses it.
-    Returns a list of plex_ids (str) or raises PL.PlaylistError if a single
+    Returns a list of plex_ids (str) or raises PlaylistError if a single
     item cannot be parsed from Kodi to Plex.
     """
     if playlist.kodi_extension == 'm3u':
diff --git a/resources/lib/playlists/kodi_pl.py b/resources/lib/playlists/kodi_pl.py
index 39cfa5de..86629d2f 100644
--- a/resources/lib/playlists/kodi_pl.py
+++ b/resources/lib/playlists/kodi_pl.py
@@ -7,11 +7,13 @@ from __future__ import absolute_import, division, unicode_literals
 from logging import getLogger
 import re
 
-from .common import Playlist, PlaylistError, kodi_playlist_hash
+from .common import Playlist, kodi_playlist_hash
 from . import db, pms
 
 from ..plex_api import API
 from .. import utils, path_ops, variables as v
+from ..exceptions import PlaylistError
+
 ###############################################################################
 LOG = getLogger('PLEX.playlists.kodi_pl')
 REGEX_FILE_NUMBERING = re.compile(r'''_(\d\d)\.\w+$''')
diff --git a/resources/lib/playlists/plex_pl.py b/resources/lib/playlists/plex_pl.py
index 2b10af60..2bca0779 100644
--- a/resources/lib/playlists/plex_pl.py
+++ b/resources/lib/playlists/plex_pl.py
@@ -6,8 +6,9 @@ Create and delete playlists on the Plex side of things
 from __future__ import absolute_import, division, unicode_literals
 from logging import getLogger
 
-from .common import PlaylistError
 from . import pms, db
+from ..exceptions import PlaylistError
+
 ###############################################################################
 LOG = getLogger('PLEX.playlists.plex_pl')
 # Used for updating Plex playlists due to Kodi changes - Plex playlist
diff --git a/resources/lib/playlists/pms.py b/resources/lib/playlists/pms.py
index b4de8e4a..e13540aa 100644
--- a/resources/lib/playlists/pms.py
+++ b/resources/lib/playlists/pms.py
@@ -7,11 +7,11 @@ manipulate playlists
 from __future__ import absolute_import, division, unicode_literals
 from logging import getLogger
 
-from .common import PlaylistError
-
 from ..plex_api import API
 from ..downloadutils import DownloadUtils as DU
 from .. import utils, app, variables as v
+from ..exceptions import PlaylistError
+
 ###############################################################################
 LOG = getLogger('PLEX.playlists.pms')
 
diff --git a/resources/lib/playqueue.py b/resources/lib/playqueue.py
index 45fb1d50..46edb0bc 100644
--- a/resources/lib/playqueue.py
+++ b/resources/lib/playqueue.py
@@ -12,6 +12,7 @@ import xbmc
 from .plex_api import API
 from . import playlist_func as PL, plex_functions as PF
 from . import backgroundthread, utils, json_rpc as js, app, variables as v
+from . import exceptions
 
 ###############################################################################
 LOG = getLogger('PLEX.playqueue')
@@ -88,7 +89,7 @@ def init_playqueue_from_plex_children(plex_id, transient_token=None):
         api = API(child)
         try:
             PL.add_item_to_playlist(playqueue, i, plex_id=api.plex_id)
-        except PL.PlaylistError:
+        except exceptions.PlaylistError:
             LOG.error('Could not add Plex item to our playlist: %s, %s',
                       child.tag, child.attrib)
     playqueue.plex_transient_token = transient_token
@@ -151,7 +152,7 @@ class PlayqueueMonitor(backgroundthread.KillableThread):
                               i + j, i)
                     try:
                         PL.move_playlist_item(playqueue, i + j, i)
-                    except PL.PlaylistError:
+                    except exceptions.PlaylistError:
                         LOG.error('Could not modify playqueue positions')
                         LOG.error('This is likely caused by mixing audio and '
                                   'video tracks in the Kodi playqueue')
@@ -167,7 +168,7 @@ class PlayqueueMonitor(backgroundthread.KillableThread):
                         PL.add_item_to_plex_playqueue(playqueue,
                                                       i,
                                                       kodi_item=new_item)
-                except PL.PlaylistError:
+                except exceptions.PlaylistError:
                     # Could not add the element
                     pass
                 except KeyError:
@@ -196,7 +197,7 @@ class PlayqueueMonitor(backgroundthread.KillableThread):
             LOG.debug('Detected deletion of playqueue element at pos %s', i)
             try:
                 PL.delete_playlist_item_from_PMS(playqueue, i)
-            except PL.PlaylistError:
+            except exceptions.PlaylistError:
                 LOG.error('Could not delete PMS element from position %s', i)
                 LOG.error('This is likely caused by mixing audio and '
                           'video tracks in the Kodi playqueue')
diff --git a/resources/lib/plex_companion.py b/resources/lib/plex_companion.py
index e0cbb807..1f135a78 100644
--- a/resources/lib/plex_companion.py
+++ b/resources/lib/plex_companion.py
@@ -21,6 +21,7 @@ from . import playqueue as PQ
 from . import variables as v
 from . import backgroundthread
 from . import app
+from . import exceptions
 
 ###############################################################################
 
@@ -51,7 +52,7 @@ def update_playqueue_from_PMS(playqueue,
     with app.APP.lock_playqueues:
         try:
             xml = PL.get_PMS_playlist(playqueue, playqueue_id)
-        except PL.PlaylistError:
+        except exceptions.PlaylistError:
             LOG.error('Could now download playqueue %s', playqueue_id)
             return
         if playqueue.id == playqueue_id:
@@ -64,7 +65,7 @@ def update_playqueue_from_PMS(playqueue,
         # Get new metadata for the playqueue first
         try:
             PL.get_playlist_details_from_xml(playqueue, xml)
-        except PL.PlaylistError:
+        except exceptions.PlaylistError:
             LOG.error('Could not get playqueue ID %s', playqueue_id)
             return
         playqueue.repeat = 0 if not repeat else int(repeat)
diff --git a/resources/lib/subtitles.py b/resources/lib/subtitles.py
index 439e6373..3948d678 100644
--- a/resources/lib/subtitles.py
+++ b/resources/lib/subtitles.py
@@ -9,6 +9,7 @@ import xml.etree.ElementTree as etree
 from . import app
 from . import path_ops
 from . import variables as v
+from .exceptions import SubtitleError
 
 LOG = getLogger('PLEX.subtitles')
 
@@ -467,7 +468,3 @@ def external_subs_from_filesystem(dirname, filename):
 class DummySub(etree.Element):
     def __init__(self):
         super(DummySub, self).__init__('Stream-subtitle-dummy')
-
-
-class SubtitleError(Exception):
-    pass