PyIter_Next documentation inconsistent with implementation

[garcia]

BPO	4897
Nosy	@benjaminp
Superseder	bpo-3720: segfault in for loop with evil iterator

^{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 = <Date 2009-01-09.17:38:08.849>
created_at = <Date 2009-01-09.14:52:15.287>
labels = ['type-bug']
title = 'PyIter_Next documentation inconsistent with implementation'
updated_at = <Date 2009-01-09.19:00:57.581>
user = 'https://bugs.python.org/garcia'

bugs.python.org fields:

activity = <Date 2009-01-09.19:00:57.581>
actor = 'benjamin.peterson'
assignee = 'none'
closed = True
closed_date = <Date 2009-01-09.17:38:08.849>
closer = 'benjamin.peterson'
components = ['None']
creation = <Date 2009-01-09.14:52:15.287>
creator = 'garcia'
dependencies = []
files = []
hgrepos = []
issue_num = 4897
keywords = []
message_count = 4.0
messages = ['79472', '79481', '79488', '79489']
nosy_count = 2.0
nosy_names = ['benjamin.peterson', 'garcia']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = None
status = 'closed'
superseder = '3720'
type = 'behavior'
url = 'https://bugs.python.org/issue4897'
versions = ['Python 2.5']

[garcia]

The documentation for PyIter_Next says it will raise TypeError if the
object passed to it is not an iterator. However, the implementation in
abstract.c performs an assert rather than raising TypeError. I would
prefer if the implementation were adjusted to match the documentation
rather than vice-versa.

[benjaminp]

Closing a duplicate of bpo-3720.

[garcia]

Thanks for the quick response. I see that the discussion in 3720
implicitly involves the implementation of PyIter_Next, but the
documentation for PyIter_Next (and its conflict with the implementation)
is not mentioned.

[benjaminp]

The reason I linked to that issue is that the proposed patch brings the
implementation inline with the documentation as you wished. :)