Merge lp:~gocept/landscape-client/py3-cleanup into lp:~landscape/landscape-client/trunk

[Steffen Allner]

Cleanups related to landscape.compat (and lint).

This MP cleans up small residues from the port to Python 2/3 compatibility. It removes the unwanted coerce_unicode() helper method, which was replaced by individual solutions at the respective place of use. Furthermore unused imports have been removed and the usage (c)StringIO has been investigated, whether it could be replaced by a common io.{String,Bytes}IO() call in Python 2 and 3. This was often not the case, as this was also connected with the logging setup in the tests, which should not be addressed here.

This MP cleans up small residues from the port to Python 2/3 compatibility. It emoves the unwanted coerce_unicode() helper method, which was replaced by individual solutions at the respective place of use. Furthermore unused imports have been removed and the usage (c)StringIO has been investigated, whether it could be replaced by a common io.{String,Bytes}IO() call in Python 2 and 3. This was often not the case, as this was also connected with the logging setup in the tests, which should not be addressed here.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[Daniel Havlik (nilo)]

+1

review: Approve

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-check
Result: Success
Revno: 1000
Branch: lp:~gocept/landscape-client/py3-cleanup
Jenkins: https://ci.lscape.net/job/latch-test-xenial/3837/

review: Approve (test results)

[Eric Snow (ericsnowcurrently)]

LGTM

Thanks for the lint cleanups too. :)

review: Approve

=== modified file 'landscape/compat.py'
--- landscape/compat.py	2017-03-27 13:05:52 +0000
+++ landscape/compat.py	2017-04-05 11:33:19 +0000
@@ -22,29 +22,3 @@
     stringio = StringIO
     from cStringIO import StringIO as cstringio
     input = raw_input
-
-
-def coerce_unicode(s, encoding='ascii', errors='strict'):
-    """
-    Coerce byte strings into unicode for Python 2.
-
-    In Python 2, decodes a byte string L{s} into unicode using the L{encoding},
-    returns unmodified if any other type. In Python 3, raises a L{TypeError}
-    when passed a byte string in L{s}, returns unmodified otherwise.
-
-    @param s: The string to be converted to unicode.
-    @type s: L{bytes} or L{unicode}
-    @raise UnicodeError: The input L{bytes} is not decodable
-        with given encoding.
-    @raise TypeError: The input is L{bytes} on Python 3.
-    """
-    # In Python 2 C{unicode(b'bytes')} returns a unicode string C{'bytes'}. In
-    # Python 3, the equivalent C{str(b'bytes')} will return C{"b'bytes'"}
-    # instead.
-    if isinstance(s, bytes):
-        if _PY3:
-            raise TypeError("Expected str not %r (bytes)" % (s,))
-        else:
-            return s.decode(encoding, errors)
-    else:
-        return s

=== modified file 'landscape/lib/tests/test_fetch.py'
--- landscape/lib/tests/test_fetch.py	2017-03-08 14:01:11 +0000
+++ landscape/lib/tests/test_fetch.py	2017-04-05 11:33:19 +0000
@@ -4,7 +4,7 @@
 import pycurl
 
 from twisted.internet.defer import FirstError
-from twisted.python.compat import itervalues, unicode
+from twisted.python.compat import unicode
 
 from landscape.lib.fetch import (
     fetch, fetch_async, fetch_many_async, fetch_to_files,

=== modified file 'landscape/manager/customgraph.py'
--- landscape/manager/customgraph.py	2017-03-28 09:40:46 +0000
+++ landscape/manager/customgraph.py	2017-04-05 11:33:19 +0000
@@ -5,7 +5,6 @@
 from twisted.internet.defer import fail, DeferredList, succeed
 from twisted.python.compat import iteritems
 
-from landscape.compat import coerce_unicode
 from landscape.lib.scriptcontent import generate_script_hash
 from landscape.accumulate import Accumulator
 from landscape.manager.plugin import ManagerPlugin
@@ -189,7 +188,7 @@
         if graph_id not in self._data:
             return
         if failure.check(ProcessFailedError):
-            failure_value = coerce_unicode(failure.value.data, "utf-8")
+            failure_value = failure.value.data
             if failure.value.exit_code:
                 failure_value = ("%s (process exited with code %d)" %
                                  (failure_value, failure.value.exit_code))

=== modified file 'landscape/manager/tests/test_aptsources.py'
--- landscape/manager/tests/test_aptsources.py	2017-03-29 11:38:02 +0000
+++ landscape/manager/tests/test_aptsources.py	2017-04-05 11:33:19 +0000
@@ -3,7 +3,6 @@
 import mock
 
 from twisted.internet.defer import Deferred, succeed
-from twisted.python.compat import _PY3
 
 from landscape.manager.aptsources import AptSources
 from landscape.manager.plugin import SUCCEEDED, FAILED

=== modified file 'landscape/manager/tests/test_scriptexecution.py'
--- landscape/manager/tests/test_scriptexecution.py	2017-03-27 11:52:09 +0000
+++ landscape/manager/tests/test_scriptexecution.py	2017-04-05 11:33:19 +0000
@@ -6,12 +6,9 @@
 
 import mock
 
-from unittest import skipIf
-
 from twisted.internet.defer import gatherResults, succeed, fail
 from twisted.internet.error import ProcessDone
 from twisted.python.failure import Failure
-from twisted.python.compat import _PY3
 
 from landscape import VERSION
 from landscape.lib.fetch import HTTPCodeError

=== modified file 'landscape/package/facade.py'
--- landscape/package/facade.py	2017-03-21 18:03:57 +0000
+++ landscape/package/facade.py	2017-04-05 11:33:19 +0000
@@ -1,10 +1,10 @@
-import time
+import hashlib
 import logging
-import hashlib
 import os
 import subprocess
 import sys
 import tempfile
+import time
 
 from operator import attrgetter
 
@@ -636,6 +636,9 @@
         Commit cached APT operations and give feedback on the results as a
         string.
         """
+        # XXX we cannot use io.StringIO() here with Python 2 as there is a
+        # string literal written in apt.progress.text.TextProgress._write()
+        # which is not recognized as unicode by io.StringIO() with Python 2.
         fetch_output = StringIO()
         # Redirect stdout and stderr to a file. We need to work with the
         # file descriptors, rather than sys.stdout/stderr, since dpkg is

=== modified file 'landscape/tests/clock.py'
--- landscape/tests/clock.py	2017-01-10 13:07:51 +0000
+++ landscape/tests/clock.py	2017-04-05 11:33:19 +0000
@@ -30,9 +30,6 @@
  * L{twisted.internet.base.DelayedCall}, which didn't grow its
    C{seconds} argument until after Twisted 2.2.
 """
-
-import functools
-
 from twisted.internet import error
 from twisted.python.runtime import seconds as runtimeSeconds
 from twisted.python import reflect
@@ -63,7 +60,6 @@
         """
         return self.rightNow
 
-
     def callLater(self, when, what, *a, **kw):
         """
         See L{twisted.internet.interfaces.IReactorTime.callLater}.
@@ -77,7 +73,6 @@
         self.calls.sort(key=lambda a: a.getTime())
         return self.calls[-1]
 
-
     def advance(self, amount):
         """
         Move time on this clock forward by the given amount and run whatever
@@ -93,7 +88,6 @@
             call.called = 1
             call.func(*call.args, **call.kw)
 
-
     def pump(self, timings):
         """
         Advance incrementally by the given set of times.
@@ -104,7 +98,6 @@
             self.advance(amount)
 
 
-
 class DelayedCall:
 
     # enable .debug to record creator call stack, and it will be logged if

=== modified file 'landscape/tests/test_deployment.py'
--- landscape/tests/test_deployment.py	2017-03-13 15:38:09 +0000
+++ landscape/tests/test_deployment.py	2017-04-05 11:33:19 +0000
@@ -1,9 +1,9 @@
 from optparse import OptionParser
 from textwrap import dedent
+import io
 import mock
 import os
 
-from landscape.compat import StringIO
 from landscape.lib.fs import read_text_file, create_text_file
 
 from landscape.deployment import (
@@ -96,7 +96,7 @@
         L{get_config_filename}.
         """
         config_obj = self.config._get_config_object(
-            alternative_config=StringIO("[client]\nlog_level = error\n"))
+            alternative_config=io.StringIO(u"[client]\nlog_level = error\n"))
         self.assertEqual(None, config_obj.filename)
 
     def write_config_file(self, **kwargs):

=== modified file 'landscape/user/tests/test_provider.py'
--- landscape/user/tests/test_provider.py	2017-03-22 14:11:50 +0000
+++ landscape/user/tests/test_provider.py	2017-04-05 11:33:19 +0000
@@ -1,8 +1,6 @@
 import pwd
 import grp
 
-from twisted.python.compat import _PY3
-
 from landscape.user.provider import (
     UserProvider, UserNotFoundError, GroupNotFoundError)