[Python-checkins] r70291 - in python/branches/py3k: Doc/library/importlib.rst Lib/importlib/NOTES Lib/importlib/_bootstrap.py Lib/importlib/test/source/test_abc_loader.py

Tue Mar 10 04:29:24 CET 2009

Author: brett.cannon
Date: Tue Mar 10 04:29:23 2009
New Revision: 70291
Log:
Implement get_source for importlib.abc.PyLoader using source_path and get_data.
Modified:
 python/branches/py3k/Doc/library/importlib.rst
 python/branches/py3k/Lib/importlib/NOTES
 python/branches/py3k/Lib/importlib/_bootstrap.py
 python/branches/py3k/Lib/importlib/test/source/test_abc_loader.py
Modified: python/branches/py3k/Doc/library/importlib.rst
==============================================================================

--- python/branches/py3k/Doc/library/importlib.rst	(original)
+++ python/branches/py3k/Doc/library/importlib.rst	Tue Mar 10 04:29:23 2009
@@ -226,6 +226,13 @@
 :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
 
Modified: python/branches/py3k/Lib/importlib/NOTES
==============================================================================
--- python/branches/py3k/Lib/importlib/NOTES	(original)
+++ python/branches/py3k/Lib/importlib/NOTES	Tue Mar 10 04:29:23 2009
@@ -3,7 +3,6 @@
 
 * Public API left to expose (w/ docs!)
 
- + abc.PyLoader.get_source
 + util.set_loader
 
 * Implement InspectLoader for BuiltinImporter and FrozenImporter.
Modified: python/branches/py3k/Lib/importlib/_bootstrap.py
==============================================================================
--- python/branches/py3k/Lib/importlib/_bootstrap.py	(original)
+++ python/branches/py3k/Lib/importlib/_bootstrap.py	Tue Mar 10 04:29:23 2009
@@ -369,6 +369,26 @@
 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):
 
Modified: python/branches/py3k/Lib/importlib/test/source/test_abc_loader.py
==============================================================================
--- python/branches/py3k/Lib/importlib/test/source/test_abc_loader.py	(original)
+++ python/branches/py3k/Lib/importlib/test/source/test_abc_loader.py	Tue Mar 10 04:29:23 2009
@@ -14,8 +14,8 @@
 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 @@
 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 @@
 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 @@
 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 @@
 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 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 @@
 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 @@
 
 def test_main():
 from test.support import run_unittest
- run_unittest(PyLoaderTests, PyLoaderInterfaceTests,
+ run_unittest(PyLoaderTests, PyLoaderInterfaceTests, PyLoaderGetSourceTests,
 PyPycLoaderTests, SkipWritingBytecodeTests,
 RegeneratedBytecodeTests, BadBytecodeFailureTests,
 MissingPathsTests)
