[Python-checkins] r59082 - in python/trunk: Lib/doctest.py Lib/test/test_doctest.py Misc/NEWS

[brett.cannon]

Author: brett.cannon
Date: Wed Nov 21 01:47:36 2007
New Revision: 59082

Modified:
   python/trunk/Lib/doctest.py
   python/trunk/Lib/test/test_doctest.py
   python/trunk/Misc/NEWS
Log:
doctest assumed that a package's __loader__.get_data() method used universal
newlines; it doesn't.  To rectify this the string returned replaces all
instances of os.linesep with '\n' to fake universal newline support.

Backport candidate.


Modified: python/trunk/Lib/doctest.py
==============================================================================
--- python/trunk/Lib/doctest.py	(original)
+++ python/trunk/Lib/doctest.py	Wed Nov 21 01:47:36 2007
@@ -209,7 +209,10 @@
         filename = _module_relative_path(package, filename)
         if hasattr(package, '__loader__'):
             if hasattr(package.__loader__, 'get_data'):
-                return package.__loader__.get_data(filename), filename
+                file_contents = package.__loader__.get_data(filename)
+                # get_data() opens files as 'rb', so one must do the equivalent
+                # conversion as universal newlines would do.
+                return file_contents.replace(os.linesep, '\n'), filename
     return open(filename).read(), filename
 
 def _indent(s, indent=4):

Modified: python/trunk/Lib/test/test_doctest.py
==============================================================================
--- python/trunk/Lib/test/test_doctest.py	(original)
+++ python/trunk/Lib/test/test_doctest.py	Wed Nov 21 01:47:36 2007
@@ -1908,6 +1908,23 @@
          >>> suite.run(unittest.TestResult())
          <unittest.TestResult run=3 errors=0 failures=3>
 
+       Support for using a package's __loader__.get_data() is also
+       provided.
+
+         >>> import unittest, pkgutil, test
+         >>> if not hasattr(test, '__loader__'):
+         ...     test.__loader__ = pkgutil.get_loader(test)
+         ...     added_loader = True
+         >>> try:
+         ...     suite = doctest.DocFileSuite('test_doctest.txt',
+         ...                                  'test_doctest2.txt',
+         ...                                  'test_doctest4.txt',
+         ...                                  package='test')
+         ...     suite.run(unittest.TestResult())
+         ... finally:
+         ...     del test.__loader__
+         <unittest.TestResult run=3 errors=0 failures=3>
+
        '/' should be used as a path separator.  It will be converted
        to a native separator at run time:
 

Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Wed Nov 21 01:47:36 2007
@@ -284,6 +284,9 @@
 Library
 -------
 
+- doctest made a bad assumption that a package's __loader__.get_data()
+  method used universal newlines.
+
 - Issue #1705170: contextlib.contextmanager was still swallowing
   StopIteration in some cases. This should no longer happen.