Type annotations and mypy

build.py

@@ -41,8 +41,11 @@ def create_addon_xml(config: dict, source: str, py_version: str) -> None:
 
     # Populate dependencies in template
     dependencies = config['dependencies'].get(py_version)
+    requires_el = root.find('requires')
+    assert isinstance(requires_el, ET.Element), "Unable to find requires element in template"
+
     for dep in dependencies:
-        ET.SubElement(root.find('requires'), 'import', attrib=dep)
+        ET.SubElement(requires_el, 'import', attrib=dep)
 
     # Populate version string
     addon_version = config.get('version')
@@ -110,7 +113,6 @@ def folder_filter(folder_name: str) -> bool:
     return True
 
 
-
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(description='Build flags:')
     parser.add_argument(

jellyfin_kodi/client.py

@@ -7,7 +7,7 @@
 
 from kodi_six import xbmc, xbmcaddon, xbmcvfs
 
-from .helper import translate, window, settings, addon_id, dialog, LazyLogger
+from .helper import translate, window, settings, ADDON_ID, dialog, LazyLogger
 from .helper.utils import create_id, translate_path
 
 ##################################################################################################
@@ -21,11 +21,11 @@
 
     ''' Used for logging.
     '''
-    return xbmcaddon.Addon(addon_id()).getAddonInfo('name').upper()
+    return xbmcaddon.Addon(ADDON_ID).getAddonInfo('name').upper()
 
 
 def get_version():
-    return xbmcaddon.Addon(addon_id()).getAddonInfo('version')
+    return xbmcaddon.Addon(ADDON_ID).getAddonInfo('version')
 
 
 def get_platform():

jellyfin_kodi/connect.py

@@ -8,15 +8,15 @@
 from . import client
 from .database import get_credentials, save_credentials
 from .dialogs import ServerConnect, UsersConnect, LoginManual, ServerManual
-from .helper import settings, addon_id, event, api, window, LazyLogger
+from .helper import settings, ADDON_ID, event, api, window, LazyLogger
 from .jellyfin import Jellyfin
 from .jellyfin.connection_manager import CONNECTION_STATE
 from .helper.exceptions import HTTPException
 
 ##################################################################################################
 
 LOG = LazyLogger(__name__)
-XML_PATH = (xbmcaddon.Addon(addon_id()).getAddonInfo('path'), "default", "1080i")
+XML_PATH = (xbmcaddon.Addon(ADDON_ID).getAddonInfo('path'), "default", "1080i")
 
 ##################################################################################################
 
@@ -129,7 +129,7 @@
         except RuntimeError as error:
 
             LOG.exception(error)
-            xbmc.executebuiltin('Addon.OpenSettings(%s)' % addon_id())
+            xbmc.executebuiltin('Addon.OpenSettings(%s)' % ADDON_ID)
 
             raise Exception('User sign in interrupted')
 
@@ -144,17 +144,17 @@
 
         ''' Save user info.
         '''
-        self.user = client.jellyfin.get_user()
-        settings('username', self.user['Name'])
+        user = client.jellyfin.get_user()
+        settings('username', user['Name'])
 
-        if 'PrimaryImageTag' in self.user:
+        if 'PrimaryImageTag' in user:
             server_address = client.auth.get_server_info(client.auth.server_id)['address']
-            window('JellyfinUserImage', api.API(self.user, server_address).get_user_artwork(self.user['Id']))
+            window('JellyfinUserImage', api.API(user, server_address).get_user_artwork(user['Id']))
 
     def select_servers(self, state=None):
 
         state = state or self.connect_manager.connect({'enableAutoLogin': False})
-        user = {}
+        user = {}  # TODO: Fixme: content of this dict is used below, but can never contain anything
 
         dialog = ServerConnect("script-jellyfin-connect-server.xml", *XML_PATH)
         dialog.set_args(

jellyfin_kodi/database/__init__.py

@@ -8,6 +8,7 @@
 import sqlite3
 import sys
 import re
+from typing import Any, Dict
 
 from kodi_six import xbmc, xbmcvfs
 from six import text_type
@@ -36,7 +37,7 @@ class Database(object):
     '''
     timeout = 120
     discovered = False
-    discovered_file = None
+    discovered_file: str = None
 
     def __init__(self, db_file=None, commit_close=True):
 
@@ -318,7 +319,7 @@ def reset_artwork():
     LOG.info("[ reset artwork ]")
 
 
-def get_sync():
+def get_sync() -> dict:
     if (3, 0) <= sys.version_info < (3, 6):
         LOG.error("Python versions 3.0-3.5 are NOT supported.")
 
@@ -342,7 +343,7 @@ def get_sync():
     return sync
 
 
-def save_sync(sync):
+def save_sync(sync: Dict[str, Any]):
 
     if not xbmcvfs.exists(ADDON_DATA):
         xbmcvfs.mkdirs(ADDON_DATA)

jellyfin_kodi/database/jellyfin_db.py

@@ -1,5 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import division, absolute_import, print_function, unicode_literals
+
+from sqlite3 import Cursor
+
 #################################################################################################
 
 from . import queries as QU
@@ -14,9 +17,10 @@
 ##################################################################################################
 
 
-class JellyfinDatabase():
+class JellyfinDatabase:
+    cursor: Cursor
 
-    def __init__(self, cursor):
+    def __init__(self, cursor: Cursor) -> None:
         self.cursor = cursor
         cursor.row_factory = sqlite_namedtuple_factory
 

jellyfin_kodi/dialogs/context.py

@@ -4,11 +4,12 @@
 ##################################################################################################
 
 import os
+from typing import List, cast
 
 from kodi_six import xbmcgui, xbmcaddon
 from six import ensure_text
 
-from ..helper import window, addon_id
+from ..helper import window, ADDON_ID
 from ..helper import LazyLogger
 
 ##################################################################################################
@@ -27,7 +28,7 @@
 
 class ContextMenu(xbmcgui.WindowXMLDialog):
 
-    _options = []
+    _options: List[str] = []
     selected_option = None
 
     def __init__(self, *args, **kwargs):
@@ -51,7 +52,7 @@
             self.getControl(USER_IMAGE).setImage(window('JellyfinUserImage'))
 
         LOG.info("options: %s", self._options)
-        self.list_ = self.getControl(LIST)
+        self.list_ = cast(xbmcgui.ControlList, self.getControl(LIST))
 
         for option in self._options:
             self.list_.addItem(self._add_listitem(option))
@@ -73,7 +74,7 @@
 
     def _add_editcontrol(self, x, y, height, width, password=0):
 
-        media = os.path.join(xbmcaddon.Addon(addon_id()).getAddonInfo('path'), 'resources', 'skins', 'default', 'media')
+        media = os.path.join(xbmcaddon.Addon(ADDON_ID).getAddonInfo('path'), 'resources', 'skins', 'default', 'media')
         control = xbmcgui.ControlImage(0, 0, 0, 0,
                                        filename=os.path.join(media, "white.png"),
                                        aspectRatio=0,

jellyfin_kodi/dialogs/resume.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import division, absolute_import, print_function, unicode_literals
 
+from typing import Optional
+
 ##################################################################################################
 
 from kodi_six import xbmc, xbmcgui
@@ -22,7 +24,7 @@
 class ResumeDialog(xbmcgui.WindowXMLDialog):
 
     _resume_point = None
-    selected_option = None
+    selected_option: Optional[int] = None
 
     def __init__(self, *args, **kwargs):
         xbmcgui.WindowXMLDialog.__init__(self, *args, **kwargs)

jellyfin_kodi/dialogs/serverconnect.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import division, absolute_import, print_function, unicode_literals
 
+from typing import Any, Dict, List
+
 ##################################################################################################
 
 from six import iteritems
@@ -32,7 +34,7 @@
 class ServerConnect(xbmcgui.WindowXMLDialog):
 
     user_image = None
-    servers = []
+    servers: List[Dict[str, Any]] = []
 
     _selected_server = None
     _connect_login = False

jellyfin_kodi/entrypoint/default.py

@@ -345,7 +345,7 @@
 
         actions = Actions(server_id, api_client)
         list_li = []
-        listing = listing if type(listing) == list else listing.get('Items', [])
+        listing = listing if isinstance(listing, list) else listing.get('Items', [])
 
         for item in listing:
 
@@ -885,7 +885,7 @@
     if xbmcvfs.exists(backup + '/'):
         if not dialog("yesno", "{jellyfin}", translate(33090)):
 
-            return backup()
+            return backup
 
         delete_folder(backup)
 

jellyfin_kodi/entrypoint/service.py

@@ -6,6 +6,7 @@
 import json
 import sys
 from datetime import datetime
+from typing import Any, Dict
 
 # Workaround for threads using datetime: _striptime is locked
 import _strptime  # noqa:F401
@@ -37,7 +38,7 @@
     monitor = None
     play_event = None
     warn = True
-    settings = {'last_progress': datetime.today(), 'last_progress_report': datetime.today()}
+    settings: Dict[str, Any] = {'last_progress': datetime.today(), 'last_progress_report': datetime.today()}
 
     def __init__(self):
 
@@ -264,17 +265,17 @@
             window('jellyfin_should_stop.bool', True)
             self.running = False
 
-        elif method in ('SyncLibrarySelection', 'RepairLibrarySelection', 'AddLibrarySelection', 'RemoveLibrarySelection'):
+        elif self.library_thread is not None and method in ('SyncLibrarySelection', 'RepairLibrarySelection', 'AddLibrarySelection', 'RemoveLibrarySelection'):
             self.library_thread.select_libraries(method)
 
-        elif method == 'SyncLibrary':
+        elif self.library_thread is not None and method == 'SyncLibrary':
             if not data.get('Id'):
                 return
 
             self.library_thread.add_library(data['Id'], data.get('Update', False))
             xbmc.executebuiltin("Container.Refresh")
 
-        elif method == 'RepairLibrary':
+        elif self.library_thread is not None and method == 'RepairLibrary':
             if not data.get('Id'):
                 return
 
@@ -288,7 +289,7 @@
             self.library_thread.add_library(data['Id'])
             xbmc.executebuiltin("Container.Refresh")
 
-        elif method == 'RemoveLibrary':
+        elif self.library_thread is not None and method == 'RemoveLibrary':
             libraries = data['Id'].split(',')
 
             for lib in libraries:
@@ -309,10 +310,11 @@
                 self.library_thread = None
 
             Jellyfin.close_all()
-            self.monitor.server = []
-            self.monitor.sleep = True
+            if self.monitor is not None:
+                self.monitor.server = []
+                self.monitor.sleep = True
 
-        elif method == 'System.OnWake':
+        elif self.monitor is not None and method == 'System.OnWake':
 
             if not self.monitor.sleep:
                 LOG.warning("System.OnSleep was never called, skip System.OnWake")
@@ -365,7 +367,7 @@
             self.settings['enable_context_transcode'] = settings('enableContextTranscode.bool')
             LOG.info("New context transcode setting: %s", self.settings['enable_context_transcode'])
 
-        if settings('useDirectPaths') != self.settings['mode'] and self.library_thread.started:
+        if self.library_thread is not None and settings('useDirectPaths') != self.settings['mode'] and self.library_thread.started:
 
             self.settings['mode'] = settings('useDirectPaths')
             LOG.info("New playback mode setting: %s", self.settings['mode'])

jellyfin_kodi/full_sync.py

@@ -5,6 +5,7 @@
 
 from contextlib import contextmanager
 import datetime
+from typing import Any, Dict
 
 from kodi_six import xbmc
 
@@ -29,8 +30,8 @@ class FullSync(object):
             sync.libraries()
     '''
     # Borg - multiple instances, shared state
-    _shared_state = {}
-    sync = None
+    _shared_state: Dict[str, Any] = {}
+    sync = get_sync()
     running = False
     screensaver = None
 

jellyfin_kodi/helper/__init__.py

@@ -4,7 +4,7 @@
 
 from .translate import translate
 
-from .utils import addon_id
+from .utils import ADDON_ID
 from .utils import window
 from .utils import settings
 from .utils import kodi_version

jellyfin_kodi/helper/api.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 from __future__ import division, absolute_import, print_function, unicode_literals
 
+from typing import Any, Dict, List
+
 ##################################################################################################
 
 from . import settings, LazyLogger
@@ -42,7 +44,7 @@
         return self.item['Name']
 
     def get_actors(self):
-        cast = []
+        cast: List[Dict[str, Any]] = []
 
         if 'People' in self.item:
             self.get_people_artwork(self.item['People'])

jellyfin_kodi/helper/loghandler.py

@@ -6,6 +6,7 @@
 import os
 import logging
 import traceback
+from typing import Dict, List
 
 from six import ensure_text
 from kodi_six import xbmc, xbmcaddon
@@ -36,7 +37,7 @@ def __init__(self):
         logging.StreamHandler.__init__(self)
         self.setFormatter(MyFormatter())
 
-        self.sensitive = {'Token': [], 'Server': []}
+        self.sensitive: Dict[str, List[str]] = {'Token': [], 'Server': []}
 
         for server in database.get_credentials()['Servers']:
 

jellyfin_kodi/helper/translate.py

@@ -18,7 +18,7 @@ def translate(string):
 
     ''' Get add-on string. Returns in unicode.
     '''
-    if type(string) != int:
+    if not isinstance(string, int):
         string = STRINGS[string]
 
     result = xbmcaddon.Addon('plugin.video.jellyfin').getLocalizedString(string)