Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 1 | """Utilities to support packages.""" |
| 2 | |
Łukasz Langa | 6f69251 | 2013-06-05 12:20:24 +0200 | [diff] [blame] | 3 | from functools import singledispatch as simplegeneric |
Łukasz Langa | 6f69251 | 2013-06-05 12:20:24 +0200 | [diff] [blame] | 4 | import importlib |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 5 | import importlib.util |
Nick Coghlan | 862542e | 2013-10-27 00:27:39 +1000 | [diff] [blame] | 6 | import importlib.machinery |
Łukasz Langa | 6f69251 | 2013-06-05 12:20:24 +0200 | [diff] [blame] | 7 | import os |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 8 | import os.path |
Łukasz Langa | 6f69251 | 2013-06-05 12:20:24 +0200 | [diff] [blame] | 9 | import sys |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 10 | from types import ModuleType |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 11 | import warnings |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 12 | |
| 13 | __all__ = [ |
| 14 | 'get_importer', 'iter_importers', 'get_loader', 'find_loader', |
Éric Araujo | a4e2d4f | 2011-05-02 22:59:15 +0200 | [diff] [blame] | 15 | 'walk_packages', 'iter_modules', 'get_data', |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 16 | 'ImpImporter', 'ImpLoader', 'read_code', 'extend_path', |
| 17 | ] |
| 18 | |
Eric Snow | 37148b2 | 2014-01-04 15:09:53 -0700 | [diff] [blame] | 19 | |
| 20 | def _get_spec(finder, name): |
| 21 | """Return the finder-specific module spec.""" |
| 22 | # Works with legacy finders. |
| 23 | try: |
| 24 | find_spec = finder.find_spec |
| 25 | except AttributeError: |
| 26 | loader = finder.find_module(name) |
| 27 | if loader is None: |
| 28 | return None |
| 29 | return importlib.util.spec_from_loader(name, loader) |
| 30 | else: |
| 31 | return find_spec(name) |
| 32 | |
| 33 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 34 | def read_code(stream): |
| 35 | # This helper is needed in order for the PEP 302 emulation to |
| 36 | # correctly handle compiled files |
| 37 | import marshal |
| 38 | |
| 39 | magic = stream.read(4) |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 40 | if magic != importlib.util.MAGIC_NUMBER: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 41 | return None |
| 42 | |
Antoine Pitrou | 5136ac0 | 2012-01-13 18:52:16 +0100 | [diff] [blame] | 43 | stream.read(8) # Skip timestamp and size |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 44 | return marshal.load(stream) |
| 45 | |
| 46 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 47 | def walk_packages(path=None, prefix='', onerror=None): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 48 | """Yields (module_loader, name, ispkg) for all modules recursively |
| 49 | on path, or, if path is None, all accessible modules. |
| 50 | |
| 51 | 'path' should be either None or a list of paths to look for |
| 52 | modules in. |
| 53 | |
| 54 | 'prefix' is a string to output on the front of every module name |
| 55 | on output. |
| 56 | |
| 57 | Note that this function must import all *packages* (NOT all |
| 58 | modules!) on the given path, in order to access the __path__ |
| 59 | attribute to find submodules. |
| 60 | |
| 61 | 'onerror' is a function which gets called with one argument (the |
| 62 | name of the package which was being imported) if any exception |
| 63 | occurs while trying to import a package. If no onerror function is |
| 64 | supplied, ImportErrors are caught and ignored, while all other |
| 65 | exceptions are propagated, terminating the search. |
| 66 | |
| 67 | Examples: |
| 68 | |
| 69 | # list all modules python can access |
| 70 | walk_packages() |
| 71 | |
| 72 | # list all submodules of ctypes |
| 73 | walk_packages(ctypes.__path__, ctypes.__name__+'.') |
| 74 | """ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 75 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 76 | def seen(p, m={}): |
| 77 | if p in m: |
| 78 | return True |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 79 | m[p] = True |
| 80 | |
| 81 | for importer, name, ispkg in iter_modules(path, prefix): |
| 82 | yield importer, name, ispkg |
| 83 | |
| 84 | if ispkg: |
| 85 | try: |
| 86 | __import__(name) |
| 87 | except ImportError: |
| 88 | if onerror is not None: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 89 | onerror(name) |
| 90 | except Exception: |
| 91 | if onerror is not None: |
| 92 | onerror(name) |
| 93 | else: |
| 94 | raise |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 95 | else: |
| 96 | path = getattr(sys.modules[name], '__path__', None) or [] |
| 97 | |
| 98 | # don't traverse path items we've seen before |
| 99 | path = [p for p in path if not seen(p)] |
| 100 | |
Philip Jenvey | 4993cc0 | 2012-10-01 12:53:43 -0700 | [diff] [blame] | 101 | yield from walk_packages(path, name+'.', onerror) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 102 | |
| 103 | |
| 104 | def iter_modules(path=None, prefix=''): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 105 | """Yields (module_loader, name, ispkg) for all submodules on path, |
| 106 | or, if path is None, all top-level modules on sys.path. |
| 107 | |
| 108 | 'path' should be either None or a list of paths to look for |
| 109 | modules in. |
| 110 | |
| 111 | 'prefix' is a string to output on the front of every module name |
| 112 | on output. |
| 113 | """ |
| 114 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 115 | if path is None: |
| 116 | importers = iter_importers() |
| 117 | else: |
| 118 | importers = map(get_importer, path) |
| 119 | |
| 120 | yielded = {} |
| 121 | for i in importers: |
| 122 | for name, ispkg in iter_importer_modules(i, prefix): |
| 123 | if name not in yielded: |
| 124 | yielded[name] = 1 |
| 125 | yield i, name, ispkg |
| 126 | |
| 127 | |
Łukasz Langa | 6f69251 | 2013-06-05 12:20:24 +0200 | [diff] [blame] | 128 | @simplegeneric |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 129 | def iter_importer_modules(importer, prefix=''): |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 130 | if not hasattr(importer, 'iter_modules'): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 131 | return [] |
| 132 | return importer.iter_modules(prefix) |
| 133 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 134 | |
Nick Coghlan | 8ecf504 | 2012-07-15 21:19:18 +1000 | [diff] [blame] | 135 | # Implement a file walker for the normal importlib path hook |
| 136 | def _iter_file_finder_modules(importer, prefix=''): |
| 137 | if importer.path is None or not os.path.isdir(importer.path): |
| 138 | return |
| 139 | |
| 140 | yielded = {} |
| 141 | import inspect |
| 142 | try: |
| 143 | filenames = os.listdir(importer.path) |
| 144 | except OSError: |
| 145 | # ignore unreadable directories like import does |
| 146 | filenames = [] |
| 147 | filenames.sort() # handle packages before same-named modules |
| 148 | |
| 149 | for fn in filenames: |
| 150 | modname = inspect.getmodulename(fn) |
| 151 | if modname=='__init__' or modname in yielded: |
| 152 | continue |
| 153 | |
| 154 | path = os.path.join(importer.path, fn) |
| 155 | ispkg = False |
| 156 | |
| 157 | if not modname and os.path.isdir(path) and '.' not in fn: |
| 158 | modname = fn |
| 159 | try: |
| 160 | dircontents = os.listdir(path) |
| 161 | except OSError: |
| 162 | # ignore unreadable directories like import does |
| 163 | dircontents = [] |
| 164 | for fn in dircontents: |
| 165 | subname = inspect.getmodulename(fn) |
| 166 | if subname=='__init__': |
| 167 | ispkg = True |
| 168 | break |
| 169 | else: |
| 170 | continue # not a package |
| 171 | |
| 172 | if modname and '.' not in modname: |
| 173 | yielded[modname] = 1 |
| 174 | yield prefix + modname, ispkg |
| 175 | |
| 176 | iter_importer_modules.register( |
| 177 | importlib.machinery.FileFinder, _iter_file_finder_modules) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 178 | |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 179 | |
| 180 | def _import_imp(): |
| 181 | global imp |
| 182 | with warnings.catch_warnings(): |
| 183 | warnings.simplefilter('ignore', PendingDeprecationWarning) |
| 184 | imp = importlib.import_module('imp') |
| 185 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 186 | class ImpImporter: |
| 187 | """PEP 302 Importer that wraps Python's "classic" import algorithm |
| 188 | |
| 189 | ImpImporter(dirname) produces a PEP 302 importer that searches that |
| 190 | directory. ImpImporter(None) produces a PEP 302 importer that searches |
| 191 | the current sys.path, plus any modules that are frozen or built-in. |
| 192 | |
| 193 | Note that ImpImporter does not currently support being used by placement |
| 194 | on sys.meta_path. |
| 195 | """ |
| 196 | |
| 197 | def __init__(self, path=None): |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 198 | global imp |
| 199 | warnings.warn("This emulation is deprecated, use 'importlib' instead", |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 200 | DeprecationWarning) |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 201 | _import_imp() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 202 | self.path = path |
| 203 | |
| 204 | def find_module(self, fullname, path=None): |
| 205 | # Note: we ignore 'path' argument since it is only used via meta_path |
| 206 | subname = fullname.split(".")[-1] |
| 207 | if subname != fullname and self.path is None: |
| 208 | return None |
| 209 | if self.path is None: |
| 210 | path = None |
| 211 | else: |
| 212 | path = [os.path.realpath(self.path)] |
| 213 | try: |
| 214 | file, filename, etc = imp.find_module(subname, path) |
| 215 | except ImportError: |
| 216 | return None |
| 217 | return ImpLoader(fullname, file, filename, etc) |
| 218 | |
| 219 | def iter_modules(self, prefix=''): |
| 220 | if self.path is None or not os.path.isdir(self.path): |
| 221 | return |
| 222 | |
| 223 | yielded = {} |
| 224 | import inspect |
Ned Deily | ed27df7 | 2011-10-06 14:19:08 -0700 | [diff] [blame] | 225 | try: |
| 226 | filenames = os.listdir(self.path) |
| 227 | except OSError: |
| 228 | # ignore unreadable directories like import does |
| 229 | filenames = [] |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 230 | filenames.sort() # handle packages before same-named modules |
| 231 | |
| 232 | for fn in filenames: |
| 233 | modname = inspect.getmodulename(fn) |
| 234 | if modname=='__init__' or modname in yielded: |
| 235 | continue |
| 236 | |
| 237 | path = os.path.join(self.path, fn) |
| 238 | ispkg = False |
| 239 | |
| 240 | if not modname and os.path.isdir(path) and '.' not in fn: |
| 241 | modname = fn |
Ned Deily | ed27df7 | 2011-10-06 14:19:08 -0700 | [diff] [blame] | 242 | try: |
| 243 | dircontents = os.listdir(path) |
| 244 | except OSError: |
| 245 | # ignore unreadable directories like import does |
| 246 | dircontents = [] |
| 247 | for fn in dircontents: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 248 | subname = inspect.getmodulename(fn) |
| 249 | if subname=='__init__': |
| 250 | ispkg = True |
| 251 | break |
| 252 | else: |
| 253 | continue # not a package |
| 254 | |
| 255 | if modname and '.' not in modname: |
| 256 | yielded[modname] = 1 |
| 257 | yield prefix + modname, ispkg |
| 258 | |
| 259 | |
| 260 | class ImpLoader: |
| 261 | """PEP 302 Loader that wraps Python's "classic" import algorithm |
| 262 | """ |
| 263 | code = source = None |
| 264 | |
| 265 | def __init__(self, fullname, file, filename, etc): |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 266 | warnings.warn("This emulation is deprecated, use 'importlib' instead", |
| 267 | DeprecationWarning) |
| 268 | _import_imp() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 269 | self.file = file |
| 270 | self.filename = filename |
| 271 | self.fullname = fullname |
| 272 | self.etc = etc |
| 273 | |
| 274 | def load_module(self, fullname): |
| 275 | self._reopen() |
| 276 | try: |
| 277 | mod = imp.load_module(fullname, self.file, self.filename, self.etc) |
| 278 | finally: |
| 279 | if self.file: |
| 280 | self.file.close() |
| 281 | # Note: we don't set __loader__ because we want the module to look |
| 282 | # normal; i.e. this is just a wrapper for standard import machinery |
| 283 | return mod |
| 284 | |
| 285 | def get_data(self, pathname): |
Brett Cannon | 1ab58df | 2010-10-29 22:36:53 +0000 | [diff] [blame] | 286 | with open(pathname, "rb") as file: |
| 287 | return file.read() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 288 | |
| 289 | def _reopen(self): |
| 290 | if self.file and self.file.closed: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 291 | mod_type = self.etc[2] |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 292 | if mod_type==imp.PY_SOURCE: |
Victor Stinner | 4e86d5b | 2011-05-04 13:55:36 +0200 | [diff] [blame] | 293 | self.file = open(self.filename, 'r') |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 294 | elif mod_type in (imp.PY_COMPILED, imp.C_EXTENSION): |
| 295 | self.file = open(self.filename, 'rb') |
| 296 | |
| 297 | def _fix_name(self, fullname): |
| 298 | if fullname is None: |
| 299 | fullname = self.fullname |
| 300 | elif fullname != self.fullname: |
| 301 | raise ImportError("Loader for module %s cannot handle " |
| 302 | "module %s" % (self.fullname, fullname)) |
| 303 | return fullname |
| 304 | |
| 305 | def is_package(self, fullname): |
| 306 | fullname = self._fix_name(fullname) |
| 307 | return self.etc[2]==imp.PKG_DIRECTORY |
| 308 | |
| 309 | def get_code(self, fullname=None): |
| 310 | fullname = self._fix_name(fullname) |
| 311 | if self.code is None: |
| 312 | mod_type = self.etc[2] |
| 313 | if mod_type==imp.PY_SOURCE: |
| 314 | source = self.get_source(fullname) |
| 315 | self.code = compile(source, self.filename, 'exec') |
| 316 | elif mod_type==imp.PY_COMPILED: |
| 317 | self._reopen() |
| 318 | try: |
| 319 | self.code = read_code(self.file) |
| 320 | finally: |
| 321 | self.file.close() |
| 322 | elif mod_type==imp.PKG_DIRECTORY: |
| 323 | self.code = self._get_delegate().get_code() |
| 324 | return self.code |
| 325 | |
| 326 | def get_source(self, fullname=None): |
| 327 | fullname = self._fix_name(fullname) |
| 328 | if self.source is None: |
| 329 | mod_type = self.etc[2] |
| 330 | if mod_type==imp.PY_SOURCE: |
| 331 | self._reopen() |
| 332 | try: |
| 333 | self.source = self.file.read() |
| 334 | finally: |
| 335 | self.file.close() |
| 336 | elif mod_type==imp.PY_COMPILED: |
| 337 | if os.path.exists(self.filename[:-1]): |
Giampaolo Rodola' | 2f50aaf | 2013-02-12 02:04:27 +0100 | [diff] [blame] | 338 | with open(self.filename[:-1], 'r') as f: |
| 339 | self.source = f.read() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 340 | elif mod_type==imp.PKG_DIRECTORY: |
| 341 | self.source = self._get_delegate().get_source() |
| 342 | return self.source |
| 343 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 344 | def _get_delegate(self): |
Eric Snow | 37148b2 | 2014-01-04 15:09:53 -0700 | [diff] [blame] | 345 | finder = ImpImporter(self.filename) |
| 346 | spec = _get_spec(finder, '__init__') |
| 347 | return spec.loader |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 348 | |
| 349 | def get_filename(self, fullname=None): |
| 350 | fullname = self._fix_name(fullname) |
| 351 | mod_type = self.etc[2] |
Éric Araujo | 0cfb81d | 2011-09-17 03:35:57 +0200 | [diff] [blame] | 352 | if mod_type==imp.PKG_DIRECTORY: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 353 | return self._get_delegate().get_filename() |
Éric Araujo | 0cfb81d | 2011-09-17 03:35:57 +0200 | [diff] [blame] | 354 | elif mod_type in (imp.PY_SOURCE, imp.PY_COMPILED, imp.C_EXTENSION): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 355 | return self.filename |
| 356 | return None |
| 357 | |
| 358 | |
| 359 | try: |
| 360 | import zipimport |
| 361 | from zipimport import zipimporter |
| 362 | |
| 363 | def iter_zipimport_modules(importer, prefix=''): |
Alexandre Vassalotti | 515a74f | 2009-07-05 06:42:44 +0000 | [diff] [blame] | 364 | dirlist = sorted(zipimport._zip_directory_cache[importer.archive]) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 365 | _prefix = importer.prefix |
| 366 | plen = len(_prefix) |
| 367 | yielded = {} |
| 368 | import inspect |
| 369 | for fn in dirlist: |
| 370 | if not fn.startswith(_prefix): |
| 371 | continue |
| 372 | |
| 373 | fn = fn[plen:].split(os.sep) |
| 374 | |
| 375 | if len(fn)==2 and fn[1].startswith('__init__.py'): |
| 376 | if fn[0] not in yielded: |
| 377 | yielded[fn[0]] = 1 |
| 378 | yield fn[0], True |
| 379 | |
| 380 | if len(fn)!=1: |
| 381 | continue |
| 382 | |
| 383 | modname = inspect.getmodulename(fn[0]) |
| 384 | if modname=='__init__': |
| 385 | continue |
| 386 | |
| 387 | if modname and '.' not in modname and modname not in yielded: |
| 388 | yielded[modname] = 1 |
| 389 | yield prefix + modname, False |
| 390 | |
| 391 | iter_importer_modules.register(zipimporter, iter_zipimport_modules) |
| 392 | |
| 393 | except ImportError: |
| 394 | pass |
| 395 | |
| 396 | |
| 397 | def get_importer(path_item): |
| 398 | """Retrieve a PEP 302 importer for the given path item |
| 399 | |
| 400 | The returned importer is cached in sys.path_importer_cache |
| 401 | if it was newly created by a path hook. |
| 402 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 403 | The cache (or part of it) can be cleared manually if a |
| 404 | rescan of sys.path_hooks is necessary. |
| 405 | """ |
| 406 | try: |
| 407 | importer = sys.path_importer_cache[path_item] |
| 408 | except KeyError: |
| 409 | for path_hook in sys.path_hooks: |
| 410 | try: |
| 411 | importer = path_hook(path_item) |
Brett Cannon | e0d88a1 | 2012-04-25 20:54:04 -0400 | [diff] [blame] | 412 | sys.path_importer_cache.setdefault(path_item, importer) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 413 | break |
| 414 | except ImportError: |
| 415 | pass |
| 416 | else: |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 417 | importer = None |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 418 | return importer |
| 419 | |
| 420 | |
| 421 | def iter_importers(fullname=""): |
| 422 | """Yield PEP 302 importers for the given module name |
| 423 | |
| 424 | If fullname contains a '.', the importers will be for the package |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 425 | containing fullname, otherwise they will be all registered top level |
| 426 | importers (i.e. those on both sys.meta_path and sys.path_hooks). |
| 427 | |
| 428 | If the named module is in a package, that package is imported as a side |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 429 | effect of invoking this function. |
| 430 | |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 431 | If no module name is specified, all top level importers are produced. |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 432 | """ |
| 433 | if fullname.startswith('.'): |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 434 | msg = "Relative module name {!r} not supported".format(fullname) |
| 435 | raise ImportError(msg) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 436 | if '.' in fullname: |
| 437 | # Get the containing package's __path__ |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 438 | pkg_name = fullname.rpartition(".")[0] |
Nick Coghlan | c4e0d98 | 2013-04-14 22:30:42 +1000 | [diff] [blame] | 439 | pkg = importlib.import_module(pkg_name) |
| 440 | path = getattr(pkg, '__path__', None) |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 441 | if path is None: |
| 442 | return |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 443 | else: |
Andrew Svetlov | 2aa5f3c | 2012-10-07 23:21:15 +0300 | [diff] [blame] | 444 | yield from sys.meta_path |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 445 | path = sys.path |
| 446 | for item in path: |
| 447 | yield get_importer(item) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 448 | |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 449 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 450 | def get_loader(module_or_name): |
| 451 | """Get a PEP 302 "loader" object for module_or_name |
| 452 | |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 453 | Returns None if the module cannot be found or imported. |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 454 | If the named module is not already imported, its containing package |
| 455 | (if any) is imported, in order to establish the package __path__. |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 456 | """ |
| 457 | if module_or_name in sys.modules: |
| 458 | module_or_name = sys.modules[module_or_name] |
| 459 | if isinstance(module_or_name, ModuleType): |
| 460 | module = module_or_name |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 461 | loader = getattr(module, '__loader__', None) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 462 | if loader is not None: |
| 463 | return loader |
| 464 | fullname = module.__name__ |
| 465 | else: |
| 466 | fullname = module_or_name |
| 467 | return find_loader(fullname) |
| 468 | |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 469 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 470 | def find_loader(fullname): |
| 471 | """Find a PEP 302 "loader" object for fullname |
| 472 | |
Nick Coghlan | 62b4b9e | 2014-03-04 20:39:42 +1000 | [diff] [blame] | 473 | This is a backwards compatibility wrapper around |
| 474 | importlib.util.find_spec that converts most failures to ImportError |
| 475 | and only returns the loader rather than the full spec |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 476 | """ |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 477 | if fullname.startswith('.'): |
| 478 | msg = "Relative module name {!r} not supported".format(fullname) |
| 479 | raise ImportError(msg) |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 480 | try: |
Nick Coghlan | 62b4b9e | 2014-03-04 20:39:42 +1000 | [diff] [blame] | 481 | spec = importlib.util.find_spec(fullname) |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 482 | except (ImportError, AttributeError, TypeError, ValueError) as ex: |
| 483 | # This hack fixes an impedance mismatch between pkgutil and |
Andrew Svetlov | 5b89840 | 2012-12-18 21:26:36 +0200 | [diff] [blame] | 484 | # importlib, where the latter raises other errors for cases where |
Andrew Svetlov | 1f415cf | 2012-12-19 22:54:47 +0200 | [diff] [blame] | 485 | # pkgutil previously raised ImportError |
Nick Coghlan | 85e729e | 2012-07-15 18:09:52 +1000 | [diff] [blame] | 486 | msg = "Error while finding loader for {!r} ({}: {})" |
| 487 | raise ImportError(msg.format(fullname, type(ex), ex)) from ex |
Nick Coghlan | 62b4b9e | 2014-03-04 20:39:42 +1000 | [diff] [blame] | 488 | return spec.loader |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 489 | |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 490 | |
| 491 | def extend_path(path, name): |
| 492 | """Extend a package's path. |
| 493 | |
| 494 | Intended use is to place the following code in a package's __init__.py: |
| 495 | |
| 496 | from pkgutil import extend_path |
| 497 | __path__ = extend_path(__path__, __name__) |
| 498 | |
| 499 | This will add to the package's __path__ all subdirectories of |
| 500 | directories on sys.path named after the package. This is useful |
| 501 | if one wants to distribute different parts of a single logical |
| 502 | package as multiple directories. |
| 503 | |
| 504 | It also looks for *.pkg files beginning where * matches the name |
| 505 | argument. This feature is similar to *.pth files (see site.py), |
| 506 | except that it doesn't special-case lines starting with 'import'. |
| 507 | A *.pkg file is trusted at face value: apart from checking for |
| 508 | duplicates, all entries found in a *.pkg file are added to the |
| 509 | path, regardless of whether they are exist the filesystem. (This |
| 510 | is a feature.) |
| 511 | |
| 512 | If the input path is not a list (as is the case for frozen |
| 513 | packages) it is returned unchanged. The input path is not |
| 514 | modified; an extended copy is returned. Items are only appended |
| 515 | to the copy at the end. |
| 516 | |
| 517 | It is assumed that sys.path is a sequence. Items of sys.path that |
| 518 | are not (unicode or 8-bit) strings referring to existing |
| 519 | directories are ignored. Unicode items of sys.path that cause |
| 520 | errors when used as filenames may cause this function to raise an |
| 521 | exception (in line with os.path.isdir() behavior). |
| 522 | """ |
| 523 | |
| 524 | if not isinstance(path, list): |
| 525 | # This could happen e.g. when this is called from inside a |
| 526 | # frozen package. Return the path unchanged in that case. |
| 527 | return path |
| 528 | |
Skip Montanaro | 7a98be2 | 2007-08-16 14:35:24 +0000 | [diff] [blame] | 529 | sname_pkg = name + ".pkg" |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 530 | |
| 531 | path = path[:] # Start with a copy of the existing path |
| 532 | |
Antoine Pitrou | b2dd880 | 2012-07-09 21:23:58 +0200 | [diff] [blame] | 533 | parent_package, _, final_name = name.rpartition('.') |
| 534 | if parent_package: |
| 535 | try: |
| 536 | search_path = sys.modules[parent_package].__path__ |
| 537 | except (KeyError, AttributeError): |
| 538 | # We can't do anything: find_loader() returns None when |
| 539 | # passed a dotted name. |
| 540 | return path |
| 541 | else: |
| 542 | search_path = sys.path |
| 543 | |
| 544 | for dir in search_path: |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 545 | if not isinstance(dir, str): |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 546 | continue |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 547 | |
| 548 | finder = get_importer(dir) |
| 549 | if finder is not None: |
Eric Snow | 02b9f9d | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 550 | portions = [] |
| 551 | if hasattr(finder, 'find_spec'): |
| 552 | spec = finder.find_spec(final_name) |
| 553 | if spec is not None: |
| 554 | portions = spec.submodule_search_locations or [] |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 555 | # Is this finder PEP 420 compliant? |
Eric Snow | 02b9f9d | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 556 | elif hasattr(finder, 'find_loader'): |
| 557 | _, portions = finder.find_loader(final_name) |
Eric V. Smith | 984b11f | 2012-05-24 20:21:04 -0400 | [diff] [blame] | 558 | |
| 559 | for portion in portions: |
| 560 | # XXX This may still add duplicate entries to path on |
| 561 | # case-insensitive filesystems |
| 562 | if portion not in path: |
| 563 | path.append(portion) |
| 564 | |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 565 | # XXX Is this the right thing for subpackages like zope.app? |
| 566 | # It looks for a file named "zope.app.pkg" |
| 567 | pkgfile = os.path.join(dir, sname_pkg) |
| 568 | if os.path.isfile(pkgfile): |
| 569 | try: |
| 570 | f = open(pkgfile) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 571 | except OSError as msg: |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 572 | sys.stderr.write("Can't open %s: %s\n" % |
| 573 | (pkgfile, msg)) |
| 574 | else: |
Giampaolo Rodola' | 2f50aaf | 2013-02-12 02:04:27 +0100 | [diff] [blame] | 575 | with f: |
| 576 | for line in f: |
| 577 | line = line.rstrip('\n') |
| 578 | if not line or line.startswith('#'): |
| 579 | continue |
| 580 | path.append(line) # Don't check for existence! |
Guido van Rossum | a4deda0 | 2002-12-23 16:30:00 +0000 | [diff] [blame] | 581 | |
| 582 | return path |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 583 | |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 584 | |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 585 | def get_data(package, resource): |
| 586 | """Get a resource from a package. |
| 587 | |
| 588 | This is a wrapper round the PEP 302 loader get_data API. The package |
| 589 | argument should be the name of a package, in standard module format |
| 590 | (foo.bar). The resource argument should be in the form of a relative |
| 591 | filename, using '/' as the path separator. The parent directory name '..' |
| 592 | is not allowed, and nor is a rooted name (starting with a '/'). |
| 593 | |
| 594 | The function returns a binary string, which is the contents of the |
| 595 | specified resource. |
| 596 | |
| 597 | For packages located in the filesystem, which have already been imported, |
| 598 | this is the rough equivalent of |
| 599 | |
| 600 | d = os.path.dirname(sys.modules[package].__file__) |
| 601 | data = open(os.path.join(d, resource), 'rb').read() |
| 602 | |
| 603 | If the package cannot be located or loaded, or it uses a PEP 302 loader |
| 604 | which does not support get_data(), then None is returned. |
| 605 | """ |
| 606 | |
Eric Snow | 6029e08 | 2014-01-25 15:32:46 -0700 | [diff] [blame] | 607 | spec = importlib.util.find_spec(package) |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 608 | if spec is None: |
| 609 | return None |
| 610 | loader = spec.loader |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 611 | if loader is None or not hasattr(loader, 'get_data'): |
| 612 | return None |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 613 | # XXX needs test |
| 614 | mod = (sys.modules.get(package) or |
| 615 | importlib._bootstrap._SpecMethods(spec).load()) |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 616 | if mod is None or not hasattr(mod, '__file__'): |
| 617 | return None |
| 618 | |
| 619 | # Modify the resource name to be compatible with the loader.get_data |
| 620 | # signature - an os.path format "filename" starting with the dirname of |
| 621 | # the package's __file__ |
| 622 | parts = resource.split('/') |
| 623 | parts.insert(0, os.path.dirname(mod.__file__)) |
| 624 | resource_name = os.path.join(*parts) |
| 625 | return loader.get_data(resource_name) |