The current documentation says it returns None if the name is not fou…

…nd, but (GH-26785) (GH-27372) the implementation uses [] and will raise KeyError instead. Noticed by @srittau in python/typeshed@5659. (cherry picked from commit f22737a) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
python · Jul 26, 2021 · 3f13894 · 3f13894
1 parent 7482fff
commit 3f13894
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/Doc/library/sysconfig.rst b/Doc/library/sysconfig.rst
@@ -138,7 +138,7 @@ identifier.  Python currently uses eight paths:
    If *expand* is set to ``False``, the path will not be expanded using the
    variables.
 
-   If *name* is not found, return ``None``.
+   If *name* is not found, raise a :exc:`KeyError`.
 
 
 .. function:: get_paths([scheme, [vars, [expand]]])

diff --git a/Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst b/Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst
@@ -0,0 +1 @@
+Fix documentation for the return type of :func:`sysconfig.get_path`.