remove Py_GetPath

picnixz · picnixz · commit 5304e49955d4 · 2025-05-08T13:04:44.000+02:00
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
@@ -77,8 +77,7 @@ The following functions can be safely called before Python is initialized:
 
    Despite their apparent similarity to some of the functions listed above,
    the following functions **should not be called** before the interpreter has
-   been initialized: :c:func:`Py_EncodeLocale`, :c:func:`Py_GetPath`,
-   :c:func:`Py_GetPrefix`, :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome`, :c:func:`PyEval_InitThreads`, and
+   been initialized: :c:func:`Py_EncodeLocale`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome`, :c:func:`PyEval_InitThreads`, and
    :c:func:`Py_RunMain`.
 
 
@@ -143,9 +142,6 @@ to 1 and ``-bb`` sets :c:data:`Py_BytesWarningFlag` to 2.
    :c:member:`PyConfig.pathconfig_warnings` should be used instead, see
    :ref:`Python Initialization Configuration <init-config>`.
 
-   Suppress error messages when calculating the module search path in
-   :c:func:`Py_GetPath`.
-
    Private flag used by ``_freeze_module`` and ``frozenmain`` programs.
 
    .. deprecated-removed:: 3.12 3.15
@@ -584,7 +580,6 @@ Process-wide parameters
    .. index::
       single: Py_Initialize()
       single: main()
-      single: Py_GetPath()
 
    This API is kept for backward compatibility: setting
    :c:member:`PyConfig.program_name` should be used instead, see :ref:`Python
@@ -594,7 +589,7 @@ Process-wide parameters
    the first time, if it is called at all.  It tells the interpreter the value
    of the ``argv[0]`` argument to the :c:func:`main` function of the program
    (converted to wide characters).
-   This is used by :c:func:`Py_GetPath` and some other functions below to find
+   This is used by some other functions below to find
    the Python run-time libraries relative to the interpreter executable.  The
    default value is ``'python'``.  The argument should point to a
    zero-terminated wide character string in static storage whose contents will not
@@ -654,34 +649,6 @@ Process-wide parameters
       (:data:`sys.executable`) instead.
 
 
-.. c:function:: wchar_t* Py_GetPath()
-
-   .. index::
-      triple: module; search; path
-      single: path (in module sys)
-
-   Return the default module search path; this is computed from the program name
-   (set by :c:member:`PyConfig.program_name`) and some environment variables.
-   The returned string consists of a series of directory names separated by a
-   platform dependent delimiter character.  The delimiter character is ``':'``
-   on Unix and macOS, ``';'`` on Windows.  The returned string points into
-   static storage; the caller should not modify its value.  The list
-   :data:`sys.path` is initialized with this value on interpreter startup; it
-   can be (and usually is) modified later to change the search path for loading
-   modules.
-
-   This function should not be called before :c:func:`Py_Initialize`, otherwise
-   it returns ``NULL``.
-
-   .. XXX should give the exact rules
-
-   .. versionchanged:: 3.10
-      It now returns ``NULL`` if called before :c:func:`Py_Initialize`.
-
-   .. deprecated-removed:: 3.13 3.15
-      Use :c:func:`PyConfig_Get("module_search_paths") <PyConfig_Get>`
-      (:data:`sys.path`) instead.
-
 .. c:function:: const char* Py_GetVersion()
 
    Return the version of this Python interpreter.  This is a string that looks
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
@@ -780,7 +780,6 @@ environment variable :envvar:`PYTHONHOME`, or insert additional directories in
 front of the standard path by setting :envvar:`PYTHONPATH`.
 
 .. index::
-   single: Py_GetPath (C function)
    single: Py_GetPrefix (C function)
    single: Py_GetProgramFullPath (C function)
 
@@ -789,8 +788,7 @@ The embedding application can steer the search by setting
 :c:func:`Py_InitializeFromConfig`. Note that
 :envvar:`PYTHONHOME` still overrides this and :envvar:`PYTHONPATH` is still
 inserted in front of the standard path.  An application that requires total
-control has to provide its own implementation of :c:func:`Py_GetPath`,
-:c:func:`Py_GetPrefix`, and
+control has to provide its own implementation of :c:func:`Py_GetPrefix`, and
 :c:func:`Py_GetProgramFullPath` (all defined in :file:`Modules/getpath.c`).
 
 .. index:: single: Py_IsInitialized (C function)
diff --git a/Doc/data/refcounts.dat b/Doc/data/refcounts.dat
@@ -3007,8 +3007,6 @@ Py_GetCompiler:const char*:::
 
 Py_GetCopyright:const char*:::
 
-Py_GetPath:wchar_t*:::
-
 Py_GetPlatform:const char*:::
 
 Py_GetPrefix:wchar_t*:::
diff --git a/Doc/data/stable_abi.dat b/Doc/data/stable_abi.dat
diff --git a/Doc/deprecations/c-api-pending-removal-in-3.15.rst b/Doc/deprecations/c-api-pending-removal-in-3.15.rst
@@ -22,9 +22,6 @@ Pending removal in Python 3.15
   may return a type other than :class:`bytes`, such as :class:`str`.
 * Python initialization functions, deprecated in Python 3.13:
 
-  * :c:func:`Py_GetPath`:
-    Use :c:func:`PyConfig_Get("module_search_paths") <PyConfig_Get>`
-    (:data:`sys.path`) instead.
   * :c:func:`Py_GetPrefix`:
     Use :c:func:`PyConfig_Get("base_prefix") <PyConfig_Get>`
     (:data:`sys.base_prefix`) instead. Use :c:func:`PyConfig_Get("prefix")
diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst
@@ -2176,7 +2176,7 @@ Porting to Python 3.10
   ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API.
   (Contributed by Victor Stinner in :issue:`42157`.)
 
-* :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`!Py_GetExecPrefix`,
+* :c:func:`!Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`!Py_GetExecPrefix`,
   :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
   :c:func:`!Py_GetProgramName` functions now return ``NULL`` if called before
   :c:func:`Py_Initialize` (before Python is initialized). Use the new
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
@@ -2479,7 +2479,7 @@ Deprecated C APIs
     Clear :data:`sys.warnoptions` and :data:`!warnings.filters` instead.
   * :c:func:`!Py_GetExecPrefix`:
     Get :data:`sys.exec_prefix` instead.
-  * :c:func:`Py_GetPath`:
+  * :c:func:`!Py_GetPath`:
     Get :data:`sys.path` instead.
   * :c:func:`Py_GetPrefix`:
     Get :data:`sys.prefix` instead.
diff --git a/Doc/whatsnew/3.15.rst b/Doc/whatsnew/3.15.rst
@@ -161,6 +161,9 @@ Removed C APIs
   Use :c:func:`PyConfig_Get("exec_prefix") <PyConfig_Get>`
   (:data:`sys.exec_prefix`) if :ref:`virtual environments <venv-def>`
   need to be handled.
+* :c:func:`!Py_GetPath`:
+  use :c:func:`PyConfig_Get("module_search_paths") <PyConfig_Get>`
+  (:data:`sys.path`) instead.
 * :c:func:`!Py_GetProgramName`:
   use :c:func:`PyConfig_Get("executable") <PyConfig_Get>`
   (:data:`sys.executable`) instead.
diff --git a/Include/pylifecycle.h b/Include/pylifecycle.h
@@ -41,7 +41,6 @@ Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPythonHome(void);
 
 Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetProgramFullPath(void);
 Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPrefix(void);
-Py_DEPRECATED(3.13) PyAPI_FUNC(wchar_t *) Py_GetPath(void);
 #ifdef MS_WINDOWS
 int _Py_CheckPython3(void);
 #endif
diff --git a/Lib/test/test_embed.py b/Lib/test/test_embed.py
@@ -1708,7 +1708,6 @@ def test_getpath_abspath_win32(self):
     def test_global_pathconfig(self):
         # Test C API functions getting the path configuration:
         #
-        # - Py_GetPath()
         # - Py_GetPrefix()
         # - Py_GetProgramFullPath()
         # - Py_GetPythonHome()
@@ -1723,15 +1722,12 @@ def get_func(name):
             func.restype = ctypes.c_wchar_p
             return func
 
-        Py_GetPath = get_func('Py_GetPath')
         Py_GetPrefix = get_func('Py_GetPrefix')
         Py_GetProgramFullPath = get_func('Py_GetProgramFullPath')
         Py_GetPythonHome = get_func('Py_GetPythonHome')
 
         config = _testinternalcapi.get_configs()['config']
 
-        self.assertEqual(tuple(Py_GetPath().split(os.path.pathsep)),
-                         config['module_search_paths'])
         self.assertEqual(Py_GetPrefix(), config['prefix'])
         self.assertEqual(Py_GetProgramFullPath(), config['executable'])
         self.assertEqual(Py_GetPythonHome(), config['home'])
diff --git a/Lib/test/test_inspect/test_inspect.py b/Lib/test/test_inspect/test_inspect.py
@@ -6146,12 +6146,14 @@ def spawn_repl(self, *args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **
         object.
         """
 
+        # TODO(picnixz): refactor this as it's used by test_repl.py
+
         # To run the REPL without using a terminal, spawn python with the command
         # line option '-i' and the process name set to '<stdin>'.
         # The directory of argv[0] must match the directory of the Python
         # executable for the Popen() call to python to succeed as the directory
-        # path may be used by Py_GetPath() to build the default module search
-        # path.
+        # path may be used by PyConfig_Get("module_search_paths") to build the
+        # default module search path.
         stdin_fname = os.path.join(os.path.dirname(sys.executable), "<stdin>")
         cmd_line = [stdin_fname, '-E', '-i']
         cmd_line.extend(args)
diff --git a/Lib/test/test_repl.py b/Lib/test/test_repl.py
@@ -38,8 +38,8 @@ def spawn_repl(*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw):
     # line option '-i' and the process name set to '<stdin>'.
     # The directory of argv[0] must match the directory of the Python
     # executable for the Popen() call to python to succeed as the directory
-    # path may be used by Py_GetPath() to build the default module search
-    # path.
+    # path may be used by PyConfig_Get("module_search_paths") to build the
+    # default module search path.
     stdin_fname = os.path.join(os.path.dirname(sys.executable), "<stdin>")
     cmd_line = [stdin_fname, '-I', '-i']
     cmd_line.extend(args)
diff --git a/Lib/test/test_stable_abi_ctypes.py b/Lib/test/test_stable_abi_ctypes.py
diff --git a/Misc/NEWS.d/3.10.0a3.rst b/Misc/NEWS.d/3.10.0a3.rst
@@ -1395,7 +1395,7 @@ but now can get the condition by calling the new private
 .. nonce: -Br3Co
 .. section: C API
 
-:c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`!Py_GetExecPrefix`,
+:c:func:`!Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`!Py_GetExecPrefix`,
 :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
 :c:func:`!Py_GetProgramName` functions now return ``NULL`` if called before
 :c:func:`Py_Initialize` (before Python is initialized). Use the new
diff --git a/Misc/NEWS.d/3.13.0a1.rst b/Misc/NEWS.d/3.13.0a1.rst
@@ -6594,7 +6594,7 @@ Deprecate old Python initialization functions:
 
 * :c:func:`PySys_ResetWarnOptions`
 * :c:func:`!Py_GetExecPrefix`
-* :c:func:`Py_GetPath`
+* :c:func:`!Py_GetPath`
 * :c:func:`Py_GetPrefix`
 * :c:func:`Py_GetProgramFullPath`
 * :c:func:`!Py_GetProgramName`
diff --git a/Misc/stable_abi.toml b/Misc/stable_abi.toml
@@ -1630,8 +1630,6 @@
     added = '3.2'
 [function.Py_GetCopyright]
     added = '3.2'
-[function.Py_GetPath]
-    added = '3.2'
 [function.Py_GetPlatform]
     added = '3.2'
 [function.Py_GetPrefix]
diff --git a/PC/python3dll.c b/PC/python3dll.c
diff --git a/Python/pathconfig.c b/Python/pathconfig.c
@@ -272,18 +272,6 @@ Py_SetProgramName(const wchar_t *program_name)
 }
 
 
-wchar_t *
-Py_GetPath(void)
-{
-    /* If the user has provided a path, return that */
-    if (_Py_path_config.module_search_path) {
-        return _Py_path_config.module_search_path;
-    }
-    /* If we have already done calculations, return the calculated path */
-    return _Py_path_config.calculated_module_search_path;
-}
-
-
 wchar_t *
 _Py_GetStdlibDir(void)
 {
