issue 9910
Add a Py_SetPath api to override magic path computations when starting up python.
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index ae5d028..52797f7 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -27,8 +27,9 @@
Initialize the Python interpreter. In an application embedding Python, this
should be called before using any other Python/C API functions; with the
- exception of :cfunc:`Py_SetProgramName`, :cfunc:`PyEval_InitThreads`,
- :cfunc:`PyEval_ReleaseLock`, and :cfunc:`PyEval_AcquireLock`. This initializes
+ exception of :cfunc:`Py_SetProgramName`, :cfunc:`Py_SetPath`,
+ :cfunc:`PyEval_InitThreads`, :cfunc:`PyEval_ReleaseLock`, and
+ :cfunc:`PyEval_AcquireLock`. This initializes
the table of loaded modules (``sys.modules``), and creates the fundamental
modules :mod:`builtins`, :mod:`__main__` and :mod:`sys`. It also initializes
the module search path (``sys.path``). It does not set ``sys.argv``; use
@@ -256,6 +257,7 @@
.. index::
triple: module; search; path
single: path (in module sys)
+ single: Py_SetPath()
Return the default module search path; this is computed from the program name
(set by :cfunc:`Py_SetProgramName` above) and some environment variables.
@@ -270,6 +272,25 @@
.. XXX should give the exact rules
+.. cfunction:: void Py_SetPath(const wchar_t *)
+
+ .. index::
+ triple: module; search; path
+ single: path (in module sys)
+ single: Py_GetPath()
+
+ Set the default module search path. If this function is called before
+ :cfunc: `Py_Initialize` then :cfunc: Py_GetPath won't attempt to compute
+ a default serarch path but uses the provided one in stead. This is useful
+ if Python is being embedded by an application that has full knowledge
+ of the location of all modules. The path components should be separated
+ by semicolons.
+
+ This also causes `sys.executable` to be set only to the raw program name
+ (see :cfunc:`Py_SetProgramName`) and `for sys.prefix` and
+ `sys.exec_prefix` to be empty. It is up to the caller to modify these if
+ required after calling :cfunc: `Py_Initialize`.
+
.. cfunction:: const char* Py_GetVersion()
Return the version of this Python interpreter. This is a string that looks