Fix ordering of __future__, future, and builtins import lines

Author: edschofield

src/future/tests/base.py

@@ -28,10 +28,10 @@ def reformat_code(code):
 def order_future_lines(code):
     """
     Returns the code block with any ``__future__`` import lines sorted, and
-    then any ``future`` import lines sorted.
+    then any ``future`` import lines sorted, then any ``builtins`` import lines
+    sorted.
 
-    This only sorts the lines within the expected blocks:
-    __future__ first, then future imports, then regular code.
+    This only sorts the lines within the expected blocks.
 
     See test_order_future_lines() for an example.
     """
@@ -46,6 +46,9 @@ def order_future_lines(code):
     future_line_numbers = [i for i, line in enumerate(lines)
                              if line.startswith('from future')]
 
+    builtins_line_numbers = [i for i, line in enumerate(lines)
+                             if line.startswith('from builtins')]
+
     assert code.lstrip() == code, ('internal usage error: '
             'dedent the code before calling order_future_lines()')
 
@@ -58,12 +61,18 @@ def mymin(numbers):
     assert mymax(uufuture_line_numbers) <= mymin(future_line_numbers), \
             'the __future__ and future imports are out of order'
 
+    # assert mymax(future_line_numbers) <= mymin(builtins_line_numbers), \
+    #         'the future and builtins imports are out of order'
+
     uul = sorted([lines[i] for i in uufuture_line_numbers])
     sorted_uufuture_lines = dict(zip(uufuture_line_numbers, uul))
 
     fl = sorted([lines[i] for i in future_line_numbers])
     sorted_future_lines = dict(zip(future_line_numbers, fl))
 
+    bl = sorted([lines[i] for i in builtins_line_numbers])
+    sorted_builtins_lines = dict(zip(builtins_line_numbers, bl))
+
     # Replace the old unsorted "from __future__ import ..." lines with the
     # new sorted ones:
     new_lines = []
@@ -72,6 +81,8 @@ def mymin(numbers):
             new_lines.append(sorted_uufuture_lines[i])
         elif i in future_line_numbers:
             new_lines.append(sorted_future_lines[i])
+        elif i in builtins_line_numbers:
+            new_lines.append(sorted_builtins_lines[i])
         else:
             new_lines.append(lines[i])
     return '\n'.join(new_lines)

tests/test_future/test_futurize.py

@@ -980,18 +980,20 @@ def _fetch(url):
 
     def test_order_future_lines(self):
         """
-        Tests the internal order_future_lines() method.
+        Tests the internal order_future_lines() function.
         """
         before = '''
                # comment here
                from __future__ import print_function
                from __future__ import absolute_import
                                  # blank line or comment here
+               from future.utils import with_metaclass
                from builtins import zzz
                from builtins import aaa
                from builtins import blah
                # another comment
 
+               import something_else
                code_here
                more_code_here
                '''
@@ -1000,11 +1002,13 @@ def test_order_future_lines(self):
                from __future__ import absolute_import
                from __future__ import print_function
                                  # blank line or comment here
+               from future.utils import with_metaclass
                from builtins import aaa
                from builtins import blah
                from builtins import zzz
                # another comment
 
+               import something_else
                code_here
                more_code_here
                '''