Outdated C api doc about Windows error

[zhangyangyu]

BPO	29045
Nosy	@pfmoore, @tjguk, @zware, @eryksun, @zooba, @zhangyangyu

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2016-12-22.06:06:20.650>
labels = ['3.8', '3.9', '3.10', 'type-feature', 'OS-windows', 'docs']
title = 'Outdated C api doc about Windows error'
updated_at = <Date 2021-02-26.20:45:06.637>
user = 'https://github.com/zhangyangyu'

bugs.python.org fields:

activity = <Date 2021-02-26.20:45:06.637>
actor = 'eryksun'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'Windows']
creation = <Date 2016-12-22.06:06:20.650>
creator = 'xiang.zhang'
dependencies = []
files = []
hgrepos = []
issue_num = 29045
keywords = []
message_count = 4.0
messages = ['283814', '283816', '283818', '387746']
nosy_count = 7.0
nosy_names = ['paul.moore', 'tim.golden', 'docs@python', 'zach.ware', 'eryksun', 'steve.dower', 'xiang.zhang']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue29045'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Linked PRs

• gh-73231: Update documentation for PyErr_SetFromWindowsErr() #117226
• [3.12] gh-73231: Update documentation for PyErr_SetFromWindowsErr() (GH-117226) #117973

[zhangyangyu]

https://docs.python.org/3.7/c-api/exceptions.html#c.PyErr_SetFromWindowsErrWithFilename it stills refers to PyErr_SetFromWindowsErrWithFilenameObject but this function doesn't exist since Py3.4. I didn't find when and why it's deleted.

And https://docs.python.org/3.4/c-api/exceptions.html#c.PyErr_SetFromWindowsErr raises OSError instead of WindowsError.

[eryksun]

PyErr_SetFromWindowsErrWithFilenameObject was never implemented. See bpo-11210.

Since 3.3 WindowsError is simply an alias for OSError. See PEP-3151.

[zhangyangyu]

PyErr_SetFromWindowsErrWithFilenameObject was never implemented. See bpo-11210.

Since 3.3 WindowsError is simply an alias for OSError. See PEP-3151.

Ohh, thanks for the info. I don't find the implementation in 2.7 either.

[eryksun]

The documentation still has two references to PyErr_SetFromWindowsErrWithFilenameObject, which is not a defined function in the C API.

https://docs.python.org/3.10/c-api/exceptions.html#c.PyErr_SetFromWindowsErrWithFilename

[serhiy-storchaka]

The first issue was fixed in gh-107298.

[serhiy-storchaka]

#117226 updates the documentation that referred to WindowsError.