ihooks

Import hook support.

Consistent use of this module will make it possible to change the
different mechanisms involved in loading modules independently.

While the built-in module imp exports interfaces to the built-in
module searching and loading algorithm, and it is possible to replace
the built-in function __import__ in order to change the semantics of
the import statement, until now it has been difficult to combine the
effect of different __import__ hacks, like loading modules from URLs
by rimport.py, or restricted execution by rexec.py.

This module defines three new concepts:

1) A "file system hooks" class provides an interface to a filesystem.

One hooks class is defined (Hooks), which uses the interface provided
by standard modules os and os.path.  It should be used as the base
class for other hooks classes.

2) A "module loader" class provides an interface to to search for a
module in a search path and to load it.  It defines a method which
searches for a module in a single directory; by overriding this method
one can redefine the details of the search.  If the directory is None,
built-in and frozen modules are searched instead.

Two module loader class are defined, both implementing the search
strategy used by the built-in __import__ function: ModuleLoader uses
the imp module's find_module interface, while HookableModuleLoader
uses a file system hooks class to interact with the file system.  Both
use the imp module's load_* interfaces to actually load the module.

3) A "module importer" class provides an interface to import a
module, as well as interfaces to reload and unload a module.  It also
provides interfaces to install and uninstall itself instead of the
default __import__ and reload (and unload) functions.

One module importer class is defined (ModuleImporter), which uses a
module loader instance passed in (by default HookableModuleLoader is
instantiated).

The classes defined here should be used as base classes for extended
functionality along those lines.

If a module mporter class supports dotted names, its import_module()
must return a different value depending on whether it is called on
behalf of a "from ... import ..." statement or not.  (This is caused
by the way the __import__ hook is used by the Python interpreter.)  It
would also do wise to install a different version of reload().

Modules
		__builtin__ imp os string sys

Classes
		_Verbose BasicModuleImporter ModuleImporter BasicModuleLoader ModuleLoader FancyModuleLoader Hooks  class BasicModuleImporter(_Verbose)            Basic module importer; uses module loader. This provides basic import facilities but no package imports.                                                                                                                                                                                                                          __init__(self, loader=None, verbose=0) no doc string get_hooks(self) no doc string get_loader(self) no doc string import_module(self, name, globals={}, locals={}, fromlist=[]) no doc string install(self) no doc string reload(self, module, path=None) no doc string set_hooks(self, hooks) no doc string set_loader(self, loader) no doc string uninstall(self) no doc string unload(self, module) no doc string  class BasicModuleLoader(_Verbose)            Basic module loader. This provides the same functionality as built-in import.  It doesn't deal with checking sys.modules -- all it provides is find_module() and a load_module(), as well as find_module_in_dir() which searches just one directory, and can be overridden by a derived class to change the module search algorithm when the basic dependency on sys.path is unchanged. The interface is a little more convenient than imp's: find_module(name, [path]) returns None or 'stuff', and load_module(name, stuff) loads the module.                                                                                                                                                                                                                          default_path(self) no doc string find_builtin_module(self, name) no doc string find_module(self, name, path=None) no doc string find_module_in_dir(self, name, dir) no doc string load_module(self, name, stuff) no doc string  class FancyModuleLoader(ModuleLoader)            Fancy module loader -- parses and execs the code itself.                                                                                                                                                                                                                          load_module(self, name, stuff) no doc string  class Hooks(_Verbose)            Hooks into the filesystem and interpreter. By deriving a subclass you can redefine your filesystem interface, e.g. to merge it with the URL space. This base class behaves just like the native filesystem.                                                                                                                                                                                                                          add_module(self, name) no doc string default_path(self) # sys interface get_frozen_object(self, name) # imp interface get_suffixes(self) # imp interface init_builtin(self, name) # imp interface init_frozen(self, name) # imp interface is_builtin(self, name) # imp interface is_frozen(self, name) # imp interface listdir(self, x) no doc string load_compiled(self, name, filename, file=None) no doc string load_dynamic(self, name, filename, file=None) no doc string load_package(self, name, filename, file=None) no doc string load_source(self, name, filename, file=None) # imp interface modules_dict(self) # sys interface new_module(self, name) # imp interface openfile(self, *x) # etc. path_exists(self, x) no doc string path_isabs(self, x) no doc string path_isdir(self, x) no doc string path_isfile(self, x) no doc string path_islink(self, x) no doc string path_join(self, x, y) no doc string path_split(self, x) no doc string  class ModuleImporter(BasicModuleImporter)            A module importer that supports packages.                                                                                                                                                                                                                          determine_parent(self, globals) no doc string ensure_fromlist(self, m, fromlist, recursive=0) no doc string find_head_package(self, parent, name) no doc string import_it(self, partname, fqname, parent) no doc string import_module(self, name, globals=None, locals=None, fromlist=None) no doc string load_tail(self, q, tail) no doc string reload(self, module) no doc string  class ModuleLoader(BasicModuleLoader)            Default module loader; uses file system hooks. By defining suitable hooks, you might be able to load modules from other sources than the file system, e.g. from compressed or encrypted files, tar files or (if you're brave!) URLs.                                                                                                                                                                                                                          __init__(self, hooks=None, verbose=0) no doc string default_path(self) no doc string find_builtin_module(self, name) no doc string find_module_in_dir(self, name, dir, allow_packages=1) no doc string get_hooks(self) no doc string load_module(self, name, stuff) no doc string modules_dict(self) no doc string set_hooks(self, hooks) no doc string  class _Verbose            no doc string                                                                                                                                                                                                                        __init__(self, verbose=0) no doc string get_verbose(self) no doc string message(self, format, *args) no doc string note(self, *args) # XXX The following is an experimental interface set_verbose(self, verbose) no doc string

Functions
		install(importer=None) no doc string uninstall() no doc string