https://github.com/python/cpython/commit/438b7c3071eebaccd1ba215f15a239345b22f813
commit: 438b7c3071eebaccd1ba215f15a239345b22f813
branch: main
author: Serhiy Storchaka <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-04-17T13:03:26+03:00
summary:
gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226)
files:
M Doc/c-api/exceptions.rst
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index ba13fd1b9973e0..d5c25a68c47bd6 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -221,13 +221,14 @@ For convenience, some of these functions will always
return a
.. c:function:: PyObject* PyErr_SetFromWindowsErr(int ierr)
- This is a convenience function to raise :exc:`WindowsError`. If called with
+ This is a convenience function to raise :exc:`OSError`. If called with
*ierr* of ``0``, the error code returned by a call to
:c:func:`!GetLastError`
is used instead. It calls the Win32 function :c:func:`!FormatMessage` to
retrieve
the Windows description of error code given by *ierr* or
:c:func:`!GetLastError`,
- then it constructs a tuple object whose first item is the *ierr* value and
whose
- second item is the corresponding error message (gotten from
- :c:func:`!FormatMessage`), and then calls
``PyErr_SetObject(PyExc_WindowsError,
+ then it constructs a :exc:`OSError` object with the
:attr:`~OSError.winerror`
+ attribute set to the error code, the :attr:`~OSError.strerror` attribute
+ set to the corresponding error message (gotten from
+ :c:func:`!FormatMessage`), and then calls ``PyErr_SetObject(PyExc_OSError,
object)``. This function always returns ``NULL``.
.. availability:: Windows.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
