Issue python#13959: Re-implement imp.get_suffixes() in Lib/imp.py.

brettcannon · brettcannon · commit 2657df47449d · 2012-05-04T15:20:40.000-04:00
This introduces a new function, imp.extension_suffixes(), which is currently undocumented. That is forthcoming once issue python#14657 is resolved and how to expose file suffixes is decided.
diff --git a/Lib/imp.py b/Lib/imp.py
@@ -9,11 +9,9 @@
 from _imp import (lock_held, acquire_lock, release_lock,
                   load_dynamic, get_frozen_object, is_frozen_package,
                   init_builtin, init_frozen, is_builtin, is_frozen,
-                  _fix_co_filename)
+                  _fix_co_filename, extension_suffixes)
 # Could move out of _imp, but not worth the code
 from _imp import get_magic, get_tag
-# Can (probably) move to importlib
-from _imp import get_suffixes
 
 from importlib._bootstrap import new_module
 from importlib._bootstrap import cache_from_source
@@ -38,6 +36,14 @@
 IMP_HOOK = 9
 
 
+def get_suffixes():
+    extensions = [(s, 'rb', C_EXTENSION) for s in extension_suffixes()]
+    source = [(s, 'U', PY_SOURCE) for s in _bootstrap._SOURCE_SUFFIXES]
+    bytecode = [(_bootstrap._BYTECODE_SUFFIX, 'rb', PY_COMPILED)]
+
+    return extensions + source + bytecode
+
+
 def source_from_cache(path):
     """Given the path to a .pyc./.pyo file, return the path to its .py file.
 
@@ -120,8 +126,8 @@ def load_compiled(name, pathname, file=None):
 # XXX deprecate
 def load_package(name, path):
     if os.path.isdir(path):
-        extensions = _bootstrap._suffix_list(PY_SOURCE)
-        extensions += _bootstrap._suffix_list(PY_COMPILED)
+        extensions = _bootstrap._SOURCE_SUFFIXES
+        extensions += [_bootstrap._BYTECODE_SUFFIX]
         for extension in extensions:
             path = os.path.join(path, '__init__'+extension)
             if os.path.exists(path):
diff --git a/Lib/importlib/_bootstrap.py b/Lib/importlib/_bootstrap.py
@@ -95,16 +95,6 @@ def _path_split(path):
     return front, tail
 
 
-def _path_exists(path):
-    """Replacement for os.path.exists."""
-    try:
-        _os.stat(path)
-    except OSError:
-        return False
-    else:
-        return True
-
-
 def _path_is_mode_type(path, mode):
     """Test whether the path is the specified mode type."""
     try:
@@ -128,28 +118,6 @@ def _path_isdir(path):
     return _path_is_mode_type(path, 0o040000)
 
 
-def _path_without_ext(path, ext_type):
-    """Replacement for os.path.splitext()[0]."""
-    for suffix in _suffix_list(ext_type):
-        if path.endswith(suffix):
-            return path[:-len(suffix)]
-    else:
-        raise ValueError("path is not of the specified type")
-
-
-def _path_absolute(path):
-    """Replacement for os.path.abspath."""
-    if not path:
-        path = _os.getcwd()
-    try:
-        return _os._getfullpathname(path)
-    except AttributeError:
-        if path.startswith('/'):
-            return path
-        else:
-            return _path_join(_os.getcwd(), path)
-
-
 def _write_atomic(path, data):
     """Best-effort function to write data to a path atomically.
     Be prepared to handle a FileExistsError if concurrent writing of the
@@ -338,12 +306,6 @@ def _requires_frozen_wrapper(self, fullname):
     return _requires_frozen_wrapper
 
 
-def _suffix_list(suffix_type):
-    """Return a list of file suffixes based on the imp file type."""
-    return [suffix[0] for suffix in _imp.get_suffixes()
-            if suffix[2] == suffix_type]
-
-
 # Loaders #####################################################################
 
 class BuiltinImporter:
@@ -1196,8 +1158,9 @@ def _install(sys_module, _imp_module):
 
     """
     _setup(sys_module, _imp_module)
-    supported_loaders = [(ExtensionFileLoader, _suffix_list(3), False),
-                         (SourceFileLoader, _suffix_list(1), True),
-                         (SourcelessFileLoader, _suffix_list(2), True)]
+    extensions = ExtensionFileLoader, _imp_module.extension_suffixes(), False
+    source = SourceFileLoader, _SOURCE_SUFFIXES, True
+    bytecode = SourcelessFileLoader, [_BYTECODE_SUFFIX], True
+    supported_loaders = [extensions, source, bytecode]
     sys.path_hooks.extend([FileFinder.path_hook(*supported_loaders)])
     sys.meta_path.extend([BuiltinImporter, FrozenImporter, PathFinder])
diff --git a/Lib/importlib/test/extension/test_case_sensitivity.py b/Lib/importlib/test/extension/test_case_sensitivity.py
@@ -16,7 +16,7 @@ def find_module(self):
         assert good_name != bad_name
         finder = _bootstrap.FileFinder(ext_util.PATH,
                                         (_bootstrap.ExtensionFileLoader,
-                                            _bootstrap._suffix_list(imp.C_EXTENSION),
+                                            imp.extension_suffixes(),
                                             False))
         return finder.find_module(bad_name)
 
diff --git a/Lib/importlib/test/extension/test_finder.py b/Lib/importlib/test/extension/test_finder.py
@@ -12,7 +12,7 @@ class FinderTests(abc.FinderTests):
     def find_module(self, fullname):
         importer = _bootstrap.FileFinder(util.PATH,
                                           (_bootstrap.ExtensionFileLoader,
-                                              _bootstrap._suffix_list(imp.C_EXTENSION),
+                                              imp.extension_suffixes(),
                                               False))
         return importer.find_module(fullname)
 
diff --git a/Lib/importlib/test/extension/test_path_hook.py b/Lib/importlib/test/extension/test_path_hook.py
@@ -15,7 +15,7 @@ class PathHookTests(unittest.TestCase):
 
     def hook(self, entry):
         return _bootstrap.FileFinder.path_hook((_bootstrap.ExtensionFileLoader,
-            _bootstrap._suffix_list(imp.C_EXTENSION), False))(entry)
+            imp.extension_suffixes(), False))(entry)
 
     def test_success(self):
         # Path hook should handle a directory where a known extension module
diff --git a/Lib/importlib/test/source/test_case_sensitivity.py b/Lib/importlib/test/source/test_case_sensitivity.py
@@ -22,10 +22,10 @@ class CaseSensitivityTest(unittest.TestCase):
     def find(self, path):
         finder = _bootstrap.FileFinder(path,
                                         (_bootstrap.SourceFileLoader,
-                                            _bootstrap._suffix_list(imp.PY_SOURCE),
+                                            _bootstrap._SOURCE_SUFFIXES,
                                             True),
                                         (_bootstrap.SourcelessFileLoader,
-                                            _bootstrap._suffix_list(imp.PY_COMPILED),
+                                            [_bootstrap._BYTECODE_SUFFIX],
                                             True))
         return finder.find_module(self.name)
 
diff --git a/Lib/importlib/test/source/test_finder.py b/Lib/importlib/test/source/test_finder.py
@@ -37,9 +37,9 @@ class FinderTests(abc.FinderTests):
 
     def import_(self, root, module):
         loader_details = [(_bootstrap.SourceFileLoader,
-                            _bootstrap._suffix_list(imp.PY_SOURCE), True),
+                            _bootstrap._SOURCE_SUFFIXES, True),
                           (_bootstrap.SourcelessFileLoader,
-                            _bootstrap._suffix_list(imp.PY_COMPILED), True)]
+                            [_bootstrap._BYTECODE_SUFFIX], True)]
         finder = _bootstrap.FileFinder(root, *loader_details)
         return finder.find_module(module)
 
@@ -139,7 +139,7 @@ def test_empty_dir(self):
     def test_empty_string_for_dir(self):
         # The empty string from sys.path means to search in the cwd.
         finder = _bootstrap.FileFinder('', (_bootstrap.SourceFileLoader,
-            _bootstrap._suffix_list(imp.PY_SOURCE), True))
+            _bootstrap._SOURCE_SUFFIXES, True))
         with open('mod.py', 'w') as file:
             file.write("# test file for importlib")
         try:
@@ -151,7 +151,7 @@ def test_empty_string_for_dir(self):
     def test_invalidate_caches(self):
         # invalidate_caches() should reset the mtime.
         finder = _bootstrap.FileFinder('', (_bootstrap.SourceFileLoader,
-            _bootstrap._suffix_list(imp.PY_SOURCE), True))
+            _bootstrap._SOURCE_SUFFIXES, True))
         finder._path_mtime = 42
         finder.invalidate_caches()
         self.assertEqual(finder._path_mtime, -1)
diff --git a/Lib/importlib/test/source/test_path_hook.py b/Lib/importlib/test/source/test_path_hook.py
@@ -11,7 +11,7 @@ class PathHookTest(unittest.TestCase):
 
     def path_hook(self):
         return _bootstrap.FileFinder.path_hook((_bootstrap.SourceFileLoader,
-            _bootstrap._suffix_list(imp.PY_SOURCE), True))
+            _bootstrap._SOURCE_SUFFIXES, True))
 
     def test_success(self):
         with source_util.create_modules('dummy') as mapping:
diff --git a/Python/dynload_aix.c b/Python/dynload_aix.c
@@ -26,10 +26,7 @@ typedef struct Module {
     void          *entry;
 } Module, *ModulePtr;
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-    {".so", "rb", C_EXTENSION},
-    {0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {".so", NULL};
 
 static int
 aix_getoldmodules(void **modlistptr)
diff --git a/Python/dynload_dl.c b/Python/dynload_dl.c
@@ -9,10 +9,7 @@
 
 extern char *Py_GetProgramName(void);
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-    {".o", "rb", C_EXTENSION},
-    {0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {".o", NULL};
 
 
 dl_funcptr _PyImport_GetDynLoadFunc(const char *shortname,
diff --git a/Python/dynload_hpux.c b/Python/dynload_hpux.c
@@ -13,10 +13,7 @@
 #define FUNCNAME_PATTERN "PyInit_%.200s"
 #endif
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-    {SHLIB_EXT, "rb", C_EXTENSION},
-    {0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {SHLIB_EXT, NULL};
 
 dl_funcptr _PyImport_GetDynLoadFunc(const char *shortname,
                                     const char *pathname, FILE *fp)
diff --git a/Python/dynload_next.c b/Python/dynload_next.c
@@ -8,10 +8,7 @@
 
 #include <mach-o/dyld.h>
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-    {".so", "rb", C_EXTENSION},
-    {0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {".so", NULL};
 
 /*
 ** Python modules are Mach-O MH_BUNDLE files. The best way to load these
diff --git a/Python/dynload_os2.c b/Python/dynload_os2.c
@@ -9,11 +9,7 @@
 #include "importdl.h"
 
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-    {".pyd", "rb", C_EXTENSION},
-    {".dll", "rb", C_EXTENSION},
-    {0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {".pyd", ".dll", NULL};
 
 dl_funcptr _PyImport_GetDynLoadFunc(const char *shortname,
                                     const char *pathname, FILE *fp)
diff --git a/Python/dynload_shlib.c b/Python/dynload_shlib.c
@@ -36,25 +36,25 @@
    live in the same directory.  E.g. foomodule.cpython-32.so
 */
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
+const char *_PyImport_DynLoadFiletab[] = {
 #ifdef __CYGWIN__
-    {".dll", "rb", C_EXTENSION},
+    ".dll",
 #else  /* !__CYGWIN__ */
 #if defined(PYOS_OS2) && defined(PYCC_GCC)
-    {".pyd", "rb", C_EXTENSION},
-    {".dll", "rb", C_EXTENSION},
+    ".pyd",
+    ".dll",
 #else  /* !(defined(PYOS_OS2) && defined(PYCC_GCC)) */
 #ifdef __VMS
-    {".exe", "rb", C_EXTENSION},
-    {".EXE", "rb", C_EXTENSION},
+    ".exe",
+    ".EXE",
 #else  /* !__VMS */
-    {"." SOABI ".so", "rb", C_EXTENSION},
-    {".abi" PYTHON_ABI_STRING ".so", "rb", C_EXTENSION},
-    {".so", "rb", C_EXTENSION},
+    "." SOABI ".so",
+    ".abi" PYTHON_ABI_STRING ".so",
+    ".so",
 #endif  /* __VMS */
 #endif  /* defined(PYOS_OS2) && defined(PYCC_GCC) */
 #endif  /* __CYGWIN__ */
-    {0, 0}
+    NULL,
 };
 
 static struct {
diff --git a/Python/dynload_stub.c b/Python/dynload_stub.c
@@ -6,6 +6,4 @@
 #include "importdl.h"
 
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
-	{0, 0}
-};
+const char *_PyImport_DynLoadFiletab[] = {NULL};
diff --git a/Python/dynload_win.c b/Python/dynload_win.c
@@ -15,13 +15,13 @@
 extern ULONG_PTR _Py_ActivateActCtx();
 void _Py_DeactivateActCtx(ULONG_PTR cookie);
 
-const struct filedescr _PyImport_DynLoadFiletab[] = {
+const char *_PyImport_DynLoadFiletab[] = {
 #ifdef _DEBUG
-    {"_d.pyd", "rb", C_EXTENSION},
+    "_d.pyd",
 #else
-    {".pyd", "rb", C_EXTENSION},
+    ".pyd",
 #endif
-    {0, 0}
+    NULL
 };
 
 
diff --git a/Python/import.c b/Python/import.c
diff --git a/Python/importdl.h b/Python/importdl.h
diff --git a/Python/importlib.h b/Python/importlib.h
