From: Georg Brandl <georg@python.org>
Date: Fri, 21 Mar 2008 20:55:20 +0000 (+0000)
Subject: #2160: document PyImport_GetImporter.
X-Git-Tag: v2.6a2~182
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4ab9febddea82d1647d16473157f2ff05802fb30;p=thirdparty%2FPython%2Fcpython.git

#2160: document PyImport_GetImporter.
---

diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
index da8ef063b39b..c4816f5ed990 100644
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -161,6 +161,19 @@ Importing Modules
    ``sys.modules``).  Note that this is a per-interpreter variable.
 
 
+.. cfunction:: PyObject* PyImport_GetImporter(PyObject *path)
+
+   Return an importer object for a :data:`sys.path`/:attr:`pkg.__path__` item
+   *path*, possibly by fetching it from the :data:`sys.path_importer_cache`
+   dict.  If it wasn't yet cached, traverse :data:`sys.path_hooks` until a hook
+   is found that can handle the path item.  Return ``None`` if no hook could;
+   this tells our caller it should fall back to the builtin import mechanism.
+   Cache the result in :data:`sys.path_importer_cache`.  Return a new reference
+   to the importer object.
+
+   .. versionadded:: 2.6
+
+
 .. cfunction:: void _PyImport_Init()
 
    Initialize the import mechanism.  For internal use only.