From 0194f5bc98d3fb3e7b4aaed874edf2df3a33bfd3 Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Sun, 8 Feb 2009 03:17:00 +0000 Subject: Issue #4512 closeout: Make ZipImport.get_filename() a public method --- Doc/library/zipimport.rst | 9 +++++++++ Lib/test/test_zipimport.py | 12 ++++++------ Misc/NEWS | 3 +++ Modules/zipimport.c | 6 +++--- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst index 0a6ece0..d659efe 100644 --- a/Doc/library/zipimport.rst +++ b/Doc/library/zipimport.rst @@ -94,6 +94,15 @@ zipimporter Objects file wasn't found. + .. method:: get_filename(fullname) + + Return the value ``__file__`` would be set to if the specified module + was imported. Raise :exc:`ZipImportError` if the module couldn't be + found. + + .. versionadded:: 2.7 + + .. method:: get_source(fullname) Return the source code for the specified module. Raise diff --git a/Lib/test/test_zipimport.py b/Lib/test/test_zipimport.py index 87869ae..1543b3b 100644 --- a/Lib/test/test_zipimport.py +++ b/Lib/test/test_zipimport.py @@ -215,7 +215,7 @@ class UncompressedZipImportTestCase(ImportHooksBaseTestCase): self.assertEquals(zi.archive, TEMP_ZIP) self.assertEquals(zi.is_package(TESTPACK), True) mod = zi.load_module(TESTPACK) - self.assertEquals(zi._get_filename(TESTPACK), mod.__file__) + self.assertEquals(zi.get_filename(TESTPACK), mod.__file__) self.assertEquals(zi.is_package(packdir + '__init__'), False) self.assertEquals(zi.is_package(packdir + TESTPACK2), True) @@ -227,11 +227,11 @@ class UncompressedZipImportTestCase(ImportHooksBaseTestCase): mod = sys.modules[mod_name] self.assertEquals(zi.get_source(TESTPACK), None) self.assertEquals(zi.get_source(mod_path), None) - self.assertEquals(zi._get_filename(mod_path), mod.__file__) + self.assertEquals(zi.get_filename(mod_path), mod.__file__) # To pass in the module name instead of the path, we must use the right importer loader = mod.__loader__ self.assertEquals(loader.get_source(mod_name), None) - self.assertEquals(loader._get_filename(mod_name), mod.__file__) + self.assertEquals(loader.get_filename(mod_name), mod.__file__) # test prefix and archivepath members zi2 = zipimport.zipimporter(TEMP_ZIP + os.sep + TESTPACK) @@ -260,7 +260,7 @@ class UncompressedZipImportTestCase(ImportHooksBaseTestCase): self.assertEquals(zi.prefix, packdir) self.assertEquals(zi.is_package(TESTPACK2), True) mod = zi.load_module(TESTPACK2) - self.assertEquals(zi._get_filename(TESTPACK2), mod.__file__) + self.assertEquals(zi.get_filename(TESTPACK2), mod.__file__) self.assertEquals(zi.is_package(TESTPACK2 + os.sep + '__init__'), False) self.assertEquals(zi.is_package(TESTPACK2 + os.sep + TESTMOD), False) @@ -271,11 +271,11 @@ class UncompressedZipImportTestCase(ImportHooksBaseTestCase): mod = sys.modules[mod_name] self.assertEquals(zi.get_source(TESTPACK2), None) self.assertEquals(zi.get_source(mod_path), None) - self.assertEquals(zi._get_filename(mod_path), mod.__file__) + self.assertEquals(zi.get_filename(mod_path), mod.__file__) # To pass in the module name instead of the path, we must use the right importer loader = mod.__loader__ self.assertEquals(loader.get_source(mod_name), None) - self.assertEquals(loader._get_filename(mod_name), mod.__file__) + self.assertEquals(loader.get_filename(mod_name), mod.__file__) finally: z.close() os.remove(TEMP_ZIP) diff --git a/Misc/NEWS b/Misc/NEWS index 2eed247..412f067 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -149,6 +149,9 @@ Core and Builtins Library ------- +- Issue #4512 (part 2): Promote ``ZipImporter._get_filename()`` to be a + public documented method ``ZipImporter.get_filename()``. + - Issue #4195: The ``runpy`` module (and the ``-m`` switch) now support the execution of packages by looking for and executing a ``__main__`` submodule when a package name is supplied. Initial patch by Andi diff --git a/Modules/zipimport.c b/Modules/zipimport.c index e320dd9..b05de24 100644 --- a/Modules/zipimport.c +++ b/Modules/zipimport.c @@ -378,7 +378,7 @@ zipimporter_get_filename(PyObject *obj, PyObject *args) char *fullname, *modpath; int ispackage; - if (!PyArg_ParseTuple(args, "s:zipimporter._get_filename", + if (!PyArg_ParseTuple(args, "s:zipimporter.get_filename", &fullname)) return NULL; @@ -553,7 +553,7 @@ contain the module, but has no source for it."); PyDoc_STRVAR(doc_get_filename, -"_get_filename(fullname) -> filename string.\n\ +"get_filename(fullname) -> filename string.\n\ \n\ Return the filename for the specified module."); @@ -568,7 +568,7 @@ static PyMethodDef zipimporter_methods[] = { doc_get_code}, {"get_source", zipimporter_get_source, METH_VARARGS, doc_get_source}, - {"_get_filename", zipimporter_get_filename, METH_VARARGS, + {"get_filename", zipimporter_get_filename, METH_VARARGS, doc_get_filename}, {"is_package", zipimporter_is_package, METH_VARARGS, doc_is_package}, -- cgit v0.12