diff options
author | Ezio Melotti <ezio.melotti@gmail.com> | 2013-04-15 16:08:31 (GMT) |
---|---|---|
committer | Ezio Melotti <ezio.melotti@gmail.com> | 2013-04-15 16:08:31 (GMT) |
commit | 1b3320659667b688a3d5740d04e4b7480a09fcc3 (patch) | |
tree | d5d576f139c373161576a531f640c33d72503ce0 /Doc/tutorial | |
parent | 12ec99d8522ebb53d9afd96421fefb38cfdca749 (diff) | |
download | cpython-1b3320659667b688a3d5740d04e4b7480a09fcc3.zip cpython-1b3320659667b688a3d5740d04e4b7480a09fcc3.tar.gz cpython-1b3320659667b688a3d5740d04e4b7480a09fcc3.tar.bz2 |
#13510: clarify that f.readlines() is note necessary to iterate over a file. Patch by Dan Riti.
Diffstat (limited to 'Doc/tutorial')
-rw-r--r-- | Doc/tutorial/inputoutput.rst | 19 |
1 files changed, 4 insertions, 15 deletions
diff --git a/Doc/tutorial/inputoutput.rst b/Doc/tutorial/inputoutput.rst index 2f08110..b1611f2 100644 --- a/Doc/tutorial/inputoutput.rst +++ b/Doc/tutorial/inputoutput.rst @@ -295,18 +295,8 @@ containing only a single newline. :: >>> f.readline() '' -``f.readlines()`` returns a list containing all the lines of data in the file. -If given an optional parameter *sizehint*, it reads that many bytes from the -file and enough more to complete a line, and returns the lines from that. This -is often used to allow efficient reading of a large file by lines, but without -having to load the entire file in memory. Only complete lines will be returned. -:: - - >>> f.readlines() - ['This is the first line of the file.\n', 'Second line of the file\n'] - -An alternative approach to reading lines is to loop over the file object. This is -memory efficient, fast, and leads to simpler code:: +For reading lines from a file, you can loop over the file object. This is memory +efficient, fast, and leads to simple code:: >>> for line in f: print line, @@ -314,9 +304,8 @@ memory efficient, fast, and leads to simpler code:: This is the first line of the file. Second line of the file -The alternative approach is simpler but does not provide as fine-grained -control. Since the two approaches manage line buffering differently, they -should not be mixed. +If you want to read all the lines of a file in a list you can also use +``list(f)`` or ``f.readlines()``. ``f.write(string)`` writes the contents of *string* to the file, returning ``None``. :: |