lots of minor changes,

Author: willforde

docs/api/utils.rst

@@ -3,4 +3,4 @@ Utils
 A collection of useful functions.
 
 .. automodule:: codequick.utils
-   :members:
+   :members: keyboard, parse_qs, urljoin_partial, strip_tags, ensure_unicode

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

@@ -15,9 +15,9 @@
 # Package imports
 from codequick.script import Script
 from codequick.support import auto_sort, build_path, logger_id, dispatcher
-from codequick.utils import ensure_unicode, ensure_native_str, unicode_type, long_type
+from codequick.utils import ensure_unicode, ensure_native_str, unicode_type, PY3
 
-__all__ = ["Listitem", "Art", "Info", "Stream", "Context", "Property", "Params"]
+__all__ = ["Listitem"]
 
 # Logger specific to this module
 logger = logging.getLogger("%s.listitem" % logger_id)
@@ -40,6 +40,7 @@
 
 # Listing sort methods & sort mappings.
 # Skips infolables that have no sortmethod and type is string. As by default they will be string anyway
+# noinspection PyUnresolvedReferences
 infolable_map = {"artist": (None, xbmcplugin.SORT_METHOD_ARTIST_IGNORE_THE),
                  "studio": (ensure_native_str, xbmcplugin.SORT_METHOD_STUDIO_IGNORE_THE),
                  "title": (ensure_native_str, xbmcplugin.SORT_METHOD_TITLE_IGNORE_THE),
@@ -55,7 +56,7 @@
                  "country": (ensure_native_str, xbmcplugin.SORT_METHOD_COUNTRY),
                  "genre": (None, xbmcplugin.SORT_METHOD_GENRE),
                  "date": (ensure_native_str, xbmcplugin.SORT_METHOD_DATE),
-                 "size": (long_type, xbmcplugin.SORT_METHOD_SIZE),
+                 "size": (int if PY3 else long, xbmcplugin.SORT_METHOD_SIZE),
                  "sortepisode": (int, None),
                  "sortseason": (int, None),
                  "userrating": (int, None),
@@ -94,7 +95,10 @@ def __getitem__(self, key):
         return value.decode("utf8") if isinstance(value, bytes) else value
 
     def __setitem__(self, key, value):
-        self.raw_dict[key] = value
+        if isinstance(value, bytes):
+            self.raw_dict[key] = value.decode("utf8")
+        else:
+            self.raw_dict[key] = value
 
     def __delitem__(self, key):  # type: (str) -> None
         del self.raw_dict[key]
@@ -175,11 +179,14 @@ def global_thumb(self, image):
         # So there is no neeed to use ensure_native_str
         self.raw_dict["thumb"] = global_image.format(image)
 
-    def _close(self):
+    def _close(self, isfolder):
         if fanart and "fanart" not in self.raw_dict:  # pragma: no branch
             self.raw_dict["fanart"] = fanart
         if "thumb" not in self.raw_dict:  # pragma: no branch
             self.raw_dict["thumb"] = icon
+        if "icon" not in self.raw_dict:  # pragma: no branch
+            self.raw_dict["icon"] = "DefaultFolder.png" if isfolder else "DefaultVideo.png"
+
         self._listitem.setArt(self.raw_dict)
 
 
@@ -300,7 +307,12 @@ def _duration(duration):
         return duration
 
     def _close(self, content_type):
-        self._listitem.setInfo(content_type, self.raw_dict)
+        raw_dict = self.raw_dict
+        # Add label as plot if no plot is found
+        if "plot" not in raw_dict:  # pragma: no branch
+            raw_dict["plot"] = raw_dict["title"]
+
+        self._listitem.setInfo(content_type, raw_dict)
 
 
 class Property(Params):
@@ -527,7 +539,7 @@ def __init__(self, content_type="video"):
 
         self.params = Params()
         """
-        Dictionary like object for parameters that will be passed to the "callback" object.
+        Dictionary like object for parameters that will be passed to the "callback" function.
 
         :example:
             >>> item = Listitem()
@@ -556,7 +568,8 @@ def label(self):  # type: () -> str
             >>> item = Listitem()
             >>> item.label = "Video Title"
         """
-        return ensure_unicode(self.listitem.getLabel())
+        label = self.listitem.getLabel()
+        return label.decode("utf8") if isinstance(label, bytes) else label
 
     @label.setter
     def label(self, label):  # type: (str) -> None
@@ -596,15 +609,7 @@ def _close(self):
             path = callback
             isfolder = False
 
-        if isfolder:
-            # Set Kodi icon image if not already set
-            if "icon" not in self.art.raw_dict:  # pragma: no branch
-                self.art.raw_dict["icon"] = "DefaultFolder.png"
-        else:
-            # Set Kodi icon image if not already set
-            if "icon" not in self.art.raw_dict:  # pragma: no branch
-                self.art.raw_dict["icon"] = "DefaultVideo.png"
-
+        if not isfolder:
             # Add mediatype if not already set
             if "mediatype" not in self.info.raw_dict and self._content_type in ("video", "music"):  # pragma: no branch
                 self.info.raw_dict["mediatype"] = self._content_type
@@ -616,21 +621,16 @@ def _close(self):
             # Close video related datasets
             self.stream._close()
 
-        label = self.label
         # Set label to UNKNOWN if unset
-        if not label:  # pragma: no branch
-            self.label = label = u"UNKNOWN"
-
-        # Add label as plot if no plot is found
-        if "plot" not in self.info:  # pragma: no branch
-            self.info["plot"] = label
+        if not self.label:  # pragma: no branch
+            self.label = u"UNKNOWN"
 
         # Close common datasets
         self.listitem.setPath(path)
         self.property._close()
         self.context._close()
         self.info._close(self._content_type)
-        self.art._close()
+        self.art._close(isfolder)
 
         # Return a tuple compatible with 'xbmcplugin.addDirectoryItems'
         return path, self.listitem, isfolder

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

@@ -16,7 +16,7 @@
 import xbmc
 
 # Package imports
-from codequick.utils import parse_qs, ensure_native_str, urlparse
+from codequick.utils import parse_qs, ensure_native_str, urlparse, PY3
 
 script_data = xbmcaddon.Addon("script.module.codequick")
 addon_data = xbmcaddon.Addon()
@@ -127,11 +127,10 @@ def args_to_kwargs(self, args, kwargs):  # type: (tuple, dict) -> None
 
     def arg_names(self):  # type: () -> list
         """Return a list of argument names, positional and keyword arguments."""
-        try:
-            # noinspection PyUnresolvedReferences
+        if PY3:
             return inspect.getfullargspec(self.function).args
-        except AttributeError:
-            # "inspect.getargspec" is deprecated in python 3
+        else:
+            # noinspection PyDeprecation
             return inspect.getargspec(self.function).args
 
     def unittest_caller(self, *args, **kwargs):
@@ -340,7 +339,8 @@ def build_path(callback=None, args=None, query=None, **extra_query):
 
     # Encode the query parameters using json
     if query:
-        query = "_pickle_=" + ensure_native_str(binascii.hexlify(pickle.dumps(query, protocol=pickle.HIGHEST_PROTOCOL)))
+        pickled = binascii.hexlify(pickle.dumps(query, protocol=pickle.HIGHEST_PROTOCOL))
+        query = "_pickle_=" + pickled.decode("ascii") if PY3 else pickled
 
     # Build kodi url with new path and query parameters
     return urlparse.urlunsplit(("plugin", plugin_id, route.path, query, ""))

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

@@ -14,20 +14,11 @@
     # noinspection PyUnresolvedReferences
     import urlparse
 
-try:
-    # noinspection PyUnresolvedReferences
-    long_type = long
-except NameError:
-    long_type = int
-
 PY3 = sys.version_info[0] >= 3
 
 # Unicode Type object, unicode on python2 or str on python3
 unicode_type = type(u"")
 
-__all__ = ["keyboard", "parse_qs", "urljoin_partial", "strip_tags", "ensure_bytes",
-           "ensure_native_str", "ensure_unicode", "unicode_type", "long_type"]
-
 
 def keyboard(heading, default="", hidden=False):
     """
@@ -98,9 +89,9 @@ def parse_qs(qs, keep_blank_values=False, strict_parsing=False):
                 raise ValueError("encountered duplicate param field name: '%s'" % key)
     else:
         for bkey, value in parsed:
-            ukey = unicode_type(bkey, encoding="utf8")
+            ukey = bkey.decode("utf8")
             if ukey not in params:
-                params[ukey] = unicode_type(value, encoding="utf8")
+                params[ukey] = value.decode("utf8")
             else:
                 # Only add keys that are not already added, multiple values are not supported
                 raise ValueError("encountered duplicate param field name: '%s'" % bkey)
@@ -163,20 +154,6 @@ def strip_tags(html):
     return re.sub("<[^<]+?>", "", html)
 
 
-def ensure_bytes(data, encoding="utf8"):
-    """
-    Ensures that the given string is returned as type ``bytes``.
-
-    :type data: str or bytes
-    :param data: String to convert if needed.
-    :param str encoding: [opt] The encoding to use.
-
-    :returns: The given string as type ``bytes``
-    :rtype: bytes
-    """
-    return data if isinstance(data, bytes) else unicode_type(data).encode(encoding)
-
-
 def ensure_native_str(data, encoding="utf8"):
     """
     Ensures that the given string is returned as a native str type, ``bytes`` on Python 2, ``unicode`` on Python 3.
@@ -186,6 +163,8 @@ def ensure_native_str(data, encoding="utf8"):
     :returns: The given string as a native ``str`` type.
     :rtype: str
     """
+    # This is the fastest way
+    # that I can find to do this
     if isinstance(data, str):
         return data
     elif isinstance(data, unicode_type):
@@ -209,7 +188,4 @@ def ensure_unicode(data, encoding="utf8"):
     :returns: The given string as type ``unicode``.
     :rtype: str
     """
-    if isinstance(data, bytes):
-        return data.decode(encoding)
-    else:
-        return unicode_type(data)
+    return data.decode(encoding) if isinstance(data, bytes) else unicode_type(data)

tests/test_listing.py

@@ -2,9 +2,12 @@
 
 from codequick import listing, route, resolver
 from codequick.support import dispatcher
-from codequick.utils import unicode_type, long_type
+from codequick.utils import unicode_type
 import xbmcgui
 import xbmc
+import sys
+
+PY3 = sys.version_info >= (3, 0)
 
 
 class TestGlobalLocalization(unittest.TestCase):
@@ -69,15 +72,18 @@ def test_close_without_extras(self):
         listing.fanart = "fanart"
         self.assertNotIn("thumb", self.base)
         self.assertNotIn("fanart", self.base)
-        self.base._close()
+        self.assertNotIn("icon", self.base)
+        self.base._close(False)
         self.assertIn("thumb", self.base)
         self.assertIn("fanart", self.base)
+        self.assertIn("icon", self.base)
 
     def test_close_with_extras(self):
         listing.fanart = "fanart"
         self.base["fanart"] = ""
         self.base["thumb"] = ""
-        self.base._close()
+        self.base["icon"] = ""
+        self.base._close(False)
         self.assertIn("thumb", self.base)
         self.assertIn("fanart", self.base)
 
@@ -111,9 +117,15 @@ def test_duration_invalid(self):
         self.assertIsInstance(self.base["duration"], int)
         self.assertEqual(self.base["duration"], 330)
 
-    def test_size(self):
+    @unittest.skipIf(PY3, "Size is an long in python2")
+    def test_size_py2(self):
+        self.base["size"] = "256816"
+        self.assertIsInstance(self.base["size"], int)
+
+    @unittest.skipUnless(PY3, "Size is an int in python3")
+    def test_size_py3(self):
         self.base["size"] = "256816"
-        self.assertIsInstance(self.base["size"], long_type)
+        self.assertIsInstance(self.base["size"], int)
 
     def test_size_invalid(self):
         with self.assertRaises(TypeError):
@@ -142,6 +154,7 @@ def test_date(self):
         self.assertEqual(self.base["year"], "2017")
 
     def test_close(self):
+        self.base["plot"] = "plot"
         self.base._close("video")
 
 

tests/test_resolver.py

@@ -200,22 +200,3 @@ def test_extract_source_warning(self):
         YDStreamExtractor.mode = 4  # raise warning
         ret = self.resolver.extract_source("url")
         self.assertEqual(ret, "video.mkv")
-
-    def test_extract_youtube_url(self):
-        ret = self.resolver.extract_youtube("https://www.watchmojo.com/video/id/20838/")
-        self.assertEqual(ret, "plugin://plugin.video.youtube/play/?video_id=P3PvFiCibts")
-
-    def test_extract_youtube_source(self):
-        source = urlquick.get("https://www.watchmojo.com/video/id/20838/").text
-        ret = self.resolver.extract_youtube(source)
-        self.assertEqual(ret, "plugin://plugin.video.youtube/play/?video_id=P3PvFiCibts")
-
-    def test_extract_youtube_node(self):
-        html = urlquick.get("https://www.watchmojo.com/video/id/20838/")
-        video_elem = html.parse("div", attrs={"id": "question"})
-        ret = self.resolver.extract_youtube(video_elem)
-        self.assertEqual(ret, "plugin://plugin.video.youtube/play/?video_id=P3PvFiCibts")
-
-    def test_extract_youtube_no_video(self):
-        ret = self.resolver.extract_youtube("https://www.youtube.com/")
-        self.assertIsNone(ret)

tests/test_utils.py

@@ -18,16 +18,6 @@ def test_ensure_unicode_with_unicode(self):
         self.assertIsInstance(ret, utils.unicode_type)
         self.assertEqual(ret, u"teststring")
 
-    def test_ensure_bytes_with_bytes(self):
-        ret = utils.ensure_bytes(b"teststring")
-        self.assertIsInstance(ret, bytes)
-        self.assertEqual(ret, b"teststring")
-
-    def test_ensure_bytes_with_unicode(self):
-        ret = utils.ensure_bytes(u"teststring")
-        self.assertIsInstance(ret, bytes)
-        self.assertEqual(ret, b"teststring")
-
     def test_ensure_native_str_with_bytes(self):
         ret = utils.ensure_native_str(b"teststring")
         self.assertIsInstance(ret, str)