pip._vendor.distlib.resources Namespace Reference

Data Structures
class	Resource
class	ResourceBase
class	ResourceCache
class	ResourceContainer
class	ResourceFinder
class	ZipResourceFinder

Functions
	register_finder (loader, finder_maker)
	finder (package)
	finder_for_path (path)

Variables
	logger = logging.getLogger(__name__)
	cache = None
dict	_finder_registry
dict	_finder_cache = {}
	_dummy_module = types.ModuleType(str('__dummy__'))

Function Documentation

finder()

finder

(

package

)

Return a resource finder for a package.
:param package: The name of the package.
:return: A :class:`ResourceFinder` instance for the package.

Definition at line 313 of file resources.py.

def finder(package):
    """
    Return a resource finder for a package.
    :param package: The name of the package.
    :return: A :class:`ResourceFinder` instance for the package.
    """
    if package in _finder_cache:
        result = _finder_cache[package]
    else:
        if package not in sys.modules:
            __import__(package)
        module = sys.modules[package]
        path = getattr(module, '__path__', None)
        if path is None:
            raise DistlibException('You cannot get a finder for a module, '
                                   'only for a package')
        loader = getattr(module, '__loader__', None)
        finder_maker = _finder_registry.get(type(loader))
        if finder_maker is None:
            raise DistlibException('Unable to locate finder for %r' % package)
        result = finder_maker(module)
        _finder_cache[package] = result
    return result
 
 

References i.

finder_for_path()

finder_for_path

(

path

)

Return a resource finder for a path, which should represent a container.

:param path: The path.
:return: A :class:`ResourceFinder` instance for the path.

Definition at line 341 of file resources.py.

def finder_for_path(path):
    """
    Return a resource finder for a path, which should represent a container.
 
    :param path: The path.
    :return: A :class:`ResourceFinder` instance for the path.
    """
    result = None
    # calls any path hooks, gets importer into cache
    pkgutil.get_importer(path)
    loader = sys.path_importer_cache.get(path)
    finder = _finder_registry.get(type(loader))
    if finder:
        module = _dummy_module
        module.__file__ = os.path.join(path, '')
        module.__loader__ = loader
        result = finder(module)
    return result

References i.

register_finder()

register_finder	(		loader,
			finder_maker
	)

Definition at line 306 of file resources.py.

def register_finder(loader, finder_maker):
    _finder_registry[type(loader)] = finder_maker
 
 

Variable Documentation

_dummy_module

_dummy_module = types.ModuleType(str('__dummy__'))

protected

Definition at line 338 of file resources.py.

_finder_cache

dict _finder_cache = {}

protected

Definition at line 310 of file resources.py.

_finder_registry

dict _finder_registry

protected

Initial value:

=  {
    type(None): ResourceFinder,
    zipimport.zipimporter: ZipResourceFinder
}

Definition at line 286 of file resources.py.

cache

cache = None

Definition at line 24 of file resources.py.

logger

logger = logging.getLogger(__name__)

Definition at line 21 of file resources.py.