[LNT] Python 3 support: adapt to zip returning an iterator

[thopre]

Summary

zip() returns a list in Python 2 but an iterator in Python 3.
Fortunately, the only use is in the return statement in pairs() and the
only call site of pairs() iterates over the result. This commit thus
adds a docstrings for pairs to make it clear callers can only rely on
the result being iterable. It also rename the parameter to not conflict
with the list builtin function.

[hubert.reinterpretcast]

lnt/server/reporting/analysis.py

375

The unpacking works without this change even in Python 3.

lnt/tests/nt.py

793

I believe this change is unnecessary. The constructor will fully visit the result of zip.

[thopre]

Cancelling this patch since all users of zip are fine with iterable (pairs is only used in dailyreport.py in a foreach statement).

[thopre]

Add comments to pairs() stating it returns an iterable.

[hubert.reinterpretcast]

LGTM with suggestion to update commit message.

lnt/server/reporting/report.py

11–12

I agree that a rename would help. Please update the commit message with the rationale.

lnt/server/reporting/analysis.py

def get_comparison_result(self, runs, compare_runs, test_id, field,
                              bigger_is_better=field.bigger_is_better)
         return r
 
     def get_geomean_comparison_result(self, run, compare_to, field, tests):
         unchanged_tests = [(cr.previous, cr.current, cr.prev_hash, cr.cur_hash)
                            for _, _, cr in tests
                            if cr.get_test_status() == UNCHANGED_PASS]
         if unchanged_tests:
-            prev_values, run_values, prev_hash, cur_hash = zip(
-                *unchanged_tests)
+            prev_values, run_values, prev_hash, cur_hash = list(zip(
+                *unchanged_tests))
             prev_values = [x for x in prev_values if x is not None]
             run_values = [x for x in run_values if x is not None]
             prev_hash = [x for x in prev_hash if x is not None]
             cur_hash = [x for x in cur_hash if x is not None]
             prev_hash = prev_hash[0] if len(prev_hash) > 0 else None
             cur_hash = cur_hash[0] if len(cur_hash) > 0 else None
             prev_geo = calc_geomean(prev_values)
             prev_values = [prev_geo] if prev_geo else []

lnt/server/reporting/report.py

 """
 Common functions and classes that are used by reports.
 """
 
 import colorsys
 
 from collections import namedtuple
 
 OrderAndHistory = namedtuple('OrderAndHistory', ['max_order', 'recent_orders'])
 
-def pairs(list):
-    return zip(list[:-1], list[1:])
+def pairs(l):
+    return list(zip(l[:-1], l[1:]))
 
 # The hash color palette avoids green and red as these colours are already used
 # in quite a few places to indicate "good" or "bad".
 _hash_color_palette = (
     colorsys.hsv_to_rgb(h=45. / 360, s=0.3, v=0.9999),  # warm yellow
     colorsys.hsv_to_rgb(h=210. / 360, s=0.3, v=0.9999),  # blue cyan
     colorsys.hsv_to_rgb(h=300. / 360, s=0.3, v=0.9999),  # mid magenta
     colorsys.hsv_to_rgb(h=150. / 360, s=0.3, v=0.9999),  # green cyan

lnt/tests/nt.py

for item in sample_keys:
         if required and header_name not in header:
             fatal('missing key %r in report header' % header_name)
 
     # We don't use the test info, currently.
     test_info = {}
     test_samples = []
     no_errors = True
     for row in reader_it:
-        record = dict(zip(header, row))
+        record = dict(list(zip(header, row)))
 
         program = record['Program']
 
         if config.only_test is not None:
             program = os.path.join(config.only_test, program)
         if config.rerun_test is not None:
             program = os.path.join(config.rerun_test, program)