[Py2to3] Force unicode_literals and fix related issues

* Added `from __future__ import unicode_literals` to every file so now all strings in code are forced to be unicode strings unless marked as byte string `b'str'` or encoded to byte string `'str'.encode('utf-8')`. This is a large change but we have been working towards the goal of unicode strings passed in the code so decoding external input and encoding output as byte strings (where applicable). Note that in Python 2 the `str` type still refers to byte strings. * Replaced the use of `str` for `basestring` in isinstance comparison as this was the original intention but breaks code when encoutering unicode strings. * Marked byte strings in gtkui as the conversion to utf8 is not always handled, mostly related to gobject signal names.
DanielHuey · Feb 22, 2017 · 84802da · 84802da
1 parent 011afe3
commit 84802da
Show file tree

Hide file tree

Showing 272 changed files with 585 additions and 155 deletions.
diff --git a/deluge/__init__.py b/deluge/__init__.py
@@ -1,4 +1,6 @@
 """Deluge"""
+from __future__ import unicode_literals
+
 # this is a namespace package
 import pkg_resources
 

diff --git a/deluge/__rpcapi.py b/deluge/__rpcapi.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 from new import classobj
 
 from deluge.core.core import Core

diff --git a/deluge/_libtorrent.py b/deluge/_libtorrent.py
@@ -15,6 +15,7 @@
     >>> from deluge._libtorrent import lt
 
 """
+from __future__ import unicode_literals
 
 from deluge.common import VersionSplit, get_version
 

diff --git a/deluge/common.py b/deluge/common.py
@@ -8,7 +8,7 @@
 #
 
 """Common functions for various parts of Deluge to use."""
-from __future__ import division, print_function
+from __future__ import division, print_function, unicode_literals
 
 import base64
 import functools
@@ -800,7 +800,7 @@ def decode_string(s, encoding='utf8'):
 
     """
     if not s:
-        return u''
+        return ''
     elif isinstance(s, unicode):
         return s
 
@@ -817,7 +817,7 @@ def decode_string(s, encoding='utf8'):
             return s.decode(*l())
         except UnicodeDecodeError:
             pass
-    return u''
+    return ''
 
 
 def utf8_encoded(s, encoding='utf8'):
@@ -871,6 +871,7 @@ def __init__(self, ver):
             vs = ver.replace('_', '-').split('-')
 
         self.version = [int(x) for x in vs[0].split('.') if x.isdigit()]
+        self.version_string = ''.join(str(x) for x in vs[0].split('.') if x.isdigit())
         self.suffix = None
         self.dev = False
         if len(vs) > 1:

diff --git a/deluge/component.py b/deluge/component.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 import traceback
 from collections import defaultdict
@@ -305,7 +307,7 @@ def start(self, names=None):
         # Start all the components if names is empty
         if not names:
             names = self.components.keys()
-        elif isinstance(names, str):
+        elif isinstance(names, basestring):
             names = [names]
 
         def on_depends_started(result, name):
@@ -339,7 +341,7 @@ def stop(self, names=None):
         """
         if not names:
             names = self.components.keys()
-        elif isinstance(names, str):
+        elif isinstance(names, basestring):
             names = [names]
 
         def on_dependents_stopped(result, name):
@@ -377,7 +379,7 @@ def pause(self, names=None):
         """
         if not names:
             names = self.components.keys()
-        elif isinstance(names, str):
+        elif isinstance(names, basestring):
             names = [names]
 
         deferreds = []
@@ -403,7 +405,7 @@ def resume(self, names=None):
         """
         if not names:
             names = self.components.keys()
-        elif isinstance(names, str):
+        elif isinstance(names, basestring):
             names = [names]
 
         deferreds = []

diff --git a/deluge/config.py b/deluge/config.py
@@ -39,14 +39,15 @@
 version as this will be done internally.
 
 """
+from __future__ import unicode_literals
 
 import cPickle as pickle
 import json
 import logging
 import os
 import shutil
 
-from deluge.common import get_default_config_dir, utf8_encoded
+from deluge.common import decode_string, get_default_config_dir, utf8_encoded
 
 log = logging.getLogger(__name__)
 callLater = None  # Necessary for the config tests
@@ -243,11 +244,8 @@ def get_item(self, key):
             5
 
         """
-        if isinstance(self.__config[key], str):
-            try:
-                return self.__config[key].decode('utf8')
-            except UnicodeDecodeError:
-                return self.__config[key]
+        if isinstance(self.__config[key], basestring):
+            return decode_string(self.__config[key])
         else:
             return self.__config[key]
 

diff --git a/deluge/configmanager.py b/deluge/configmanager.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 import os
 

diff --git a/deluge/core/alertmanager.py b/deluge/core/alertmanager.py
@@ -15,6 +15,7 @@
 `:mod:EventManager` for similar functionality.
 
 """
+from __future__ import unicode_literals
 
 import logging
 

diff --git a/deluge/core/authmanager.py b/deluge/core/authmanager.py
@@ -8,6 +8,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 import os
 import shutil

diff --git a/deluge/core/core.py b/deluge/core/core.py
@@ -8,7 +8,7 @@
 # See LICENSE for more details.
 #
 
-from __future__ import division
+from __future__ import division, unicode_literals
 
 import base64
 import glob

diff --git a/deluge/core/daemon.py b/deluge/core/daemon.py
@@ -8,6 +8,7 @@
 #
 
 """The Deluge daemon"""
+from __future__ import unicode_literals
 
 import logging
 import os

diff --git a/deluge/core/daemon_entry.py b/deluge/core/daemon_entry.py
@@ -7,7 +7,7 @@
 # the additional special exception to link portions of this program with the OpenSSL library.
 # See LICENSE for more details.
 #
-from __future__ import print_function
+from __future__ import print_function, unicode_literals
 
 import os
 import sys

diff --git a/deluge/core/eventmanager.py b/deluge/core/eventmanager.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 
 import deluge.component as component

diff --git a/deluge/core/filtermanager.py b/deluge/core/filtermanager.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 
 import deluge.component as component

diff --git a/deluge/core/pluginmanager.py b/deluge/core/pluginmanager.py
@@ -9,6 +9,7 @@
 
 
 """PluginManager for Core"""
+from __future__ import unicode_literals
 
 import logging
 

diff --git a/deluge/core/preferencesmanager.py b/deluge/core/preferencesmanager.py
@@ -8,6 +8,8 @@
 #
 
 
+from __future__ import unicode_literals
+
 import logging
 import os
 import random

diff --git a/deluge/core/rpcserver.py b/deluge/core/rpcserver.py
@@ -8,6 +8,7 @@
 #
 
 """RPCServer Module"""
+from __future__ import unicode_literals
 
 import logging
 import os

diff --git a/deluge/core/torrent.py b/deluge/core/torrent.py
@@ -14,7 +14,7 @@
 
 """
 
-from __future__ import division
+from __future__ import division, unicode_literals
 
 import logging
 import os

diff --git a/deluge/core/torrentmanager.py b/deluge/core/torrentmanager.py
@@ -8,6 +8,7 @@
 #
 
 """TorrentManager handles Torrent objects"""
+from __future__ import unicode_literals
 
 import cPickle
 import datetime

diff --git a/deluge/decorators.py b/deluge/decorators.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import inspect
 import re
 import warnings

diff --git a/deluge/error.py b/deluge/error.py
@@ -9,6 +9,9 @@
 #
 
 
+from __future__ import unicode_literals
+
+
 class DelugeError(Exception):
 
     def __new__(cls, *args, **kwargs):

diff --git a/deluge/event.py b/deluge/event.py
@@ -14,6 +14,7 @@
 and subsequently emitted to the clients.
 
 """
+from __future__ import unicode_literals
 
 known_events = {}
 

diff --git a/deluge/httpdownloader.py b/deluge/httpdownloader.py
@@ -7,6 +7,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 import os.path
 import zlib

diff --git a/deluge/log.py b/deluge/log.py
@@ -9,6 +9,7 @@
 #
 
 """Logging functions"""
+from __future__ import unicode_literals
 
 import inspect
 import logging

diff --git a/deluge/maketorrent.py b/deluge/maketorrent.py
@@ -7,7 +7,7 @@
 # See LICENSE for more details.
 #
 
-from __future__ import division
+from __future__ import division, unicode_literals
 
 import os
 import sys

diff --git a/deluge/metafile.py b/deluge/metafile.py
@@ -11,7 +11,7 @@
 # See LICENSE for more details.
 #
 
-from __future__ import division
+from __future__ import division, unicode_literals
 
 import logging
 import os.path

diff --git a/deluge/path_chooser_common.py b/deluge/path_chooser_common.py
@@ -8,6 +8,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import os
 
 

diff --git a/deluge/pluginmanagerbase.py b/deluge/pluginmanagerbase.py
@@ -9,6 +9,7 @@
 
 
 """PluginManagerBase"""
+from __future__ import unicode_literals
 
 import logging
 import os.path

diff --git a/deluge/plugins/AutoAdd/deluge/__init__.py b/deluge/plugins/AutoAdd/deluge/__init__.py
@@ -1,3 +1,5 @@
+from __future__ import unicode_literals
+
 # this is a namespace package
 import pkg_resources
 

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/__init__.py b/deluge/plugins/AutoAdd/deluge/plugins/__init__.py
@@ -1,3 +1,5 @@
+from __future__ import unicode_literals
+
 # this is a namespace package
 import pkg_resources
 

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/autoadd/__init__.py b/deluge/plugins/AutoAdd/deluge/plugins/autoadd/__init__.py
@@ -12,6 +12,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 from deluge.plugins.init import PluginInitBase
 
 

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/autoadd/common.py b/deluge/plugins/AutoAdd/deluge/plugins/autoadd/common.py
@@ -12,6 +12,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import os
 
 import pkg_resources

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/autoadd/core.py b/deluge/plugins/AutoAdd/deluge/plugins/autoadd/core.py
@@ -13,6 +13,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import base64
 import logging
 import os

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/autoadd/gtkui.py b/deluge/plugins/AutoAdd/deluge/plugins/autoadd/gtkui.py
@@ -12,6 +12,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 import os
 

diff --git a/deluge/plugins/AutoAdd/deluge/plugins/autoadd/webui.py b/deluge/plugins/AutoAdd/deluge/plugins/autoadd/webui.py
@@ -12,6 +12,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 import logging
 
 from deluge.plugins.pluginbase import WebPluginBase

diff --git a/deluge/plugins/AutoAdd/setup.py b/deluge/plugins/AutoAdd/setup.py
@@ -13,6 +13,8 @@
 # See LICENSE for more details.
 #
 
+from __future__ import unicode_literals
+
 from setuptools import find_packages, setup
 
 __plugin_name__ = 'AutoAdd'

diff --git a/deluge/plugins/Blocklist/deluge/__init__.py b/deluge/plugins/Blocklist/deluge/__init__.py
@@ -1,2 +1,4 @@
+from __future__ import unicode_literals
+
 # this is a namespace package
 __import__('pkg_resources').declare_namespace(__name__)
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ @@
         >>> from deluge._libtorrent import lt
     """
+    from __future__ import unicode_literals
     from deluge.common import VersionSplit, get_version
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,6 +9,7 @@


		"""PluginManager for Core"""
		from __future__ import unicode_literals

		import logging

Expand Down