improve documentation

Author: willforde

docs/api/script.rst

@@ -4,15 +4,6 @@ Script
 .. autoclass:: codequick.script.Script
     :members:
 
-    .. autoattribute:: codequick.script.Script.DEBUG
-    .. autoattribute:: codequick.script.Script.INFO
-    .. autoattribute:: codequick.script.Script.WARNING
-    .. autoattribute:: codequick.script.Script.ERROR
-    .. autoattribute:: codequick.script.Script.CRITICAL
-    .. autoattribute:: codequick.script.Script.NOTIFY_INFO
-    .. autoattribute:: codequick.script.Script.NOTIFY_ERROR
-    .. autoattribute:: codequick.script.Script.NOTIFY_WARNING
-
 .. autoclass:: codequick.script.Settings
     :members:
     :special-members: __getitem__, __setitem__

docs/conf.py

@@ -137,6 +137,8 @@
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
+    'classoptions': ',openany,oneside',
+    'babel' : '\\usepackage[polish]{babel}'
 }
 
 # Grouping the document tree into LaTeX files. List of tuples

script.module.codequick/lib/codequick/resolver.py

@@ -342,7 +342,7 @@ def _send_to_kodi(self, resolved):
             # Fetch the first element of the generator and process the rest in the background
             elif inspect.isgenerator(resolved):
                 listitem = self._create_playlist([next(resolved)])
-                self.register_metacall(self._process_generator, resolved)
+                self.register_delayed_callback(self._process_generator, resolved)
 
             # Create playlist if resolved is a dict of {title: url}
             elif hasattr(resolved, "items"):

script.module.codequick/lib/codequick/script.py

@@ -11,9 +11,8 @@
 import xbmc
 
 # Package imports
-from codequick.utils import CacheProperty, ensure_unicode, ensure_native_str, safe_path
+from codequick.utils import ensure_unicode, ensure_native_str, safe_path
 from codequick.support import dispatcher, script_data, addon_data, logger_id
-import urlquick
 
 __all__ = ["Script", "Settings"]
 
@@ -37,7 +36,7 @@ def __getitem__(self, key):
 
     def __setitem__(self, key, value):
         """
-        Set an add-on setting.
+        Set add-on setting.
 
         :param str key: Id of the setting.
         :param value: Value of the setting.
@@ -127,16 +126,22 @@ class Script(object):
     is_playable = False
     is_folder = False
 
-    # Logging Levels
+    #: Critical logging level, maps to 'xbmc.LOGFATAL'
     CRITICAL = 50
+    #: Critical logging level, maps to 'xbmc.LOGWARNING'
     WARNING = 30
+    #: Critical logging level, maps to 'xbmc.LOGERROR'
     ERROR = 40
+    #: Critical logging level, maps to 'xbmc.LOGDEBUG'
     DEBUG = 10
+    #: Critical logging level, maps to 'xbmc.LOGNOTICE'
     INFO = 20
 
-    # Notification icon options
+    #: Kodi notification warning image
     NOTIFY_WARNING = 'warning'
+    #: Kodi notification error image
     NOTIFY_ERROR = 'error'
+    #: Kodi notification info image
     NOTIFY_INFO = 'info'
 
     #: Underlining logger object, for advanced use.
@@ -173,17 +178,17 @@ def register(cls, callback):
         return dispatcher.register(callback, cls=cls)
 
     @staticmethod
-    def register_metacall(func, *args, **kwargs):
+    def register_delayed_callback(func, *args, **kwargs):
         """
         Register a function that will be executed after kodi has finished listing all listitems.
         Sence the function is called after the listitems have been shown, it will not slow anything down.
-        Very useful for fetching extra metadata without slowing down the listing of content.
+        Very useful for fetching extra metadata for later use without slowing down the listing of content.
 
         :param func: Function that will be called after endOfDirectory is called.
         :param args: Positional arguments that will be passed to function.
         :param kwargs: Keyword arguments that will be passed to function.
         """
-        dispatcher.register_metacall(func, args, kwargs)
+        dispatcher.register_delayed(func, args, kwargs)
 
     @staticmethod
     def log(msg, args=None, lvl=10):
@@ -200,7 +205,7 @@ def log(msg, args=None, lvl=10):
         :param msg: The message format string.
         :type args: list or tuple
         :param args: List of arguments which are merged into msg using the string formatting operator.
-        :param lvl: The logging level to use. default => 10(Debug).
+        :param lvl: The logging level to use. default => 10 (Debug).
 
         .. Note::
             When a log level of 50(CRITICAL) is given, then all debug messages that were previously logged
@@ -313,23 +318,3 @@ def get_info(key, addon_id=None):
                 os.mkdir(path)
 
         return resp
-
-    @CacheProperty
-    def icon(self):
-        """The add-on's icon image path."""
-        return self.get_info("icon")
-
-    @CacheProperty
-    def fanart(self):
-        """The add-on's fanart image path."""
-        return self.get_info("fanart")
-
-    @CacheProperty
-    def profile(self):
-        """The add-on's profile data directory path."""
-        return self.get_info("profile")
-
-    @CacheProperty
-    def path(self):
-        """The add-on's directory path."""
-        return self.get_info("path")

script.module.codequick/lib/codequick/search.py

@@ -31,7 +31,7 @@ def __init__(self):
 
         # Persistent list of currently saved searches
         self.search_db = PersistentList(SEARCH_DB)
-        self.register_metacall(self.close)
+        self.register_delayed_callback(self.close)
 
     def run(self, remove_entry=None, search=False, first_load=False, **extras):
         """List all saved searches."""

script.module.codequick/lib/codequick/support.py

@@ -291,7 +291,7 @@ def register(self, callback, cls):
         callback.test = tester
         return callback
 
-    def register_metacall(self, func, args, kwargs):
+    def register_delayed(self, func, args, kwargs):
         callback = (func, args, kwargs)
         self.metacalls.append(callback)
 

script.module.codequick/lib/codequick/utils.py

@@ -25,45 +25,10 @@
 # Unicode Type object, unicode on python2 or str on python3
 unicode_type = type(u"")
 
-__all__ = ["CacheProperty", "keyboard", "parse_qs", "urljoin_partial", "strip_tags",
+__all__ = ["keyboard", "parse_qs", "urljoin_partial", "strip_tags",
            "safe_path", "ensure_bytes", "ensure_native_str", "ensure_unicode"]
 
 
-class CacheProperty(object):
-    """
-    Decorator that converts a class method into a class property and caches the response on first access.
-
-    When the class property is accessed for the first time, the result is computed and returned.
-    The property is then replaced with an instance attribute with the computed result.
-
-    :example:
-        >>> import random
-        >>> class Test(object):
-        >>>     @CacheProperty
-        >>>     def data_id(self):
-        >>>         return random.random()
-        >>>
-        >>> obj = Test()
-        >>> print(obj.data_id)
-        0.39391705700202373
-        >>> print(obj.data_id)
-        0.39391705700202373
-    """
-
-    def __init__(self, func):
-        self.__name__ = func.__name__
-        self.__doc__ = func.__doc__
-        self._func = func
-
-    def __get__(self, instance, owner):
-        if instance:
-            attr = self._func(instance)
-            setattr(instance, self.__name__, attr)
-            return attr
-        else:
-            return self
-
-
 def keyboard(heading, default="", hidden=False):
     """
     Show a keyboard dialog with default text heading and hidden input flag if supplied.

script.module.codequick/lib/codequick/youtube.py

@@ -372,7 +372,7 @@ class APIControl(Route):
     def __init__(self):
         super(APIControl, self).__init__()
         self.db = Database()
-        self.register_metacall(self.db.cleanup)
+        self.register_delayed_callback(self.db.cleanup)
         self.api = API()
 
     def valid_playlistid(self, contentid):

tests/test_script.py

@@ -120,7 +120,7 @@ def test_register_metacall(self):
         def tester():
             pass
 
-        self.script.register_metacall(tester)
+        self.script.register_delayed_callback(tester)
         for callback, _, _ in script.dispatcher.metacalls:
             if callback is tester:
                 self.assertTrue(True, "")
@@ -205,15 +205,3 @@ def test_get_version(self):
 
     def test_get_name_addon(self):
         self.assertEqual(self.script.get_info("name", addon_id="script.module.codequick"), "CodeQuick")
-
-    def test_icon(self):
-        self.assertTrue(self.script.icon.endswith("script.module.codequick/resources/icon.png"))
-
-    def test_fanart(self):
-        self.assertTrue(self.script.fanart.endswith("script.module.codequick/fanart.jpg"))
-
-    def test_profile(self):
-        self.assertTrue(self.script.profile.endswith("userdata/addon_data/script.module.codequick"))
-
-    def test_path(self):
-        self.assertTrue(self.script.path.endswith("script.module.codequick"))

tests/test_support.py

@@ -138,7 +138,7 @@ def test_register_metacall(self):
         def root():
             pass
 
-        self.dispatcher.register_metacall(root, [], {})
+        self.dispatcher.register_delayed(root, [], {})
         self.assertListEqual(self.dispatcher.metacalls, [(root, [], {})])
 
     def test_metacalls(self):
@@ -149,7 +149,7 @@ def root():
             Executed.yes = True
             raise RuntimeError("should not be raised")
 
-        self.dispatcher.register_metacall(root, [], {})
+        self.dispatcher.register_delayed(root, [], {})
         self.dispatcher.run_metacalls()
         self.assertTrue(Executed.yes)