cpython-lru_cache-weakref: Lib/

annotate Lib/_pyio.py @ 79691:05c8928362ee

Merge __next__ method link fixes with 3.3.

author	Ezio Melotti <ezio.melotti@gmail.com>
date	Fri, 12 Oct 2012 13:46:37 +0300
parents	fcf097cb5f6b
children	b0602a1eb3f6 47f98a550d42

rev	line source
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2 Python implementation of the io module.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	3 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	4
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	5 import os
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	6 import abc
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	7 import codecs
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	8 import errno
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	9 # Import _thread instead of threading to reduce startup cost
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	10 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	11 from _thread import allocate_lock as Lock
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	12 except ImportError:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	13 from _dummy_thread import allocate_lock as Lock
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	14
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	15 import io
61026 3b6979055f5a Merged revisions 80548-80549 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 61020 diff changeset	16 from io import (__all__, SEEK_SET, SEEK_CUR, SEEK_END)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	17
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	18 valid_seek_flags = {0, 1, 2} # Hardwired values
de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	19 if hasattr(os, 'SEEK_HOLE') :
de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	20 valid_seek_flags.add(os.SEEK_HOLE)
de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	21 valid_seek_flags.add(os.SEEK_DATA)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	22
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	23 # open() uses st_blksize whenever we can
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	24 DEFAULT_BUFFER_SIZE = 8 * 1024 # bytes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	25
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	26 # NOTE: Base classes defined here are registered with the "official" ABCs
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	27 # defined in io.py. We don't use real inheritance though, because we don't
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	28 # want to inherit the C implementations.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	29
72879 41a1de81ef2b PEP 3151 / issue #12555: reworking the OS and IO exception hierarchy. Antoine Pitrou <solipsis@pitrou.net> parents: 71483 diff changeset	30 # Rebind for compatibility
41a1de81ef2b PEP 3151 / issue #12555: reworking the OS and IO exception hierarchy. Antoine Pitrou <solipsis@pitrou.net> parents: 71483 diff changeset	31 BlockingIOError = BlockingIOError
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	32
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	33
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	34 def open(file, mode="r", buffering=-1, encoding=None, errors=None,
73261 0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	35 newline=None, closefd=True, opener=None):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	36
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	37 r"""Open file and return a stream. Raise IOError upon failure.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	38
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	39 file is either a text or byte string giving the name (and the path
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	40 if the file isn't in the current working directory) of the file to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	41 be opened or an integer file descriptor of the file to be
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	42 wrapped. (If a file descriptor is given, it is closed when the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	43 returned I/O object is closed, unless closefd is set to False.)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	44
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	45 mode is an optional string that specifies the mode in which the file is
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	46 opened. It defaults to 'r' which means open for reading in text mode. Other
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	47 common values are 'w' for writing (truncating the file if it already
74384 8bcbe2dc3835 Issue #12760: Refer to the new 'x' open mode as "exclusive creation" mode. Charles-François Natali <neologix@free.fr> parents: 74315 diff changeset	48 exists), 'x' for exclusive creation of a new file, and 'a' for appending
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	49 (which on some Unix systems, means that all writes append to the end of the
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	50 file regardless of the current seek position). In text mode, if encoding is
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	51 not specified the encoding used is platform dependent. (For reading and
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	52 writing raw bytes use binary mode and leave encoding unspecified.) The
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	53 available modes are:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	54
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	55 ========= ===============================================================
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	56 Character Meaning
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	57 --------- ---------------------------------------------------------------
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	58 'r' open for reading (default)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	59 'w' open for writing, truncating the file first
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	60 'x' create a new file and open it for writing
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	61 'a' open for writing, appending to the end of the file if it exists
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	62 'b' binary mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	63 't' text mode (default)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	64 '+' open a disk file for updating (reading and writing)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	65 'U' universal newline mode (for backwards compatibility; unneeded
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	66 for new code)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	67 ========= ===============================================================
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	68
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	69 The default mode is 'rt' (open for reading text). For binary random
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	70 access, the mode 'w+b' opens and truncates the file to 0 bytes, while
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	71 'r+b' opens the file without truncation. The 'x' mode implies 'w' and
bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	72 raises an `FileExistsError` if the file already exists.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	73
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	74 Python distinguishes between files opened in binary and text modes,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	75 even when the underlying operating system doesn't. Files opened in
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	76 binary mode (appending 'b' to the mode argument) return contents as
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	77 bytes objects without any decoding. In text mode (the default, or when
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	78 't' is appended to the mode argument), the contents of the file are
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	79 returned as strings, the bytes having been first decoded using a
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	80 platform-dependent encoding or using the specified encoding if given.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	81
57792 6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	82 buffering is an optional integer used to set the buffering policy.
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	83 Pass 0 to switch buffering off (only allowed in binary mode), 1 to select
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	84 line buffering (only usable in text mode), and an integer > 1 to indicate
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	85 the size of a fixed-size chunk buffer. When no buffering argument is
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	86 given, the default buffering policy works as follows:
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	87
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	88 * Binary files are buffered in fixed-size chunks; the size of the buffer
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	89 is chosen using a heuristic trying to determine the underlying device's
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	90 "block size" and falling back on `io.DEFAULT_BUFFER_SIZE`.
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	91 On many systems, the buffer will typically be 4096 or 8192 bytes long.
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	92
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	93 * "Interactive" text files (files for which isatty() returns True)
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	94 use line buffering. Other text files use the policy described above
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	95 for binary files.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	96
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	97 encoding is the str name of the encoding used to decode or encode the
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	98 file. This should only be used in text mode. The default encoding is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	99 platform dependent, but any encoding supported by Python can be
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	100 passed. See the codecs module for the list of supported encodings.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	101
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	102 errors is an optional string that specifies how encoding errors are to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	103 be handled---this argument should not be used in binary mode. Pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	104 'strict' to raise a ValueError exception if there is an encoding error
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	105 (the default of None has the same effect), or pass 'ignore' to ignore
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	106 errors. (Note that ignoring encoding errors can lead to data loss.)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	107 See the documentation for codecs.register for a list of the permitted
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	108 encoding error strings.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	109
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	110 newline is a string controlling how universal newlines works (it only
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	111 applies to text mode). It can be None, '', '\n', '\r', and '\r\n'. It works
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	112 as follows:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	113
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	114 * On input, if newline is None, universal newlines mode is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	115 enabled. Lines in the input can end in '\n', '\r', or '\r\n', and
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	116 these are translated into '\n' before being returned to the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	117 caller. If it is '', universal newline mode is enabled, but line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	118 endings are returned to the caller untranslated. If it has any of
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	119 the other legal values, input lines are only terminated by the given
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	120 string, and the line ending is returned to the caller untranslated.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	121
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	122 * On output, if newline is None, any '\n' characters written are
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	123 translated to the system default line separator, os.linesep. If
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	124 newline is '', no translation takes place. If newline is any of the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	125 other legal values, any '\n' characters written are translated to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	126 the given string.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	127
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	128 closedfd is a bool. If closefd is False, the underlying file descriptor will
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	129 be kept open when the file is closed. This does not work when a file name is
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	130 given and must be True in that case.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	131
73261 0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	132 A custom opener can be used by passing a callable as opener. The
0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	133 underlying file descriptor for the file object is then obtained by calling
0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	134 opener with (file, flags). opener must return an open file
0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	135 descriptor (passing os.open as opener results in functionality similar to
0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	136 passing None).
0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	137
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	138 open() returns a file object whose type depends on the mode, and
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	139 through which the standard file operations such as reading and writing
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	140 are performed. When open() is used to open a file in a text mode ('w',
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	141 'r', 'wt', 'rt', etc.), it returns a TextIOWrapper. When used to open
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	142 a file in a binary mode, the returned class varies: in read binary
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	143 mode, it returns a BufferedReader; in write binary and append binary
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	144 modes, it returns a BufferedWriter, and in read/write mode, it returns
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	145 a BufferedRandom.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	146
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	147 It is also possible to use a string or bytearray as a file for both
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	148 reading and writing. For strings StringIO can be used like a file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	149 opened in a text mode, and for bytes a BytesIO can be used like a file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	150 opened in a binary mode.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	151 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	152 if not isinstance(file, (str, bytes, int)):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	153 raise TypeError("invalid file: %r" % file)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	154 if not isinstance(mode, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	155 raise TypeError("invalid mode: %r" % mode)
61020 3691d75b0626 Merged revisions 80544 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 59588 diff changeset	156 if not isinstance(buffering, int):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	157 raise TypeError("invalid buffering: %r" % buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	158 if encoding is not None and not isinstance(encoding, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	159 raise TypeError("invalid encoding: %r" % encoding)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	160 if errors is not None and not isinstance(errors, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	161 raise TypeError("invalid errors: %r" % errors)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	162 modes = set(mode)
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	163 if modes - set("axrwb+tU") or len(mode) > len(modes):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	164 raise ValueError("invalid mode: %r" % mode)
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	165 creating = "x" in modes
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	166 reading = "r" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	167 writing = "w" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	168 appending = "a" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	169 updating = "+" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	170 text = "t" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	171 binary = "b" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	172 if "U" in modes:
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	173 if creating or writing or appending:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	174 raise ValueError("can't use U and writing mode at once")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	175 reading = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	176 if text and binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	177 raise ValueError("can't have text and binary mode at once")
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	178 if creating + reading + writing + appending > 1:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	179 raise ValueError("can't have read/write/append mode at once")
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	180 if not (creating or reading or writing or appending):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	181 raise ValueError("must have exactly one of read/write/append mode")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	182 if binary and encoding is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	183 raise ValueError("binary mode doesn't take an encoding argument")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	184 if binary and errors is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	185 raise ValueError("binary mode doesn't take an errors argument")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	186 if binary and newline is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	187 raise ValueError("binary mode doesn't take a newline argument")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	188 raw = FileIO(file,
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	189 (creating and "x" or "") +
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	190 (reading and "r" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	191 (writing and "w" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	192 (appending and "a" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	193 (updating and "+" or ""),
73261 0d64d9ac2b78 Issue #12797: Added custom opener parameter to builtin open() and FileIO.open(). Ross Lagerwall <rosslagerwall@gmail.com> parents: 73085 diff changeset	194 closefd, opener=opener)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	195 line_buffering = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	196 if buffering == 1 or buffering < 0 and raw.isatty():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	197 buffering = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	198 line_buffering = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	199 if buffering < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	200 buffering = DEFAULT_BUFFER_SIZE
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	201 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	202 bs = os.fstat(raw.fileno()).st_blksize
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	203 except (os.error, AttributeError):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	204 pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	205 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	206 if bs > 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	207 buffering = bs
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	208 if buffering < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	209 raise ValueError("invalid buffering size")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	210 if buffering == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	211 if binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	212 return raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	213 raise ValueError("can't have unbuffered text I/O")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	214 if updating:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	215 buffer = BufferedRandom(raw, buffering)
74315 bf609baff4d3 Issue #12760: Add a create mode to open(). Patch by David Townshend. Charles-François Natali <neologix@free.fr> parents: 73666 diff changeset	216 elif creating or writing or appending:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	217 buffer = BufferedWriter(raw, buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	218 elif reading:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	219 buffer = BufferedReader(raw, buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	220 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	221 raise ValueError("unknown mode: %r" % mode)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	222 if binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	223 return buffer
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	224 text = TextIOWrapper(buffer, encoding, errors, newline, line_buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	225 text.mode = mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	226 return text
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	227
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	228
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	229 class DocDescriptor:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	230 """Helper for builtins.open.__doc__
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	231 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	232 def __get__(self, obj, typ):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	233 return (
61026 3b6979055f5a Merged revisions 80548-80549 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 61020 diff changeset	234 "open(file, mode='r', buffering=-1, encoding=None, "
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	235 "errors=None, newline=None, closefd=True)\n\n" +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	236 open.__doc__)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	237
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	238 class OpenWrapper:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	239 """Wrapper for builtins.open
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	240
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	241 Trick so that open won't become a bound method when stored
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	242 as a class variable (as dbm.dumb does).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	243
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	244 See initstdio() in Python/pythonrun.c.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	245 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	246 __doc__ = DocDescriptor()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	247
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	248 def __new__(cls, args, *kwargs):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	249 return open(args, *kwargs)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	250
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	251
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	252 # In normal operation, both `UnsupportedOperation`s should be bound to the
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	253 # same object.
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	254 try:
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	255 UnsupportedOperation = io.UnsupportedOperation
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	256 except AttributeError:
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	257 class UnsupportedOperation(ValueError, IOError):
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	258 pass
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	259
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	260
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	261 class IOBase(metaclass=abc.ABCMeta):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	262
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	263 """The abstract base class for all I/O classes, acting on streams of
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	264 bytes. There is no public constructor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	265
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	266 This class provides dummy implementations for many methods that
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	267 derived classes can override selectively; the default implementations
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	268 represent a file that cannot be read, written or seeked.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	269
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	270 Even though IOBase does not declare read, readinto, or write because
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	271 their signatures will vary, implementations and clients should
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	272 consider those methods part of the interface. Also, implementations
64507 5678759a8009 More docstring updates Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64506 diff changeset	273 may raise UnsupportedOperation when operations they do not support are
5678759a8009 More docstring updates Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64506 diff changeset	274 called.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	275
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	276 The basic type used for binary data read from or written to a file is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	277 bytes. bytearrays are accepted too, and in some cases (such as
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	278 readinto) needed. Text I/O classes work with str data.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	279
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	280 Note that calling any method (even inquiries) on a closed stream is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	281 undefined. Implementations may raise IOError in this case.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	282
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	283 IOBase (and its subclasses) support the iterator protocol, meaning
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	284 that an IOBase object can be iterated over yielding the lines in a
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	285 stream.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	286
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	287 IOBase also supports the :keyword:`with` statement. In this example,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	288 fp is closed after the suite of the with statement is complete:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	289
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	290 with open('spam.txt', 'r') as fp:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	291 fp.write('Spam and eggs!')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	292 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	293
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	294 ### Internal ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	295
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	296 def _unsupported(self, name):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	297 """Internal: raise an IOError exception for unsupported operations."""
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	298 raise UnsupportedOperation("%s.%s() not supported" %
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	299 (self.__class__.__name__, name))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	300
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	301 ### Positioning ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	302
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	303 def seek(self, pos, whence=0):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	304 """Change stream position.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	305
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	306 Change the stream position to byte offset offset. offset is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	307 interpreted relative to the position indicated by whence. Values
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	308 for whence are ints:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	309
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	310 * 0 -- start of stream (the default); offset should be zero or positive
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	311 * 1 -- current stream position; offset may be negative
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	312 * 2 -- end of stream; offset is usually negative
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	313 Some operating systems / file systems could provide additional values.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	314
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	315 Return an int indicating the new absolute position.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	316 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	317 self._unsupported("seek")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	318
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	319 def tell(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	320 """Return an int indicating the current stream position."""
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	321 return self.seek(0, 1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	322
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	323 def truncate(self, pos=None):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	324 """Truncate file to size bytes.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	325
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	326 Size defaults to the current IO position as reported by tell(). Return
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	327 the new size.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	328 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	329 self._unsupported("truncate")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	330
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	331 ### Flush and close ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	332
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	333 def flush(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	334 """Flush write buffers, if applicable.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	335
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	336 This is not implemented for read-only and non-blocking streams.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	337 """
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	338 self._checkClosed()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	339 # XXX Should this return the number of bytes written???
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	340
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	341 __closed = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	342
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	343 def close(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	344 """Flush and close the IO object.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	345
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	346 This method has no effect if the file is already closed.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	347 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	348 if not self.__closed:
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	349 self.flush()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	350 self.__closed = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	351
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	352 def __del__(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	353 """Destructor. Calls close()."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	354 # The try/except block is in case this is called at program
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	355 # exit time, when it's possible that globals have already been
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	356 # deleted, and then the close() call might fail. Since
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	357 # there's nothing we can do about such failures and they annoy
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	358 # the end users, we suppress the traceback.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	359 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	360 self.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	361 except:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	362 pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	363
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	364 ### Inquiries ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	365
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	366 def seekable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	367 """Return a bool indicating whether object supports random access.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	368
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	369 If False, seek(), tell() and truncate() will raise UnsupportedOperation.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	370 This method may need to do a test seek().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	371 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	372 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	373
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	374 def _checkSeekable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	375 """Internal: raise UnsupportedOperation if file is not seekable
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	376 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	377 if not self.seekable():
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	378 raise UnsupportedOperation("File or stream is not seekable."
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	379 if msg is None else msg)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	380
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	381 def readable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	382 """Return a bool indicating whether object was opened for reading.
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	383
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	384 If False, read() will raise UnsupportedOperation.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	385 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	386 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	387
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	388 def _checkReadable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	389 """Internal: raise UnsupportedOperation if file is not readable
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	390 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	391 if not self.readable():
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	392 raise UnsupportedOperation("File or stream is not readable."
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	393 if msg is None else msg)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	394
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	395 def writable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	396 """Return a bool indicating whether object was opened for writing.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	397
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	398 If False, write() and truncate() will raise UnsupportedOperation.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	399 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	400 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	401
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	402 def _checkWritable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	403 """Internal: raise UnsupportedOperation if file is not writable
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	404 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	405 if not self.writable():
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	406 raise UnsupportedOperation("File or stream is not writable."
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	407 if msg is None else msg)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	408
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	409 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	410 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	411 """closed: bool. True iff the file has been closed.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	412
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	413 For backwards compatibility, this is a property, not a predicate.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	414 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	415 return self.__closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	416
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	417 def _checkClosed(self, msg=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	418 """Internal: raise an ValueError if file is closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	419 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	420 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	421 raise ValueError("I/O operation on closed file."
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	422 if msg is None else msg)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	423
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	424 ### Context manager ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	425
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	426 def __enter__(self): # That's a forward reference
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	427 """Context management protocol. Returns self (an instance of IOBase)."""
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	428 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	429 return self
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	430
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	431 def __exit__(self, *args):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	432 """Context management protocol. Calls close()"""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	433 self.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	434
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	435 ### Lower-level APIs ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	436
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	437 # XXX Should these be present even if unimplemented?
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	438
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	439 def fileno(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	440 """Returns underlying file descriptor (an int) if one exists.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	441
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	442 An IOError is raised if the IO object does not use a file descriptor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	443 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	444 self._unsupported("fileno")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	445
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	446 def isatty(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	447 """Return a bool indicating whether this is an 'interactive' stream.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	448
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	449 Return False if it can't be determined.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	450 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	451 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	452 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	453
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	454 ### Readline[s] and writelines ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	455
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	456 def readline(self, limit=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	457 r"""Read and return a line of bytes from the stream.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	458
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	459 If limit is specified, at most limit bytes will be read.
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	460 Limit should be an int.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	461
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	462 The line terminator is always b'\n' for binary files; for text
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	463 files, the newlines argument to open can be used to select the line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	464 terminator(s) recognized.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	465 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	466 # For backwards compatibility, a (slowish) readline().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	467 if hasattr(self, "peek"):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	468 def nreadahead():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	469 readahead = self.peek(1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	470 if not readahead:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	471 return 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	472 n = (readahead.find(b"\n") + 1) or len(readahead)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	473 if limit >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	474 n = min(n, limit)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	475 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	476 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	477 def nreadahead():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	478 return 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	479 if limit is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	480 limit = -1
53367 c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	481 elif not isinstance(limit, int):
c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	482 raise TypeError("limit must be an integer")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	483 res = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	484 while limit < 0 or len(res) < limit:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	485 b = self.read(nreadahead())
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	486 if not b:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	487 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	488 res += b
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	489 if res.endswith(b"\n"):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	490 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	491 return bytes(res)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	492
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	493 def __iter__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	494 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	495 return self
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	496
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	497 def __next__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	498 line = self.readline()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	499 if not line:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	500 raise StopIteration
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	501 return line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	502
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	503 def readlines(self, hint=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	504 """Return a list of lines from the stream.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	505
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	506 hint can be specified to control the number of lines read: no more
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	507 lines will be read if the total size (in bytes/characters) of all
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	508 lines so far exceeds hint.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	509 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	510 if hint is None or hint <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	511 return list(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	512 n = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	513 lines = []
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	514 for line in self:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	515 lines.append(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	516 n += len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	517 if n >= hint:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	518 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	519 return lines
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	520
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	521 def writelines(self, lines):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	522 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	523 for line in lines:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	524 self.write(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	525
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	526 io.IOBase.register(IOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	527
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	528
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	529 class RawIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	530
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	531 """Base class for raw binary I/O."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	532
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	533 # The read() method is implemented by calling readinto(); derived
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	534 # classes that want to support read() only need to implement
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	535 # readinto() as a primitive operation. In general, readinto() can be
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	536 # more efficient than read().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	537
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	538 # (It would be tempting to also provide an implementation of
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	539 # readinto() in terms of read(), in case the latter is a more suitable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	540 # primitive operation, but that would lead to nasty recursion in case
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	541 # a subclass doesn't implement either.)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	542
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	543 def read(self, n=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	544 """Read and return up to n bytes, where n is an int.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	545
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	546 Returns an empty bytes object on EOF, or None if the object is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	547 set not to block and has no data to read.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	548 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	549 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	550 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	551 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	552 return self.readall()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	553 b = bytearray(n.__index__())
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	554 n = self.readinto(b)
64751 071bd8f3535a Merged revisions 84814 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 61183 diff changeset	555 if n is None:
071bd8f3535a Merged revisions 84814 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 61183 diff changeset	556 return None
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	557 del b[n:]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	558 return bytes(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	559
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	560 def readall(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	561 """Read until EOF, using multiple read() call."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	562 res = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	563 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	564 data = self.read(DEFAULT_BUFFER_SIZE)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	565 if not data:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	566 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	567 res += data
70385 4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	568 if res:
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	569 return bytes(res)
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	570 else:
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	571 # b'' or None
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	572 return data
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	573
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	574 def readinto(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	575 """Read up to len(b) bytes into bytearray b.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	576
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	577 Returns an int representing the number of bytes read (0 for EOF), or
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	578 None if the object is set not to block and has no data to read.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	579 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	580 self._unsupported("readinto")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	581
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	582 def write(self, b):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	583 """Write the given buffer to the IO stream.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	584
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	585 Returns the number of bytes written, which may be less than len(b).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	586 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	587 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	588
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	589 io.RawIOBase.register(RawIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	590 from _io import FileIO
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	591 RawIOBase.register(FileIO)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	592
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	593
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	594 class BufferedIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	595
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	596 """Base class for buffered IO objects.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	597
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	598 The main difference with RawIOBase is that the read() method
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	599 supports omitting the size argument, and does not have a default
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	600 implementation that defers to readinto().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	601
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	602 In addition, read(), readinto() and write() may raise
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	603 BlockingIOError if the underlying raw stream is in non-blocking
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	604 mode and not ready; unlike their raw counterparts, they will never
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	605 return None.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	606
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	607 A typical implementation should not inherit from a RawIOBase
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	608 implementation, but wrap one.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	609 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	610
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	611 def read(self, n=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	612 """Read and return up to n bytes, where n is an int.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	613
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	614 If the argument is omitted, None, or negative, reads and
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	615 returns all data until EOF.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	616
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	617 If the argument is positive, and the underlying raw stream is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	618 not 'interactive', multiple raw reads may be issued to satisfy
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	619 the byte count (unless EOF is reached first). But for
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	620 interactive raw streams (XXX and for pipes?), at most one raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	621 read will be issued, and a short result does not imply that
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	622 EOF is imminent.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	623
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	624 Returns an empty bytes array on EOF.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	625
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	626 Raises BlockingIOError if the underlying raw stream has no
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	627 data at the moment.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	628 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	629 self._unsupported("read")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	630
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	631 def read1(self, n=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	632 """Read up to n bytes with at most one read() system call,
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	633 where n is an int.
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	634 """
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	635 self._unsupported("read1")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	636
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	637 def readinto(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	638 """Read up to len(b) bytes into bytearray b.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	639
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	640 Like read(), this may issue multiple reads to the underlying raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	641 stream, unless the latter is 'interactive'.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	642
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	643 Returns an int representing the number of bytes read (0 for EOF).
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	644
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	645 Raises BlockingIOError if the underlying raw stream has no
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	646 data at the moment.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	647 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	648 # XXX This ought to work with anything that supports the buffer API
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	649 data = self.read(len(b))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	650 n = len(data)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	651 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	652 b[:n] = data
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	653 except TypeError as err:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	654 import array
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	655 if not isinstance(b, array.array):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	656 raise err
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	657 b[:n] = array.array('b', data)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	658 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	659
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	660 def write(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	661 """Write the given bytes buffer to the IO stream.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	662
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	663 Return the number of bytes written, which is never less than
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	664 len(b).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	665
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	666 Raises BlockingIOError if the buffer is full and the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	667 underlying raw stream cannot accept more data at the moment.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	668 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	669 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	670
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	671 def detach(self):
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	672 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	673 Separate the underlying raw stream from the buffer and return it.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	674
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	675 After the raw stream has been detached, the buffer is in an unusable
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	676 state.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	677 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	678 self._unsupported("detach")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	679
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	680 io.BufferedIOBase.register(BufferedIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	681
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	682
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	683 class _BufferedIOMixin(BufferedIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	684
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	685 """A mixin implementation of BufferedIOBase with an underlying raw stream.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	686
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	687 This passes most requests on to the underlying raw stream. It
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	688 does not provide implementations of read(), readinto() or
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	689 write().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	690 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	691
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	692 def __init__(self, raw):
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	693 self._raw = raw
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	694
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	695 ### Positioning ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	696
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	697 def seek(self, pos, whence=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	698 new_position = self.raw.seek(pos, whence)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	699 if new_position < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	700 raise IOError("seek() returned an invalid position")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	701 return new_position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	702
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	703 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	704 pos = self.raw.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	705 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	706 raise IOError("tell() returned an invalid position")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	707 return pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	708
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	709 def truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	710 # Flush the stream. We're mixing buffered I/O with lower-level I/O,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	711 # and a flush may be necessary to synch both views of the current
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	712 # file state.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	713 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	714
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	715 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	716 pos = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	717 # XXX: Should seek() be used, instead of passing the position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	718 # XXX directly to truncate?
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	719 return self.raw.truncate(pos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	720
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	721 ### Flush and close ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	722
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	723 def flush(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	724 if self.closed:
ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	725 raise ValueError("flush of closed file")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	726 self.raw.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	727
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	728 def close(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	729 if self.raw is not None and not self.closed:
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	730 try:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	731 # may raise BlockingIOError or BrokenPipeError etc
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	732 self.flush()
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	733 finally:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	734 self.raw.close()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	735
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	736 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	737 if self.raw is None:
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	738 raise ValueError("raw stream already detached")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	739 self.flush()
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	740 raw = self._raw
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	741 self._raw = None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	742 return raw
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	743
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	744 ### Inquiries ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	745
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	746 def seekable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	747 return self.raw.seekable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	748
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	749 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	750 return self.raw.readable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	751
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	752 def writable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	753 return self.raw.writable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	754
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	755 @property
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	756 def raw(self):
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	757 return self._raw
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	758
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	759 @property
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	760 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	761 return self.raw.closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	762
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	763 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	764 def name(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	765 return self.raw.name
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	766
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	767 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	768 def mode(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	769 return self.raw.mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	770
65990 571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	771 def __getstate__(self):
571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	772 raise TypeError("can not serialize a '{0}' object"
571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	773 .format(self.__class__.__name__))
571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	774
54288 846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	775 def __repr__(self):
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	776 clsname = self.__class__.__name__
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	777 try:
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	778 name = self.name
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	779 except AttributeError:
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	780 return "<_pyio.{0}>".format(clsname)
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	781 else:
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	782 return "<_pyio.{0} name={1!r}>".format(clsname, name)
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	783
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	784 ### Lower-level APIs ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	785
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	786 def fileno(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	787 return self.raw.fileno()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	788
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	789 def isatty(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	790 return self.raw.isatty()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	791
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	792
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	793 class BytesIO(BufferedIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	794
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	795 """Buffered I/O implementation using an in-memory bytes buffer."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	796
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	797 def __init__(self, initial_bytes=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	798 buf = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	799 if initial_bytes is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	800 buf += initial_bytes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	801 self._buffer = buf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	802 self._pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	803
55398 538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	804 def __getstate__(self):
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	805 if self.closed:
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	806 raise ValueError("__getstate__ on closed file")
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	807 return self.__dict__.copy()
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	808
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	809 def getvalue(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	810 """Return the bytes value (contents) of the buffer
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	811 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	812 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	813 raise ValueError("getvalue on closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	814 return bytes(self._buffer)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	815
64496 21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	816 def getbuffer(self):
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	817 """Return a readable and writable view of the buffer.
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	818 """
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	819 return memoryview(self._buffer)
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	820
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	821 def read(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	822 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	823 raise ValueError("read from closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	824 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	825 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	826 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	827 n = len(self._buffer)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	828 if len(self._buffer) <= self._pos:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	829 return b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	830 newpos = min(len(self._buffer), self._pos + n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	831 b = self._buffer[self._pos : newpos]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	832 self._pos = newpos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	833 return bytes(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	834
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	835 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	836 """This is the same as read.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	837 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	838 return self.read(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	839
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	840 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	841 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	842 raise ValueError("write to closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	843 if isinstance(b, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	844 raise TypeError("can't write str to binary stream")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	845 n = len(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	846 if n == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	847 return 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	848 pos = self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	849 if pos > len(self._buffer):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	850 # Inserts null bytes between the current end of the file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	851 # and the new write position.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	852 padding = b'\x00' * (pos - len(self._buffer))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	853 self._buffer += padding
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	854 self._buffer[pos:pos + n] = b
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	855 self._pos += n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	856 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	857
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	858 def seek(self, pos, whence=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	859 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	860 raise ValueError("seek on closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	861 try:
59588 6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	862 pos.__index__
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	863 except AttributeError as err:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	864 raise TypeError("an integer is required") from err
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	865 if whence == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	866 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	867 raise ValueError("negative seek position %r" % (pos,))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	868 self._pos = pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	869 elif whence == 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	870 self._pos = max(0, self._pos + pos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	871 elif whence == 2:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	872 self._pos = max(0, len(self._buffer) + pos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	873 else:
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	874 raise ValueError("unsupported whence value")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	875 return self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	876
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	877 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	878 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	879 raise ValueError("tell on closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	880 return self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	881
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	882 def truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	883 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	884 raise ValueError("truncate on closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	885 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	886 pos = self._pos
59588 6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	887 else:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	888 try:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	889 pos.__index__
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	890 except AttributeError as err:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	891 raise TypeError("an integer is required") from err
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	892 if pos < 0:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	893 raise ValueError("negative truncate position %r" % (pos,))
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	894 del self._buffer[pos:]
58631 d887db501a22 Merged revisions 77895-77896 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 57792 diff changeset	895 return pos
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	896
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	897 def readable(self):
78852 524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	898 if self.closed:
524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	899 raise ValueError("I/O operation on closed file.")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	900 return True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	901
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	902 def writable(self):
78852 524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	903 if self.closed:
524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	904 raise ValueError("I/O operation on closed file.")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	905 return True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	906
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	907 def seekable(self):
78852 524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	908 if self.closed:
524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	909 raise ValueError("I/O operation on closed file.")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	910 return True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	911
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	912
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	913 class BufferedReader(_BufferedIOMixin):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	914
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	915 """BufferedReader(raw[, buffer_size])
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	916
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	917 A buffer for a readable, sequential BaseRawIO object.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	918
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	919 The constructor creates a BufferedReader for the given readable raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	920 stream and buffer_size. If buffer_size is omitted, DEFAULT_BUFFER_SIZE
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	921 is used.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	922 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	923
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	924 def __init__(self, raw, buffer_size=DEFAULT_BUFFER_SIZE):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	925 """Create a new buffered reader using the given readable raw IO object.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	926 """
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	927 if not raw.readable():
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	928 raise IOError('"raw" argument must be readable.')
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	929
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	930 _BufferedIOMixin.__init__(self, raw)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	931 if buffer_size <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	932 raise ValueError("invalid buffer size")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	933 self.buffer_size = buffer_size
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	934 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	935 self._read_lock = Lock()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	936
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	937 def _reset_read_buf(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	938 self._read_buf = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	939 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	940
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	941 def read(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	942 """Read n bytes.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	943
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	944 Returns exactly n bytes of data unless the underlying raw IO
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	945 stream reaches EOF or if the call would block in non-blocking
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	946 mode. If n is negative, read until EOF or until read() would
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	947 block.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	948 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	949 if n is not None and n < -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	950 raise ValueError("invalid number of bytes to read")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	951 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	952 return self._read_unlocked(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	953
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	954 def _read_unlocked(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	955 nodata_val = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	956 empty_values = (b"", None)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	957 buf = self._read_buf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	958 pos = self._read_pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	959
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	960 # Special case for when the number of bytes to read is unspecified.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	961 if n is None or n == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	962 self._reset_read_buf()
70391 3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	963 if hasattr(self.raw, 'readall'):
3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	964 chunk = self.raw.readall()
3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	965 if chunk is None:
3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	966 return buf[pos:] or None
3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	967 else:
3c7792ec4547 Issue #12175: BufferedReader.read(-1) now calls raw.readall() if available. Victor Stinner <victor.stinner@haypocalc.com> parents: 70387 diff changeset	968 return buf[pos:] + chunk
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	969 chunks = [buf[pos:]] # Strip the consumed bytes.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	970 current_size = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	971 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	972 # Read until EOF or until read() would block.
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	973 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	974 chunk = self.raw.read()
73085 90f81045613a Use InterruptedError instead of checking for EINTR Antoine Pitrou <solipsis@pitrou.net> parents: 72879 diff changeset	975 except InterruptedError:
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	976 continue
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	977 if chunk in empty_values:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	978 nodata_val = chunk
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	979 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	980 current_size += len(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	981 chunks.append(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	982 return b"".join(chunks) or nodata_val
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	983
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	984 # The number of bytes to read is specified, return at most n bytes.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	985 avail = len(buf) - pos # Length of the available buffered data.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	986 if n <= avail:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	987 # Fast path: the data to read is fully buffered.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	988 self._read_pos += n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	989 return buf[pos:pos+n]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	990 # Slow path: read from the stream until enough bytes are read,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	991 # or until an EOF occurs or until read() would block.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	992 chunks = [buf[pos:]]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	993 wanted = max(self.buffer_size, n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	994 while avail < n:
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	995 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	996 chunk = self.raw.read(wanted)
73085 90f81045613a Use InterruptedError instead of checking for EINTR Antoine Pitrou <solipsis@pitrou.net> parents: 72879 diff changeset	997 except InterruptedError:
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	998 continue
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	999 if chunk in empty_values:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1000 nodata_val = chunk
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1001 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1002 avail += len(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1003 chunks.append(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1004 # n is more then avail only when an EOF occurred or when
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1005 # read() would have blocked.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1006 n = min(n, avail)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1007 out = b"".join(chunks)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1008 self._read_buf = out[n:] # Save the extra data in the buffer.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1009 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1010 return out[:n] if out else nodata_val
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1011
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1012 def peek(self, n=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1013 """Returns buffered bytes without advancing the position.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1014
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1015 The argument indicates a desired minimal number of bytes; we
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1016 do at most one raw read to satisfy it. We never return more
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1017 than self.buffer_size.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1018 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1019 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1020 return self._peek_unlocked(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1021
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1022 def _peek_unlocked(self, n=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1023 want = min(n, self.buffer_size)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1024 have = len(self._read_buf) - self._read_pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1025 if have < want or have <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1026 to_read = self.buffer_size - have
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1027 while True:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1028 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1029 current = self.raw.read(to_read)
73085 90f81045613a Use InterruptedError instead of checking for EINTR Antoine Pitrou <solipsis@pitrou.net> parents: 72879 diff changeset	1030 except InterruptedError:
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1031 continue
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1032 break
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1033 if current:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1034 self._read_buf = self._read_buf[self._read_pos:] + current
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1035 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1036 return self._read_buf[self._read_pos:]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1037
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1038 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1039 """Reads up to n bytes, with at most one read() system call."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1040 # Returns up to n bytes. If at least one byte is buffered, we
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1041 # only return buffered bytes. Otherwise, we do one raw read.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1042 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1043 raise ValueError("number of bytes to read must be positive")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1044 if n == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1045 return b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1046 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1047 self._peek_unlocked(1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1048 return self._read_unlocked(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1049 min(n, len(self._read_buf) - self._read_pos))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1050
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1051 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1052 return _BufferedIOMixin.tell(self) - len(self._read_buf) + self._read_pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1053
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1054 def seek(self, pos, whence=0):
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1055 if whence not in valid_seek_flags:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1056 raise ValueError("invalid whence value")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1057 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1058 if whence == 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1059 pos -= len(self._read_buf) - self._read_pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1060 pos = _BufferedIOMixin.seek(self, pos, whence)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1061 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1062 return pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1063
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1064 class BufferedWriter(_BufferedIOMixin):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1065
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1066 """A buffer for a writeable sequential RawIO object.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1067
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1068 The constructor creates a BufferedWriter for the given writeable raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1069 stream. If the buffer_size is not given, it defaults to
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1070 DEFAULT_BUFFER_SIZE.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1071 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1072
77973 700f989afbad Issue #13248: io: Remove obsolete argument "max_buffer_size" of BufferedWriter and BufferedRWPair. Florent Xicluna <florent.xicluna@gmail.com> parents: 77571 diff changeset	1073 def __init__(self, raw, buffer_size=DEFAULT_BUFFER_SIZE):
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1074 if not raw.writable():
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1075 raise IOError('"raw" argument must be writable.')
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1076
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1077 _BufferedIOMixin.__init__(self, raw)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1078 if buffer_size <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1079 raise ValueError("invalid buffer size")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1080 self.buffer_size = buffer_size
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1081 self._write_buf = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1082 self._write_lock = Lock()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1083
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1084 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1085 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1086 raise ValueError("write to closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1087 if isinstance(b, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1088 raise TypeError("can't write str to binary stream")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1089 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1090 # XXX we can implement some more tricks to try and avoid
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1091 # partial writes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1092 if len(self._write_buf) > self.buffer_size:
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1093 # We're full, so let's pre-flush the buffer. (This may
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1094 # raise BlockingIOError with characters_written == 0.)
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1095 self._flush_unlocked()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1096 before = len(self._write_buf)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1097 self._write_buf.extend(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1098 written = len(self._write_buf) - before
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1099 if len(self._write_buf) > self.buffer_size:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1100 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1101 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1102 except BlockingIOError as e:
52038 1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1103 if len(self._write_buf) > self.buffer_size:
1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1104 # We've hit the buffer_size. We have to accept a partial
1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1105 # write and cut back our buffer.
1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1106 overage = len(self._write_buf) - self.buffer_size
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1107 written -= overage
52038 1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1108 self._write_buf = self._write_buf[:self.buffer_size]
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1109 raise BlockingIOError(e.errno, e.strerror, written)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1110 return written
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1111
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1112 def truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1113 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1114 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1115 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1116 pos = self.raw.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1117 return self.raw.truncate(pos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1118
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1119 def flush(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1120 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1121 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1122
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1123 def _flush_unlocked(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1124 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1125 raise ValueError("flush of closed file")
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1126 while self._write_buf:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1127 try:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1128 n = self.raw.write(self._write_buf)
73666 3cd1985ed04f Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73324 73665 diff changeset	1129 except InterruptedError:
3cd1985ed04f Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73324 73665 diff changeset	1130 continue
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1131 except BlockingIOError:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1132 raise RuntimeError("self.raw should implement RawIOBase: it "
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1133 "should not raise BlockingIOError")
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1134 if n is None:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1135 raise BlockingIOError(
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1136 errno.EAGAIN,
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1137 "write could not complete without blocking", 0)
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1138 if n > len(self._write_buf) or n < 0:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1139 raise IOError("write() returned incorrect number of bytes")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1140 del self._write_buf[:n]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1141
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1142 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1143 return _BufferedIOMixin.tell(self) + len(self._write_buf)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1144
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1145 def seek(self, pos, whence=0):
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1146 if whence not in valid_seek_flags:
de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1147 raise ValueError("invalid whence value")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1148 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1149 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1150 return _BufferedIOMixin.seek(self, pos, whence)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1151
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1152
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1153 class BufferedRWPair(BufferedIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1154
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1155 """A buffered reader and writer object together.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1156
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1157 A buffered reader object and buffered writer object put together to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1158 form a sequential IO object that can read and write. This is typically
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1159 used with a socket or two-way pipe.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1160
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1161 reader and writer are RawIOBase objects that are readable and
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1162 writeable respectively. If the buffer_size is omitted it defaults to
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1163 DEFAULT_BUFFER_SIZE.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1164 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1165
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1166 # XXX The usefulness of this (compared to having two separate IO
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1167 # objects) is questionable.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1168
77973 700f989afbad Issue #13248: io: Remove obsolete argument "max_buffer_size" of BufferedWriter and BufferedRWPair. Florent Xicluna <florent.xicluna@gmail.com> parents: 77571 diff changeset	1169 def __init__(self, reader, writer, buffer_size=DEFAULT_BUFFER_SIZE):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1170 """Constructor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1171
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1172 The arguments are two RawIO instances.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1173 """
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1174 if not reader.readable():
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1175 raise IOError('"reader" argument must be readable.')
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1176
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1177 if not writer.writable():
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1178 raise IOError('"writer" argument must be writable.')
d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1179
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1180 self.reader = BufferedReader(reader, buffer_size)
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1181 self.writer = BufferedWriter(writer, buffer_size)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1182
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1183 def read(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1184 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1185 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1186 return self.reader.read(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1187
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1188 def readinto(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1189 return self.reader.readinto(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1190
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1191 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1192 return self.writer.write(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1193
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1194 def peek(self, n=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1195 return self.reader.peek(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1196
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1197 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1198 return self.reader.read1(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1199
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1200 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1201 return self.reader.readable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1202
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1203 def writable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1204 return self.writer.writable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1205
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1206 def flush(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1207 return self.writer.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1208
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1209 def close(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1210 self.writer.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1211 self.reader.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1212
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1213 def isatty(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1214 return self.reader.isatty() or self.writer.isatty()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1215
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1216 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1217 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1218 return self.writer.closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1219
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1220
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1221 class BufferedRandom(BufferedWriter, BufferedReader):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1222
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1223 """A buffered interface to random access streams.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1224
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1225 The constructor creates a reader and writer for a seekable stream,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1226 raw, given in the first argument. If the buffer_size is omitted it
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1227 defaults to DEFAULT_BUFFER_SIZE.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1228 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1229
77973 700f989afbad Issue #13248: io: Remove obsolete argument "max_buffer_size" of BufferedWriter and BufferedRWPair. Florent Xicluna <florent.xicluna@gmail.com> parents: 77571 diff changeset	1230 def __init__(self, raw, buffer_size=DEFAULT_BUFFER_SIZE):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1231 raw._checkSeekable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1232 BufferedReader.__init__(self, raw, buffer_size)
77973 700f989afbad Issue #13248: io: Remove obsolete argument "max_buffer_size" of BufferedWriter and BufferedRWPair. Florent Xicluna <florent.xicluna@gmail.com> parents: 77571 diff changeset	1233 BufferedWriter.__init__(self, raw, buffer_size)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1234
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1235 def seek(self, pos, whence=0):
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1236 if whence not in valid_seek_flags:
de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1237 raise ValueError("invalid whence value")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1238 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1239 if self._read_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1240 # Undo read ahead.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1241 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1242 self.raw.seek(self._read_pos - len(self._read_buf), 1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1243 # First do the raw seek, then empty the read buffer, so that
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1244 # if the raw seek fails, we don't lose buffered data forever.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1245 pos = self.raw.seek(pos, whence)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1246 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1247 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1248 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1249 raise IOError("seek() returned invalid position")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1250 return pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1251
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1252 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1253 if self._write_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1254 return BufferedWriter.tell(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1255 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1256 return BufferedReader.tell(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1257
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1258 def truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1259 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1260 pos = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1261 # Use seek to flush the read buffer.
58631 d887db501a22 Merged revisions 77895-77896 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 57792 diff changeset	1262 return BufferedWriter.truncate(self, pos)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1263
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1264 def read(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1265 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1266 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1267 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1268 return BufferedReader.read(self, n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1269
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1270 def readinto(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1271 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1272 return BufferedReader.readinto(self, b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1273
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1274 def peek(self, n=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1275 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1276 return BufferedReader.peek(self, n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1277
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1278 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1279 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1280 return BufferedReader.read1(self, n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1281
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1282 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1283 if self._read_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1284 # Undo readahead
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1285 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1286 self.raw.seek(self._read_pos - len(self._read_buf), 1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1287 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1288 return BufferedWriter.write(self, b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1289
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1290
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1291 class TextIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1292
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1293 """Base class for text I/O.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1294
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1295 This class provides a character and line based interface to stream
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1296 I/O. There is no readinto method because Python's character strings
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1297 are immutable. There is no public constructor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1298 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1299
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	1300 def read(self, n=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1301 """Read at most n characters from stream, where n is an int.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1302
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1303 Read from underlying buffer until we have n characters or we hit EOF.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1304 If n is negative or omitted, read until EOF.
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1305
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1306 Returns a string.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1307 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1308 self._unsupported("read")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1309
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1310 def write(self, s):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1311 """Write string s to stream and returning an int."""
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1312 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1313
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	1314 def truncate(self, pos=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1315 """Truncate size to pos, where pos is an int."""
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1316 self._unsupported("truncate")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1317
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1318 def readline(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1319 """Read until newline or EOF.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1320
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1321 Returns an empty string if EOF is hit immediately.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1322 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1323 self._unsupported("readline")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1324
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1325 def detach(self):
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1326 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1327 Separate the underlying buffer from the TextIOBase and return it.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1328
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1329 After the underlying buffer has been detached, the TextIO is in an
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1330 unusable state.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1331 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1332 self._unsupported("detach")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1333
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1334 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1335 def encoding(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1336 """Subclasses should override."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1337 return None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1338
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1339 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1340 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1341 """Line endings translated so far.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1342
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1343 Only line endings translated during reading are considered.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1344
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1345 Subclasses should override.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1346 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1347 return None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1348
54599 1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1349 @property
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1350 def errors(self):
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1351 """Error setting of the decoder or encoder.
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1352
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1353 Subclasses should override."""
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1354 return None
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1355
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1356 io.TextIOBase.register(TextIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1357
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1358
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1359 class IncrementalNewlineDecoder(codecs.IncrementalDecoder):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1360 r"""Codec used when reading a file in universal newlines mode. It wraps
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1361 another incremental decoder, translating \r\n and \r into \n. It also
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1362 records the types of newlines encountered. When used with
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1363 translate=False, it ensures that the newline sequence is returned in
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1364 one piece.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1365 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1366 def __init__(self, decoder, translate, errors='strict'):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1367 codecs.IncrementalDecoder.__init__(self, errors=errors)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1368 self.translate = translate
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1369 self.decoder = decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1370 self.seennl = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1371 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1372
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1373 def decode(self, input, final=False):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1374 # decode input (with the eventual \r from a previous pass)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1375 if self.decoder is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1376 output = input
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1377 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1378 output = self.decoder.decode(input, final=final)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1379 if self.pendingcr and (output or final):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1380 output = "\r" + output
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1381 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1382
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1383 # retain last \r even when not translating data:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1384 # then readline() is sure to get \r\n in one pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1385 if output.endswith("\r") and not final:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1386 output = output[:-1]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1387 self.pendingcr = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1388
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1389 # Record which newlines are read
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1390 crlf = output.count('\r\n')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1391 cr = output.count('\r') - crlf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1392 lf = output.count('\n') - crlf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1393 self.seennl \|= (lf and self._LF) \| (cr and self._CR) \
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1394 \| (crlf and self._CRLF)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1395
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1396 if self.translate:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1397 if crlf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1398 output = output.replace("\r\n", "\n")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1399 if cr:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1400 output = output.replace("\r", "\n")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1401
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1402 return output
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1403
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1404 def getstate(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1405 if self.decoder is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1406 buf = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1407 flag = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1408 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1409 buf, flag = self.decoder.getstate()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1410 flag <<= 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1411 if self.pendingcr:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1412 flag \|= 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1413 return buf, flag
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1414
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1415 def setstate(self, state):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1416 buf, flag = state
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1417 self.pendingcr = bool(flag & 1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1418 if self.decoder is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1419 self.decoder.setstate((buf, flag >> 1))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1420
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1421 def reset(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1422 self.seennl = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1423 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1424 if self.decoder is not None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1425 self.decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1426
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1427 _LF = 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1428 _CR = 2
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1429 _CRLF = 4
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1430
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1431 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1432 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1433 return (None,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1434 "\n",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1435 "\r",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1436 ("\r", "\n"),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1437 "\r\n",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1438 ("\n", "\r\n"),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1439 ("\r", "\r\n"),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1440 ("\r", "\n", "\r\n")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1441 )[self.seennl]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1442
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1443
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1444 class TextIOWrapper(TextIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1445
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1446 r"""Character and line based layer over a BufferedIOBase object, buffer.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1447
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1448 encoding gives the name of the encoding that the stream will be
77361 2587328c7c9c Close #11022: TextIOWrapper doesn't call locale.setlocale() anymore Victor Stinner <victor.stinner@gmail.com> parents: 76571 diff changeset	1449 decoded or encoded with. It defaults to locale.getpreferredencoding(False).
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1450
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1451 errors determines the strictness of encoding and decoding (see the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1452 codecs.register) and defaults to "strict".
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1453
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1454 newline can be None, '', '\n', '\r', or '\r\n'. It controls the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1455 handling of line endings. If it is None, universal newlines is
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1456 enabled. With this enabled, on input, the lines endings '\n', '\r',
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1457 or '\r\n' are translated to '\n' before being returned to the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1458 caller. Conversely, on output, '\n' is translated to the system
73319 ca4c7543c823 Fix typo Éric Araujo <merwok@netwok.org> parents: 71482 diff changeset	1459 default line separator, os.linesep. If newline is any other of its
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1460 legal values, that newline becomes the newline when the file is read
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1461 and it is returned untranslated. On output, '\n' is converted to the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1462 newline.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1463
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1464 If line_buffering is True, a call to flush is implied when a call to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1465 write contains a newline character.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1466 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1467
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1468 _CHUNK_SIZE = 2048
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1469
78541 ba055ccd99ef Issue #15571: comment the fact what python impl of TextIOWrapper always works in write_throuth mode Andrew Svetlov <andrew.svetlov@gmail.com> parents: 77973 diff changeset	1470 # The write_through argument has no effect here since this
ba055ccd99ef Issue #15571: comment the fact what python impl of TextIOWrapper always works in write_throuth mode Andrew Svetlov <andrew.svetlov@gmail.com> parents: 77973 diff changeset	1471 # implementation always writes through. The argument is present only
ba055ccd99ef Issue #15571: comment the fact what python impl of TextIOWrapper always works in write_throuth mode Andrew Svetlov <andrew.svetlov@gmail.com> parents: 77973 diff changeset	1472 # so that the signature can match the signature of the C version.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1473 def __init__(self, buffer, encoding=None, errors=None, newline=None,
71482 9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1474 line_buffering=False, write_through=False):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1475 if newline is not None and not isinstance(newline, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1476 raise TypeError("illegal newline type: %r" % (type(newline),))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1477 if newline not in (None, "", "\n", "\r", "\r\n"):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1478 raise ValueError("illegal newline value: %r" % (newline,))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1479 if encoding is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1480 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1481 encoding = os.device_encoding(buffer.fileno())
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1482 except (AttributeError, UnsupportedOperation):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1483 pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1484 if encoding is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1485 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1486 import locale
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1487 except ImportError:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1488 # Importing locale may fail if Python is being built
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1489 encoding = "ascii"
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1490 else:
77361 2587328c7c9c Close #11022: TextIOWrapper doesn't call locale.setlocale() anymore Victor Stinner <victor.stinner@gmail.com> parents: 76571 diff changeset	1491 encoding = locale.getpreferredencoding(False)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1492
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1493 if not isinstance(encoding, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1494 raise ValueError("invalid encoding: %r" % encoding)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1495
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1496 if errors is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1497 errors = "strict"
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1498 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1499 if not isinstance(errors, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1500 raise ValueError("invalid errors: %r" % errors)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1501
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1502 self._buffer = buffer
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1503 self._line_buffering = line_buffering
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1504 self._encoding = encoding
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1505 self._errors = errors
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1506 self._readuniversal = not newline
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1507 self._readtranslate = newline is None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1508 self._readnl = newline
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1509 self._writetranslate = newline != ''
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1510 self._writenl = newline or os.linesep
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1511 self._encoder = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1512 self._decoder = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1513 self._decoded_chars = '' # buffer for text returned from decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1514 self._decoded_chars_used = 0 # offset into _decoded_chars for read()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1515 self._snapshot = None # info for reconstructing decoder state
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1516 self._seekable = self._telling = self.buffer.seekable()
71482 9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1517 self._has_read1 = hasattr(self.buffer, 'read1')
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1518 self._b2cratio = 0.0
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1519
54070 07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1520 if self._seekable and self.writable():
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1521 position = self.buffer.tell()
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1522 if position != 0:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1523 try:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1524 self._get_encoder().setstate(0)
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1525 except LookupError:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1526 # Sometimes the encoder doesn't exist
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1527 pass
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1528
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1529 # self._snapshot is either None, or a tuple (dec_flags, next_input)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1530 # where dec_flags is the second (integer) item of the decoder state
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1531 # and next_input is the chunk of input bytes that comes next after the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1532 # snapshot point. We use this to reconstruct decoder states in tell().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1533
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1534 # Naming convention:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1535 # - "bytes_..." for integer variables that count input bytes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1536 # - "chars_..." for integer variables that count decoded characters
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1537
52078 1045fd63fa73 give TextIOWrapper a repr that tells you the encoding Benjamin Peterson <benjamin@python.org> parents: 52038 diff changeset	1538 def __repr__(self):
67500 f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1539 result = "<_pyio.TextIOWrapper"
54288 846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	1540 try:
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	1541 name = self.name
846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	1542 except AttributeError:
67500 f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1543 pass
54288 846277a42249 Issue #5761: Add the name of the underlying file to the repr() of various IO objects. Antoine Pitrou <solipsis@pitrou.net> parents: 54070 diff changeset	1544 else:
67500 f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1545 result += " name={0!r}".format(name)
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1546 try:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1547 mode = self.mode
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1548 except AttributeError:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1549 pass
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1550 else:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1551 result += " mode={0!r}".format(mode)
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1552 return result + " encoding={0!r}>".format(self.encoding)
52078 1045fd63fa73 give TextIOWrapper a repr that tells you the encoding Benjamin Peterson <benjamin@python.org> parents: 52038 diff changeset	1553
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1554 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1555 def encoding(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1556 return self._encoding
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1557
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1558 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1559 def errors(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1560 return self._errors
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1561
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1562 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1563 def line_buffering(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1564 return self._line_buffering
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1565
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1566 @property
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1567 def buffer(self):
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1568 return self._buffer
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1569
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1570 def seekable(self):
78852 524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	1571 if self.closed:
524931e5aebf Issue #15841: The readable(), writable() and seekable() methods of BytesIO Antoine Pitrou <solipsis@pitrou.net> parents: 73665 diff changeset	1572 raise ValueError("I/O operation on closed file.")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1573 return self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1574
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1575 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1576 return self.buffer.readable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1577
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1578 def writable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1579 return self.buffer.writable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1580
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1581 def flush(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1582 self.buffer.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1583 self._telling = self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1584
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1585 def close(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	1586 if self.buffer is not None and not self.closed:
ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	1587 self.flush()
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1588 self.buffer.close()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1589
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1590 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1591 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1592 return self.buffer.closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1593
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1594 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1595 def name(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1596 return self.buffer.name
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1597
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1598 def fileno(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1599 return self.buffer.fileno()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1600
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1601 def isatty(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1602 return self.buffer.isatty()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1603
67574 8719dd712384 Issue 10899: Remove function type annotations from the stdlib Raymond Hettinger <python@rcn.com> parents: 67571 diff changeset	1604 def write(self, s):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1605 'Write data, where s is a str'
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1606 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1607 raise ValueError("write to closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1608 if not isinstance(s, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1609 raise TypeError("can't write %s to text stream" %
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1610 s.__class__.__name__)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1611 length = len(s)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1612 haslf = (self._writetranslate or self._line_buffering) and "\n" in s
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1613 if haslf and self._writetranslate and self._writenl != "\n":
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1614 s = s.replace("\n", self._writenl)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1615 encoder = self._encoder or self._get_encoder()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1616 # XXX What if we were just reading?
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1617 b = encoder.encode(s)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1618 self.buffer.write(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1619 if self._line_buffering and (haslf or "\r" in s):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1620 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1621 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1622 if self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1623 self._decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1624 return length
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1625
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1626 def _get_encoder(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1627 make_encoder = codecs.getincrementalencoder(self._encoding)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1628 self._encoder = make_encoder(self._errors)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1629 return self._encoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1630
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1631 def _get_decoder(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1632 make_decoder = codecs.getincrementaldecoder(self._encoding)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1633 decoder = make_decoder(self._errors)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1634 if self._readuniversal:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1635 decoder = IncrementalNewlineDecoder(decoder, self._readtranslate)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1636 self._decoder = decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1637 return decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1638
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1639 # The following three methods implement an ADT for _decoded_chars.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1640 # Text returned from the decoder is buffered here until the client
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1641 # requests it by calling our read() or readline() method.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1642 def _set_decoded_chars(self, chars):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1643 """Set the _decoded_chars buffer."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1644 self._decoded_chars = chars
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1645 self._decoded_chars_used = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1646
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1647 def _get_decoded_chars(self, n=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1648 """Advance into the _decoded_chars buffer."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1649 offset = self._decoded_chars_used
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1650 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1651 chars = self._decoded_chars[offset:]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1652 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1653 chars = self._decoded_chars[offset:offset + n]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1654 self._decoded_chars_used += len(chars)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1655 return chars
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1656
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1657 def _rewind_decoded_chars(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1658 """Rewind the _decoded_chars buffer."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1659 if self._decoded_chars_used < n:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1660 raise AssertionError("rewind decoded_chars out of bounds")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1661 self._decoded_chars_used -= n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1662
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1663 def _read_chunk(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1664 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1665 Read and decode the next chunk of data from the BufferedReader.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1666 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1667
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1668 # The return value is True unless EOF was reached. The decoded
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1669 # string is placed in self._decoded_chars (replacing its previous
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1670 # value). The entire input chunk is sent to the decoder, though
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1671 # some of it may remain buffered in the decoder, yet to be
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1672 # converted.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1673
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1674 if self._decoder is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1675 raise ValueError("no decoder")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1676
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1677 if self._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1678 # To prepare for tell(), we need to snapshot a point in the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1679 # file where the decoder's input buffer is empty.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1680
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1681 dec_buffer, dec_flags = self._decoder.getstate()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1682 # Given this, we know there was a valid snapshot point
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1683 # len(dec_buffer) bytes ago with decoder state (b'', dec_flags).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1684
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1685 # Read a chunk, decode it, and put the result in self._decoded_chars.
71482 9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1686 if self._has_read1:
9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1687 input_chunk = self.buffer.read1(self._CHUNK_SIZE)
9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1688 else:
9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1689 input_chunk = self.buffer.read(self._CHUNK_SIZE)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1690 eof = not input_chunk
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1691 decoded_chars = self._decoder.decode(input_chunk, eof)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1692 self._set_decoded_chars(decoded_chars)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1693 if decoded_chars:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1694 self._b2cratio = len(input_chunk) / len(self._decoded_chars)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1695 else:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1696 self._b2cratio = 0.0
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1697
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1698 if self._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1699 # At the snapshot point, len(dec_buffer) bytes before the read,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1700 # the next input to be decoded is dec_buffer + input_chunk.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1701 self._snapshot = (dec_flags, dec_buffer + input_chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1702
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1703 return not eof
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1704
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1705 def _pack_cookie(self, position, dec_flags=0,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1706 bytes_to_feed=0, need_eof=0, chars_to_skip=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1707 # The meaning of a tell() cookie is: seek to position, set the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1708 # decoder flags to dec_flags, read bytes_to_feed bytes, feed them
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1709 # into the decoder with need_eof as the EOF flag, then skip
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1710 # chars_to_skip characters of the decoded result. For most simple
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1711 # decoders, tell() will often just give a byte offset in the file.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1712 return (position \| (dec_flags<<64) \| (bytes_to_feed<<128) \|
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1713 (chars_to_skip<<192) \| bool(need_eof)<<256)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1714
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1715 def _unpack_cookie(self, bigint):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1716 rest, position = divmod(bigint, 1<<64)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1717 rest, dec_flags = divmod(rest, 1<<64)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1718 rest, bytes_to_feed = divmod(rest, 1<<64)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1719 need_eof, chars_to_skip = divmod(rest, 1<<64)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1720 return position, dec_flags, bytes_to_feed, need_eof, chars_to_skip
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1721
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1722 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1723 if not self._seekable:
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	1724 raise UnsupportedOperation("underlying stream is not seekable")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1725 if not self._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1726 raise IOError("telling position disabled by next() call")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1727 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1728 position = self.buffer.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1729 decoder = self._decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1730 if decoder is None or self._snapshot is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1731 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1732 # This should never happen.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1733 raise AssertionError("pending decoded text")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1734 return position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1735
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1736 # Skip backward to the snapshot point (see _read_chunk).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1737 dec_flags, next_input = self._snapshot
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1738 position -= len(next_input)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1739
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1740 # How many decoded characters have been used up since the snapshot?
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1741 chars_to_skip = self._decoded_chars_used
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1742 if chars_to_skip == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1743 # We haven't moved from the snapshot point.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1744 return self._pack_cookie(position, dec_flags)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1745
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1746 # Starting from the snapshot position, we will walk the decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1747 # forward until it gives us enough decoded characters.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1748 saved_state = decoder.getstate()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1749 try:
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1750 # Fast search for an acceptable start point, close to our
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1751 # current pos.
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1752 # Rationale: calling decoder.decode() has a large overhead
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1753 # regardless of chunk size; we want the number of such calls to
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1754 # be O(1) in most situations (common decoders, non-crazy input).
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1755 # Actually, it will be exactly 1 for fixed-size codecs (all
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1756 # 8-bit codecs, also UTF-16 and UTF-32).
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1757 skip_bytes = int(self._b2cratio * chars_to_skip)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1758 skip_back = 1
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1759 assert skip_bytes <= len(next_input)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1760 while skip_bytes > 0:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1761 decoder.setstate((b'', dec_flags))
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1762 # Decode up to temptative start point
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1763 n = len(decoder.decode(next_input[:skip_bytes]))
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1764 if n <= chars_to_skip:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1765 b, d = decoder.getstate()
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1766 if not b:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1767 # Before pos and no bytes buffered in decoder => OK
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1768 dec_flags = d
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1769 chars_to_skip -= n
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1770 break
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1771 # Skip back by buffered amount and reset heuristic
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1772 skip_bytes -= len(b)
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1773 skip_back = 1
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1774 else:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1775 # We're too far ahead, skip back a bit
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1776 skip_bytes -= skip_back
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1777 skip_back = skip_back * 2
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1778 else:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1779 skip_bytes = 0
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1780 decoder.setstate((b'', dec_flags))
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1781
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1782 # Note our initial start point.
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1783 start_pos = position + skip_bytes
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1784 start_flags = dec_flags
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1785 if chars_to_skip == 0:
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1786 # We haven't moved from the start point.
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1787 return self._pack_cookie(start_pos, start_flags)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1788
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1789 # Feed the decoder one byte at a time. As we go, note the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1790 # nearest "safe start point" before the current location
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1791 # (a point where the decoder has nothing buffered, so seek()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1792 # can safely start from there and advance to this location).
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1793 bytes_fed = 0
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1794 need_eof = 0
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1795 # Chars decoded since `start_pos`
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1796 chars_decoded = 0
4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1797 for i in range(skip_bytes, len(next_input)):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1798 bytes_fed += 1
68149 4b6052320e98 Issue #11114: Fix catastrophic performance of tell() on text files (up Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1799 chars_decoded += len(decoder.decode(next_input[i:i+1]))
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1800 dec_buffer, dec_flags = decoder.getstate()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1801 if not dec_buffer and chars_decoded <= chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1802 # Decoder buffer is empty, so this is a safe start point.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1803 start_pos += bytes_fed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1804 chars_to_skip -= chars_decoded
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1805 start_flags, bytes_fed, chars_decoded = dec_flags, 0, 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1806 if chars_decoded >= chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1807 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1808 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1809 # We didn't get enough decoded data; signal EOF to get more.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1810 chars_decoded += len(decoder.decode(b'', final=True))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1811 need_eof = 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1812 if chars_decoded < chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1813 raise IOError("can't reconstruct logical file position")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1814
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1815 # The returned cookie corresponds to the last safe start point.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1816 return self._pack_cookie(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1817 start_pos, start_flags, bytes_fed, need_eof, chars_to_skip)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1818 finally:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1819 decoder.setstate(saved_state)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1820
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1821 def truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1822 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1823 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1824 pos = self.tell()
58631 d887db501a22 Merged revisions 77895-77896 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 57792 diff changeset	1825 return self.buffer.truncate(pos)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1826
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1827 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1828 if self.buffer is None:
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1829 raise ValueError("buffer is already detached")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1830 self.flush()
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1831 buffer = self._buffer
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1832 self._buffer = None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1833 return buffer
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1834
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1835 def seek(self, cookie, whence=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1836 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1837 raise ValueError("tell on closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1838 if not self._seekable:
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	1839 raise UnsupportedOperation("underlying stream is not seekable")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1840 if whence == 1: # seek relative to current position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1841 if cookie != 0:
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	1842 raise UnsupportedOperation("can't do nonzero cur-relative seeks")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1843 # Seeking to the current position should attempt to
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1844 # sync the underlying buffer with the current position.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1845 whence = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1846 cookie = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1847 if whence == 2: # seek relative to end of file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1848 if cookie != 0:
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	1849 raise UnsupportedOperation("can't do nonzero end-relative seeks")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1850 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1851 position = self.buffer.seek(0, 2)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1852 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1853 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1854 if self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1855 self._decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1856 return position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1857 if whence != 0:
77571 de2a0cb6ba52 Closes #10142: Support for SEEK_HOLE/SEEK_DATA Jesus Cea <jcea@jcea.es> parents: 77361 diff changeset	1858 raise ValueError("unsupported whence (%r)" % (whence,))
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1859 if cookie < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1860 raise ValueError("negative seek position %r" % (cookie,))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1861 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1862
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1863 # The strategy of seek() is to go back to the safe start point
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1864 # and replay the effect of read(chars_to_skip) from there.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1865 start_pos, dec_flags, bytes_to_feed, need_eof, chars_to_skip = \
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1866 self._unpack_cookie(cookie)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1867
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1868 # Seek back to the safe start point.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1869 self.buffer.seek(start_pos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1870 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1871 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1872
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1873 # Restore the decoder to its state from the safe start point.
52021 33e9a145fd38 fix #4862 in _pyio: reset the decoder on seek(0) Benjamin Peterson <benjamin@python.org> parents: 51991 diff changeset	1874 if cookie == 0 and self._decoder:
33e9a145fd38 fix #4862 in _pyio: reset the decoder on seek(0) Benjamin Peterson <benjamin@python.org> parents: 51991 diff changeset	1875 self._decoder.reset()
33e9a145fd38 fix #4862 in _pyio: reset the decoder on seek(0) Benjamin Peterson <benjamin@python.org> parents: 51991 diff changeset	1876 elif self._decoder or dec_flags or chars_to_skip:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1877 self._decoder = self._decoder or self._get_decoder()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1878 self._decoder.setstate((b'', dec_flags))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1879 self._snapshot = (dec_flags, b'')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1880
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1881 if chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1882 # Just like _read_chunk, feed the decoder and save a snapshot.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1883 input_chunk = self.buffer.read(bytes_to_feed)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1884 self._set_decoded_chars(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1885 self._decoder.decode(input_chunk, need_eof))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1886 self._snapshot = (dec_flags, input_chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1887
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1888 # Skip chars_to_skip of the decoded characters.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1889 if len(self._decoded_chars) < chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1890 raise IOError("can't restore logical file position")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1891 self._decoded_chars_used = chars_to_skip
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1892
54070 07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1893 # Finally, reset the encoder (merely useful for proper BOM handling)
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1894 try:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1895 encoder = self._encoder or self._get_encoder()
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1896 except LookupError:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1897 # Sometimes the encoder doesn't exist
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1898 pass
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1899 else:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1900 if cookie != 0:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1901 encoder.setstate(0)
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1902 else:
07b5f20d025a Issue #5006: Better handling of unicode byte-order marks (BOM) in the io library. Antoine Pitrou <solipsis@pitrou.net> parents: 53649 diff changeset	1903 encoder.reset()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1904 return cookie
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1905
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1906 def read(self, n=None):
52624 b4026ac78114 fix TextIOWrapper.read() when the buffer is not readable #5628 Benjamin Peterson <benjamin@python.org> parents: 52344 diff changeset	1907 self._checkReadable()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1908 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1909 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1910 decoder = self._decoder or self._get_decoder()
59588 6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1911 try:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1912 n.__index__
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1913 except AttributeError as err:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1914 raise TypeError("an integer is required") from err
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1915 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1916 # Read everything.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1917 result = (self._get_decoded_chars() +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1918 decoder.decode(self.buffer.read(), final=True))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1919 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1920 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1921 return result
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1922 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1923 # Keep reading chunks until we have n characters to return.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1924 eof = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1925 result = self._get_decoded_chars(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1926 while len(result) < n and not eof:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1927 eof = not self._read_chunk()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1928 result += self._get_decoded_chars(n - len(result))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1929 return result
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1930
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1931 def __next__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1932 self._telling = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1933 line = self.readline()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1934 if not line:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1935 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1936 self._telling = self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1937 raise StopIteration
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1938 return line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1939
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1940 def readline(self, limit=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1941 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1942 raise ValueError("read from closed file")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1943 if limit is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1944 limit = -1
53367 c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	1945 elif not isinstance(limit, int):
c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	1946 raise TypeError("limit must be an integer")
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1947
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1948 # Grab all the decoded text (we will rewind any extra bits later).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1949 line = self._get_decoded_chars()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1950
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1951 start = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1952 # Make the decoder if it doesn't already exist.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1953 if not self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1954 self._get_decoder()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1955
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1956 pos = endpos = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1957 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1958 if self._readtranslate:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1959 # Newlines are already translated, only search for \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1960 pos = line.find('\n', start)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1961 if pos >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1962 endpos = pos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1963 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1964 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1965 start = len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1966
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1967 elif self._readuniversal:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1968 # Universal newline search. Find any of \r, \r\n, \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1969 # The decoder ensures that \r\n are not split in two pieces
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1970
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1971 # In C we'd look for these in parallel of course.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1972 nlpos = line.find("\n", start)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1973 crpos = line.find("\r", start)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1974 if crpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1975 if nlpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1976 # Nothing found
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1977 start = len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1978 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1979 # Found \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1980 endpos = nlpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1981 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1982 elif nlpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1983 # Found lone \r
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1984 endpos = crpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1985 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1986 elif nlpos < crpos:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1987 # Found \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1988 endpos = nlpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1989 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1990 elif nlpos == crpos + 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1991 # Found \r\n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1992 endpos = crpos + 2
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1993 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1994 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1995 # Found \r
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1996 endpos = crpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1997 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1998 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1999 # non-universal
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2000 pos = line.find(self._readnl)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2001 if pos >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2002 endpos = pos + len(self._readnl)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2003 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2004
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2005 if limit >= 0 and len(line) >= limit:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2006 endpos = limit # reached length limit
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2007 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2008
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2009 # No line ending seen yet - get more data'
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2010 while self._read_chunk():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2011 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2012 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2013 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2014 line += self._get_decoded_chars()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2015 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2016 # end of file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2017 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2018 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2019 return line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2020
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2021 if limit >= 0 and endpos > limit:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2022 endpos = limit # don't exceed limit
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2023
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2024 # Rewind _decoded_chars to just after the line ending we found.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2025 self._rewind_decoded_chars(len(line) - endpos)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2026 return line[:endpos]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2027
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2028 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2029 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2030 return self._decoder.newlines if self._decoder else None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2031
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2032
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2033 class StringIO(TextIOWrapper):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2034 """Text I/O implementation using an in-memory buffer.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2035
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2036 The initial_value argument sets the value of object. The newline
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2037 argument is like the one of TextIOWrapper's constructor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2038 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2039
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2040 def __init__(self, initial_value="", newline="\n"):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2041 super(StringIO, self).__init__(BytesIO(),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2042 encoding="utf-8",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2043 errors="strict",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2044 newline=newline)
52816 61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2045 # Issue #5645: make universal newlines semantics the same as in the
61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2046 # C version, even under Windows.
61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2047 if newline is None:
61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2048 self._writetranslate = False
55609 9d40586a6afc Merged revisions 74126,74130-74131,74149,74155,74157,74180-74183,74398 via svnmerge from Georg Brandl <georg@python.org> parents: 54599 diff changeset	2049 if initial_value is not None:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2050 if not isinstance(initial_value, str):
55609 9d40586a6afc Merged revisions 74126,74130-74131,74149,74155,74157,74180-74183,74398 via svnmerge from Georg Brandl <georg@python.org> parents: 54599 diff changeset	2051 raise TypeError("initial_value must be str or None, not {0}"
9d40586a6afc Merged revisions 74126,74130-74131,74149,74155,74157,74180-74183,74398 via svnmerge from Georg Brandl <georg@python.org> parents: 54599 diff changeset	2052 .format(type(initial_value).__name__))
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2053 initial_value = str(initial_value)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2054 self.write(initial_value)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2055 self.seek(0)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2056
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2057 def getvalue(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2058 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2059 return self.buffer.getvalue().decode(self._encoding, self._errors)
52079 cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2060
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2061 def __repr__(self):
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2062 # TextIOWrapper tells the encoding in its repr. In StringIO,
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2063 # that's a implementation detail.
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2064 return object.__repr__(self)
52247 2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2065
2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2066 @property
54599 1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2067 def errors(self):
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2068 return None
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2069
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2070 @property
52247 2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2071 def encoding(self):
2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2072 return None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2073
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2074 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2075 # This doesn't make sense on StringIO.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2076 self._unsupported("detach")

Mercurial > cpython-lru_cache-weakref

annotate Lib/_pyio.py @ 79691:05c8928362ee