summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorpatenaud <33957588+patenaud@users.noreply.github.com>2024-02-02 16:31:55 (GMT)
committerGitHub <noreply@github.com>2024-02-02 16:31:55 (GMT)
commit9872855a31720f514b84373848b49fca09d66ecd (patch)
tree3192f99e767c284f53c6efd681fe09038baf0809 /Doc
parentee66c333493105e014678be118850e138e3c62a8 (diff)
downloadcpython-9872855a31720f514b84373848b49fca09d66ecd.zip
cpython-9872855a31720f514b84373848b49fca09d66ecd.tar.gz
cpython-9872855a31720f514b84373848b49fca09d66ecd.tar.bz2
GH-69695: Update ``PyImport_ImportModule`` description (GH-103836)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/import.rst16
1 files changed, 2 insertions, 14 deletions
diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
index 51c20b2..7c74e9e 100644
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -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)