[issue11670] configparser read_file now iterates over f, docs still say it calls readline
New submission from Larry Hastings <larry@hastings.org>: The documentation for configparser.RawConfigParser.read_file() states: "Read and parse configuration data from the file or file-like object in f (only the readline() method is used)." This was true in Python 3.1 and before. However in 3.2 the implementation of read_file changed. It no longer calls readline(). Instead, it iterates over the file object. Whoever made this change neglected to * fix the docs, or apparently * tell anybody. I've got the commit bit, so I'd be happy to fix this. I'd like to add it to the What's New In Python 3.2 as well; there's a section about configparser changes that would be perfect. Is it permissible to change the What's New document ex post facto like this? (Adding rhettinger so he can answer this.) ---------- assignee: docs@python components: Documentation messages: 132075 nosy: docs@python, larry, rhettinger priority: low severity: normal stage: needs patch status: open title: configparser read_file now iterates over f, docs still say it calls readline type: behavior versions: Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Larry Hastings <larry@hastings.org> added the comment: By the same token, readfp is now deprecate in favor of the new spelling read_file. That change *is* mentioned in configparser. If I'm touching What's New In Python 3.2, mind if I add a mention of that too? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: I don't think this is worthy of being in whatsnew. Feel free to update the other docs though. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- assignee: docs@python -> lukasz.langa nosy: +lukasz.langa versions: +Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Łukasz Langa <lukasz@langa.pl> added the comment: Ouch, this would be my fault. I agree with Raymond, at this point I think we should only update the docs. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Łukasz Langa <lukasz@langa.pl> added the comment: How about this? (available for review: http://codereview.appspot.com/4358054) ---------- keywords: +patch Added file: http://bugs.python.org/file21547/issue11670.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Roundup Robot <devnull@devnull> added the comment: New changeset 6f937d6369b6 by Łukasz Langa in branch '3.2': Closes #11670: configparser read_file now iterates over f. http://hg.python.org/cpython/rev/6f937d6369b6 New changeset 9da06f771a57 by Łukasz Langa in branch 'default': Merged #11670 from 3.2 http://hg.python.org/cpython/rev/9da06f771a57 ---------- nosy: +python-dev resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Łukasz Langa <lukasz@langa.pl> added the comment: Closed in http://hg.python.org/cpython/rev/6f937d6369b6. ---------- resolution: fixed -> accepted _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Roundup Robot <devnull@devnull> added the comment: New changeset 1bbda00bbe78 by Łukasz Langa in branch '3.2': Style updates for the #11670 solution after post-commit review by Ezio Melotti: http://hg.python.org/cpython/rev/1bbda00bbe78 New changeset 339cd1d9b21a by Łukasz Langa in branch 'default': Merged styling updates for #11670 from 3.2. http://hg.python.org/cpython/rev/339cd1d9b21a ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
Roundup Robot added the comment: New changeset e70882558a96 by Martin Panter in branch '3.5': Issue #11670: readfp(fp) parameter name is different to read_file(f) https://hg.python.org/cpython/rev/e70882558a96 New changeset e06de6f9cfe5 by Martin Panter in branch '3.6': Issues #11670: Merge configparser doc from 3.5 https://hg.python.org/cpython/rev/e06de6f9cfe5 New changeset 6db0a62b6aa6 by Martin Panter in branch 'default': Issues #11670: Merge configparser doc from 3.6 https://hg.python.org/cpython/rev/6db0a62b6aa6 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11670> _______________________________________
participants (5)
-
Larry Hastings -
Raymond Hettinger
-
Roundup Robot
-
Éric Araujo
-
Łukasz Langa