]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] GH-69695: Update ``PyImport_ImportModule`` description (GH-103836) (GH-114924)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 5 Feb 2024 09:53:50 +0000 (10:53 +0100)
committerGitHub <noreply@github.com>
Mon, 5 Feb 2024 09:53:50 +0000 (10:53 +0100)
GH-69695: Update ``PyImport_ImportModule`` description (GH-103836)

(cherry picked from commit 9872855a31720f514b84373848b49fca09d66ecd)

Co-authored-by: patenaud <33957588+patenaud@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/c-api/import.rst

index b9694dbeebcbea7b75fadbd74b52be04854cfff5..61c523285e6be18f75ff1722ec79ebf488b6be67 100644 (file)
@@ -13,20 +13,8 @@ Importing Modules
       single: __all__ (package variable)
       single: modules (in module sys)
 
-   This is a simplified interface to :c:func:`PyImport_ImportModuleEx` below,
-   leaving the *globals* and *locals* arguments set to ``NULL`` and *level* set
-   to 0.  When the *name*
-   argument contains a dot (when it specifies a submodule of a package), the
-   *fromlist* argument is set to the list ``['*']`` so that the return value is the
-   named module rather than the top-level package containing it as would otherwise
-   be the case.  (Unfortunately, this has an additional side effect when *name* in
-   fact specifies a subpackage instead of a submodule: the submodules specified in
-   the package's ``__all__`` variable are  loaded.)  Return a new reference to the
-   imported module, or ``NULL`` with an exception set on failure.  A failing
-   import of a module doesn't leave the module in :data:`sys.modules`.
-
-   This function always uses absolute imports.
-
+   This is a wrapper around :c:func:`PyImport_Import()` which takes a
+   :c:expr:`const char *` as an argument instead of a :c:expr:`PyObject *`.
 
 .. c:function:: PyObject* PyImport_ImportModuleNoBlock(const char *name)