Issue 7508: Update 'file object' doc (original) (raw)

Issue7508

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/51757

classification

Title: Update 'file object' doc
Type: Stage:
Components: Documentation Versions: Python 3.1, Python 3.2

process

Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: pitrou Nosy List: georg.brandl, pitrou, terry.reedy
Priority: normal Keywords:

Created on 2009-12-15 04:43 by terry.reedy, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (6)
msg96419 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2009-12-15 04:43
"5.9. File Objects¶ File objects are implemented using C’s stdio package and can be created with the built-in open() function." As I understand, the part about stdio is no longer true. Also, as I understand, there is no longer a class object. Rather there are various io (or _io) classes returned by open depending on the args, especially the mode. This should be made clear. Something like "File objects are created by the built-in open function and others. There are instances of various classes exposed in the io module. The following discusses the methods common to various file objects." Maybe even retitle the section "IO objects" and use 'io' instead of 'file' as the prefix for method names. Maybe whoever wrote the new io system could check this section for accuracy.
msg96617 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-12-19 17:19
Maybe Antoine wants (!) to look at it.
msg96624 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2009-12-19 17:49
In which part/filename of the doc can I find this extract?
msg96626 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2009-12-19 17:53
Okay, I've found it. IMO this section should simply be removed, since the `file` type doesn't exist anymore.
msg96629 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2009-12-19 18:01
Note: one issue is that io.rst is currently some kind of technical reference about base classes and stuff, it is unreadable for anyone looking for simple information.
msg96636 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2009-12-19 18:23
I've removed it in r76893. Thanks!
History
Date User Action Args
2022-04-11 14:56:55 admin set github: 51757
2009-12-21 21:55:33 flox link issue7557 superseder
2009-12-19 18:23:35 pitrou set status: open -> closedresolution: fixedmessages: +
2009-12-19 18:01:08 pitrou set messages: +
2009-12-19 17:53:08 pitrou set messages: +
2009-12-19 17:49:17 pitrou set messages: +
2009-12-19 17:19:48 georg.brandl set assignee: georg.brandl -> pitroumessages: + nosy: + pitrou
2009-12-15 04:43:42 terry.reedy create