From a13d96a1beea1ced19b53884f05909cdd2eced33 2012-11-24 19:18:06
From: Greg Caporaso <gregcaporaso@gmail.com>
Date: 2012-11-24 19:18:06
Subject: [PATCH] updating to make interface more intuitive now that we're not using os.path.walk

---

diff --git a/IPython/lib/display.py b/IPython/lib/display.py
index dd21edb..e6d10f9 100644
--- a/IPython/lib/display.py
+++ b/IPython/lib/display.py
@@ -173,7 +173,8 @@ class FileLinks(FileLink):
                                dirname_output_format,
                                fname_output_format,
                                fp_format):
-        """ generate func to pass to os.path.walk
+        """ generate function to format output- the resulting function will 
+             take a list to be populated with the output lines to print, 
         
            dirname_output_format: string to use for formatting directory 
             names, dirname will be substituted for a single "%s" which
@@ -190,8 +191,8 @@ class FileLinks(FileLink):
         
         included_suffixes = self.included_suffixes
 
-        def f(output_lines, dirname, fnames):
-            """ func to be passed to os.path.walk """
+        def f(dirname, fnames):
+            result = []
             # begin by figuring out which filenames, if any, 
             # are going to be displayed
             display_fnames = []
@@ -209,7 +210,7 @@ class FileLinks(FileLink):
                 # otherwise print the formatted directory name followed by 
                 # the formatted filenames
                 dirname_output_line = dirname_output_format % dirname
-                output_lines.append(dirname_output_line)
+                result.append(dirname_output_line)
                 for fname in display_fnames:
                     fp = fp_format % (dirname,fname)
                     try:
@@ -218,8 +219,8 @@ class FileLinks(FileLink):
                     except TypeError:
                         # ... or just a single filepath
                         fname_output_line = fname_output_format % fname
-                    output_lines.append(fname_output_line)
-            return
+                    result.append(fname_output_line)
+            return result
         return f
 
     def _get_notebook_display_formatter(self,
@@ -253,7 +254,7 @@ class FileLinks(FileLink):
         walked_dir = list(walk(self.path))
         walked_dir.sort()
         for dirname, subdirs, fnames in walked_dir:
-            self.notebook_display_formatter(result_lines,dirname, fnames)
+            result_lines += self.notebook_display_formatter(dirname, fnames)
         return '\n'.join(result_lines)
     
     def __repr__(self):
@@ -263,5 +264,5 @@ class FileLinks(FileLink):
         walked_dir = list(walk(self.path))
         walked_dir.sort()
         for dirname, subdirs, fnames in walked_dir:
-            self.terminal_display_formatter(result_lines, dirname, fnames)
+            result_lines += self.terminal_display_formatter(dirname, fnames)
         return '\n'.join(result_lines)
diff --git a/IPython/lib/tests/test_display.py b/IPython/lib/tests/test_display.py
index 8017679..5327c05 100644
--- a/IPython/lib/tests/test_display.py
+++ b/IPython/lib/tests/test_display.py
@@ -90,9 +90,8 @@ def test_existing_path_FileLinks_alt_formatter():
     td = mkdtemp()
     tf1 = NamedTemporaryFile(dir=td)
     tf2 = NamedTemporaryFile(dir=td)
-    def fake_formatter(output_lines,dirname,fnames):
-        output_lines.extend(["hello","world"])
-        return
+    def fake_formatter(dirname,fnames):
+        return ["hello","world"]
     fl = display.FileLinks(td,notebook_display_formatter=fake_formatter)
     actual = fl._repr_html_()
     actual = actual.split('\n')
@@ -122,9 +121,8 @@ def test_existing_path_FileLinks_repr_alt_formatter():
     td = mkdtemp()
     tf1 = NamedTemporaryFile(dir=td)
     tf2 = NamedTemporaryFile(dir=td)
-    def fake_formatter(output_lines,dirname,fnames):
-        output_lines.extend(["hello","world"])
-        return
+    def fake_formatter(dirname,fnames):
+        return ["hello","world"]
     fl = display.FileLinks(td,terminal_display_formatter=fake_formatter)
     actual = repr(fl)
     actual = actual.split('\n')