Implement get_source for importlib.abc.PyLoader using source_path and get_data.

diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 9784954e15b7535f97e7eb74d82b11f3bf20b187..c1874f6af5916b89504cb4bb88a30ddebeac0b95 100644 (file)
--- a/Doc/library/importlib.rst
+++ b/Doc/library/importlib.rst
@@ -226,6 +226,13 @@ are also provided to help in implementing the core ABCs.
         :meth:`importlib.abc.InspectLoader.get_code` that creates code objects
         from Python source code.
 
+    .. method:: get_source(fullname)
+
+        A concrete implementation of
+        :meth:`importlib.abc.InspectLoader.get_source`. Uses
+        :meth:`importlib.abc.InspectLoader.get_data` and :meth:`source_path` to
+        get the source code.
+
 
 .. class:: PyPycLoader
 

diff --git a/Lib/importlib/NOTES b/Lib/importlib/NOTES
index ed439ed09ae7e8a744e4299eb2fc96d47b610248..f7384197fc1a5ed7ef1db8e511a7f23ad10bfc8c 100644 (file)
--- a/Lib/importlib/NOTES
+++ b/Lib/importlib/NOTES
@@ -3,7 +3,6 @@ to do
 
 * Public API left to expose (w/ docs!)
 
-    + abc.PyLoader.get_source
     + util.set_loader
 
 * Implement InspectLoader for BuiltinImporter and FrozenImporter.

diff --git a/Lib/importlib/_bootstrap.py b/Lib/importlib/_bootstrap.py
index 58b5a46cf24c9d75209c0c5442b9c59d45dc7c7d..73f651384b1be2bb128bedffb49b1bf42870bc50 100644 (file)
--- a/Lib/importlib/_bootstrap.py
+++ b/Lib/importlib/_bootstrap.py
@@ -369,6 +369,26 @@ class PyLoader:
             source = source.replace(line_endings, b'\n')
         return compile(source, source_path, 'exec', dont_inherit=True)
 
+    # Never use in implementing import! Imports code within the method.
+    def get_source(self, fullname):
+        """Return the source code for a module.
+
+        self.source_path() and self.get_data() are used to implement this
+        method.
+
+        """
+        path = self.source_path(fullname)
+        if path is None:
+            return None
+        try:
+            source_bytes = self.get_data(path)
+        except IOError:
+            return ImportError("source not available through get_data()")
+        import io
+        import tokenize
+        encoding = tokenize.detect_encoding(io.BytesIO(source_bytes).readline)
+        return source_bytes.decode(encoding[0])
+
 
 class PyPycLoader(PyLoader):
 

diff --git a/Lib/importlib/test/source/test_abc_loader.py b/Lib/importlib/test/source/test_abc_loader.py
index c9377938de5f2da9046c1e20252b9364cfc0d800..0e7408d48de9776648a75115ce7e61492b07f780 100644 (file)
--- a/Lib/importlib/test/source/test_abc_loader.py
+++ b/Lib/importlib/test/source/test_abc_loader.py
@@ -14,8 +14,8 @@ import unittest
 class PyLoaderMock(abc.PyLoader):
 
     # Globals that should be defined for all modules.
-    source = ("_ = '::'.join([__name__, __file__, __package__, "
-              "repr(__loader__)])")
+    source = (b"_ = '::'.join([__name__, __file__, __package__, "
+              b"repr(__loader__)])")
 
     def __init__(self, data):
         """Take a dict of 'module_name: path' pairings.
@@ -30,7 +30,7 @@ class PyLoaderMock(abc.PyLoader):
     def get_data(self, path):
         if path not in self.path_to_module:
             raise IOError
-        return self.source.encode('utf-8')
+        return self.source
 
     def is_package(self, name):
         try:
@@ -38,9 +38,6 @@ class PyLoaderMock(abc.PyLoader):
         except KeyError:
             raise ImportError
 
-    def get_source(self, name):  # Should not be needed.
-        raise NotImplementedError
-
     def source_path(self, name):
         try:
             return self.module_paths[name]
@@ -181,7 +178,7 @@ class PyLoaderTests(testing_abc.LoaderTests):
         module = imp.new_module(name)
         module.blah = None
         mock = self.mocker({name: 'path/to/mod'})
-        mock.source = "1/0"
+        mock.source = b"1/0"
         with util.uncache(name):
             sys.modules[name] = module
             self.assertRaises(ZeroDivisionError, mock.load_module, name)
@@ -192,7 +189,7 @@ class PyLoaderTests(testing_abc.LoaderTests):
     def test_unloadable(self):
         name = "mod"
         mock = self.mocker({name: 'path/to/mod'})
-        mock.source = "1/0"
+        mock.source = b"1/0"
         with util.uncache(name):
             self.assertRaises(ZeroDivisionError, mock.load_module, name)
             self.assert_(name not in sys.modules)
@@ -201,6 +198,8 @@ class PyLoaderTests(testing_abc.LoaderTests):
 
 class PyLoaderInterfaceTests(unittest.TestCase):
 
+    """Tests for importlib.abc.PyLoader to make sure that when source_path()
+    doesn't return a path everything works as expected."""
 
     def test_no_source_path(self):
         # No source path should lead to ImportError.
@@ -216,6 +215,30 @@ class PyLoaderInterfaceTests(unittest.TestCase):
             self.assertRaises(ImportError, mock.load_module, name)
 
 
+class PyLoaderGetSourceTests(unittest.TestCase):
+
+    """Tests for importlib.abc.PyLoader.get_source()."""
+
+    def test_default_encoding(self):
+        # Should have no problems with UTF-8 text.
+        name = 'mod'
+        mock = PyLoaderMock({name: 'path/to/mod'})
+        source = 'x = "ü"'
+        mock.source = source.encode('utf-8')
+        returned_source = mock.get_source(name)
+        self.assertEqual(returned_source, source)
+
+    def test_decoded_source(self):
+        # Decoding should work.
+        name = 'mod'
+        mock = PyLoaderMock({name: 'path/to/mod'})
+        source = "# coding: Latin-1\nx='ü'"
+        assert source.encode('latin-1') != source.encode('utf-8')
+        mock.source = source.encode('latin-1')
+        returned_source = mock.get_source(name)
+        self.assertEqual(returned_source, source)
+
+
 class PyPycLoaderTests(PyLoaderTests):
 
     """Tests for importlib.abc.PyPycLoader."""
@@ -380,7 +403,7 @@ class MissingPathsTests(unittest.TestCase):
 
 def test_main():
     from test.support import run_unittest
-    run_unittest(PyLoaderTests, PyLoaderInterfaceTests,
+    run_unittest(PyLoaderTests, PyLoaderInterfaceTests, PyLoaderGetSourceTests,
                     PyPycLoaderTests, SkipWritingBytecodeTests,
                     RegeneratedBytecodeTests, BadBytecodeFailureTests,
                     MissingPathsTests)