cpython-lru_cache-weakref: Lib/

annotate Lib/_pyio.py @ 78069:a8aa77458e12 3.2

Add c_size_t and c_ssize_t to the ctypes summary table.

author	Antoine Pitrou <solipsis@pitrou.net>
date	Thu, 12 Jul 2012 20:31:50 +0200
parents	ac2c4c62b486
children	524931e5aebf 3cd1985ed04f

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
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	8 import warnings
73665 ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	9 import errno
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	10 # 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	11 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	12 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	13 except ImportError:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	14 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	15
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	16 import io
61026 3b6979055f5a Merged revisions 80548-80549 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 61020 diff changeset	17 from io import (__all__, SEEK_SET, SEEK_CUR, SEEK_END)
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	18 from errno import EINTR
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	19
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	20 # 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	21 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	22
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	23 # 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	24 # 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	25 # 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	26
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	27
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	28 class BlockingIOError(IOError):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	29
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	30 """Exception raised when I/O would block on a non-blocking I/O stream."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	31
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	32 def __init__(self, errno, strerror, characters_written=0):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	33 super().__init__(errno, strerror)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	34 if not isinstance(characters_written, int):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	35 raise TypeError("characters_written must be a integer")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	36 self.characters_written = characters_written
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	37
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	38
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	39 def open(file, mode="r", buffering=-1, encoding=None, errors=None,
cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	40 newline=None, closefd=True):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	41
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	42 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	43
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	44 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	45 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	46 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	47 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	48 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	49
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	50 mode is an optional string that specifies the mode in which the file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	51 is opened. It defaults to 'r' which means open for reading in text
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	52 mode. Other common values are 'w' for writing (truncating the file if
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	53 it already exists), and 'a' for appending (which on some Unix systems,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	54 means that all writes append to the end of the file regardless of the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	55 current seek position). In text mode, if encoding is not specified the
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	56 encoding used is platform dependent. (For reading and writing raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	57 bytes use binary mode and leave encoding unspecified.) The available
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	58 modes are:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	59
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	60 ========= ===============================================================
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	61 Character Meaning
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	62 --------- ---------------------------------------------------------------
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	63 '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	64 'w' open for writing, truncating the file first
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	65 '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	66 'b' binary mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	67 't' text mode (default)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	68 '+' 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	69 '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	70 for new code)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	71 ========= ===============================================================
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	72
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	73 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	74 access, the mode 'w+b' opens and truncates the file to 0 bytes, while
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	75 'r+b' opens the file without truncation.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	76
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	77 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	78 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	79 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	80 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	81 '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	82 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	83 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	84
57792 6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	85 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	86 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	87 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	88 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	89 given, the default buffering policy works as follows:
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	90
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	91 * 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	92 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	93 "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	94 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	95
6f9c0746f1e2 Merged revisions 76900 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 55609 diff changeset	96 * "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	97 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	98 for binary files.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	99
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	100 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	101 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	102 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	103 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	104
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	105 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	106 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	107 '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	108 (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	109 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	110 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	111 encoding error strings.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	112
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	113 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	114 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	115 as follows:
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	116
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	117 * 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	118 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	119 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	120 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	121 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	122 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	123 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	124
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	125 * 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	126 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	127 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	128 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	129 the given string.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	130
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	131 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	132 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	133 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	134
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	135 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	136 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	137 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	138 '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	139 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	140 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	141 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	142 a BufferedRandom.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	143
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	144 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	145 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	146 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	147 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	148 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	149 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	150 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	151 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	152 raise TypeError("invalid mode: %r" % mode)
61020 3691d75b0626 Merged revisions 80544 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 59588 diff changeset	153 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	154 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	155 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	156 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	157 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	158 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	159 modes = set(mode)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	160 if modes - set("arwb+tU") or len(mode) > len(modes):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	161 raise ValueError("invalid mode: %r" % mode)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	162 reading = "r" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	163 writing = "w" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	164 appending = "a" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	165 updating = "+" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	166 text = "t" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	167 binary = "b" in modes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	168 if "U" in modes:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	169 if writing or appending:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	170 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	171 reading = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	172 if text and binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	173 raise ValueError("can't have text and binary mode at once")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	174 if reading + writing + appending > 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	175 raise ValueError("can't have read/write/append mode at once")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	176 if not (reading or writing or appending):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	177 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	178 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	179 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	180 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	181 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	182 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	183 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	184 raw = FileIO(file,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	185 (reading and "r" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	186 (writing and "w" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	187 (appending and "a" or "") +
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	188 (updating and "+" or ""),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	189 closefd)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	190 line_buffering = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	191 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	192 buffering = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	193 line_buffering = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	194 if buffering < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	195 buffering = DEFAULT_BUFFER_SIZE
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	196 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	197 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	198 except (os.error, AttributeError):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	199 pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	200 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	201 if bs > 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	202 buffering = bs
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	203 if buffering < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	204 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	205 if buffering == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	206 if binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	207 return raw
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	208 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	209 if updating:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	210 buffer = BufferedRandom(raw, buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	211 elif writing or appending:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	212 buffer = BufferedWriter(raw, buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	213 elif reading:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	214 buffer = BufferedReader(raw, buffering)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	215 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	216 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	217 if binary:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	218 return buffer
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	219 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	220 text.mode = mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	221 return text
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	222
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	223
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	224 class DocDescriptor:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	225 """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	226 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	227 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	228 return (
61026 3b6979055f5a Merged revisions 80548-80549 via svnmerge from Benjamin Peterson <benjamin@python.org> parents: 61020 diff changeset	229 "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	230 "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	231 open.__doc__)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	232
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	233 class OpenWrapper:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	234 """Wrapper for builtins.open
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	235
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	236 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	237 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	238
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	239 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	240 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	241 __doc__ = DocDescriptor()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	242
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	243 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	244 return open(args, *kwargs)
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
64478 87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	247 # 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	248 # same object.
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	249 try:
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	250 UnsupportedOperation = io.UnsupportedOperation
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	251 except AttributeError:
87aa62bd1715 Issue #9293: I/O streams now raise `io.UnsupportedOperation` when an Antoine Pitrou <solipsis@pitrou.net> parents: 61182 diff changeset	252 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	253 pass
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	254
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	255
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	256 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	257
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	258 """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	259 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	260
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	261 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	262 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	263 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	264
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	265 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	266 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	267 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	268 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	269 called.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	270
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	271 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	272 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	273 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	274
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	275 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	276 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	277
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	278 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	279 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	280 stream.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	281
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	282 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	283 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	284
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	285 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	286 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	287 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	288
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	289 ### Internal ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	290
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	291 def _unsupported(self, name):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	292 """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	293 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	294 (self.__class__.__name__, name))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	295
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	296 ### Positioning ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	297
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	298 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	299 """Change stream position.
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 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	302 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	303 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	304
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	305 * 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	306 * 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	307 * 2 -- end of stream; offset is usually negative
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	308
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	309 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	310 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	311 self._unsupported("seek")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	312
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	313 def tell(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	314 """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	315 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	316
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	317 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	318 """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	319
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	320 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	321 the new size.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	322 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	323 self._unsupported("truncate")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	324
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	325 ### Flush and close ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	326
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	327 def flush(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	328 """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	329
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	330 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	331 """
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	332 self._checkClosed()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	333 # 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	334
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	335 __closed = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	336
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	337 def close(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	338 """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	339
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	340 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	341 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	342 if not self.__closed:
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	343 self.flush()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	344 self.__closed = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	345
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	346 def __del__(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	347 """Destructor. Calls close()."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	348 # 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	349 # 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	350 # 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	351 # 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	352 # 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	353 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	354 self.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	355 except:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	356 pass
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	357
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	358 ### Inquiries ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	359
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	360 def seekable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	361 """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	362
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	363 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	364 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	365 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	366 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	367
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	368 def _checkSeekable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	369 """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	370 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	371 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	372 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	373 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	374
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	375 def readable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	376 """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	377
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	378 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	379 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	380 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	381
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	382 def _checkReadable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	383 """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	384 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	385 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	386 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	387 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	388
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	389 def writable(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	390 """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	391
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	392 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	393 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	394 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	395
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	396 def _checkWritable(self, msg=None):
64506 54b7964dd7a9 Change docstrings to match the implementation Amaury Forgeot d'Arc <amauryfa@gmail.com> parents: 64496 diff changeset	397 """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	398 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	399 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	400 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	401 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	402
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	403 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	404 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	405 """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	406
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	407 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	408 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	409 return self.__closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	410
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	411 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	412 """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	413 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	414 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	415 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	416 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	417
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	418 ### Context manager ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	419
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	420 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	421 """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	422 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	423 return self
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	424
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	425 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	426 """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	427 self.close()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	428
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	429 ### Lower-level APIs ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	430
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	431 # 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	432
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	433 def fileno(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	434 """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	435
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	436 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	437 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	438 self._unsupported("fileno")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	439
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	440 def isatty(self):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	441 """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	442
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	443 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	444 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	445 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	446 return False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	447
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	448 ### Readline[s] and writelines ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	449
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	450 def readline(self, limit=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	451 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	452
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	453 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	454 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	455
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	456 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	457 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	458 terminator(s) recognized.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	459 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	460 # 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	461 if hasattr(self, "peek"):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	462 def nreadahead():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	463 readahead = self.peek(1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	464 if not readahead:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	465 return 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	466 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	467 if limit >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	468 n = min(n, limit)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	469 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	470 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	471 def nreadahead():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	472 return 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	473 if limit is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	474 limit = -1
53367 c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	475 elif not isinstance(limit, int):
c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	476 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	477 res = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	478 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	479 b = self.read(nreadahead())
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	480 if not b:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	481 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	482 res += b
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	483 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	484 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	485 return bytes(res)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	486
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	487 def __iter__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	488 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	489 return self
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	490
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	491 def __next__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	492 line = self.readline()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	493 if not line:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	494 raise StopIteration
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	495 return line
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 readlines(self, hint=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	498 """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	499
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	500 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	501 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	502 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	503 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	504 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	505 return list(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	506 n = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	507 lines = []
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	508 for line in self:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	509 lines.append(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	510 n += len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	511 if n >= hint:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	512 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	513 return lines
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	514
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	515 def writelines(self, lines):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	516 self._checkClosed()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	517 for line in lines:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	518 self.write(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	519
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	520 io.IOBase.register(IOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	521
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	522
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	523 class RawIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	524
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	525 """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	526
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	527 # 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	528 # 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	529 # 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	530 # more efficient than read().
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	531
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	532 # (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	533 # 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	534 # 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	535 # 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	536
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	537 def read(self, n=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	538 """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	539
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	540 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	541 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	542 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	543 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	544 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	545 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	546 return self.readall()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	547 b = bytearray(n.__index__())
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	548 n = self.readinto(b)
64751 071bd8f3535a Merged revisions 84814 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 61183 diff changeset	549 if n is None:
071bd8f3535a Merged revisions 84814 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 61183 diff changeset	550 return None
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	551 del b[n:]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	552 return bytes(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	553
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	554 def readall(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	555 """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	556 res = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	557 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	558 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	559 if not data:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	560 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	561 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	562 if res:
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	563 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	564 else:
4a7118cff1d3 Issue #12175: RawIOBase.readall() now returns None if read() returns None. Victor Stinner <victor.stinner@haypocalc.com> parents: 67572 diff changeset	565 # 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	566 return data
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	567
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	568 def readinto(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	569 """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	570
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	571 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	572 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	573 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	574 self._unsupported("readinto")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	575
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	576 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	577 """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	578
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	579 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	580 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	581 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	582
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	583 io.RawIOBase.register(RawIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	584 from _io import FileIO
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	585 RawIOBase.register(FileIO)
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
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	588 class BufferedIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	589
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	590 """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	591
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	592 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	593 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	594 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	595
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	596 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	597 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	598 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	599 return None.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	600
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	601 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	602 implementation, but wrap one.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	603 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	604
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	605 def read(self, n=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	606 """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	607
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	608 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	609 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	610
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	611 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	612 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	613 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	614 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	615 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	616 EOF is imminent.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	617
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	618 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	619
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	620 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	621 data at the moment.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	622 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	623 self._unsupported("read")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	624
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	625 def read1(self, n=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	626 """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	627 where n is an int.
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	628 """
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	629 self._unsupported("read1")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	630
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	631 def readinto(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	632 """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	633
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	634 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	635 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	636
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	637 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	638
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	639 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	640 data at the moment.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	641 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	642 # 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	643 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	644 n = len(data)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	645 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	646 b[:n] = data
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	647 except TypeError as err:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	648 import array
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	649 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	650 raise err
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	651 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	652 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	653
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	654 def write(self, b):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	655 """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	656
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	657 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	658 len(b).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	659
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	660 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	661 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	662 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	663 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	664
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	665 def detach(self):
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	666 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	667 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	668
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	669 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	670 state.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	671 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	672 self._unsupported("detach")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	673
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	674 io.BufferedIOBase.register(BufferedIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	675
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	676
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	677 class _BufferedIOMixin(BufferedIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	678
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	679 """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	680
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	681 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	682 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	683 write().
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
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	686 def __init__(self, raw):
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	687 self._raw = raw
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	688
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	689 ### Positioning ###
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 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	692 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	693 if new_position < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	694 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	695 return new_position
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 tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	698 pos = self.raw.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	699 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	700 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	701 return pos
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 truncate(self, pos=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	704 # 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	705 # 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	706 # file state.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	707 self.flush()
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 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	710 pos = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	711 # 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	712 # XXX directly to truncate?
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	713 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	714
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	715 ### Flush and close ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	716
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	717 def flush(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	718 if self.closed:
ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	719 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	720 self.raw.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	721
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	722 def close(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	723 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	724 try:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	725 # 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	726 self.flush()
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	727 finally:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	728 self.raw.close()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	729
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	730 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	731 if self.raw is None:
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	732 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	733 self.flush()
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	734 raw = self._raw
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	735 self._raw = None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	736 return raw
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	737
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	738 ### Inquiries ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	739
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	740 def seekable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	741 return self.raw.seekable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	742
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	743 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	744 return self.raw.readable()
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 writable(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.writable()
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 @property
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	750 def raw(self):
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	751 return self._raw
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	752
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	753 @property
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	754 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	755 return self.raw.closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	756
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	757 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	758 def name(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	759 return self.raw.name
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	760
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	761 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	762 def mode(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	763 return self.raw.mode
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	764
65990 571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	765 def __getstate__(self):
571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	766 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	767 .format(self.__class__.__name__))
571d317b4cd5 Issue #10180: Pickling file objects is now explicitly forbidden, since Antoine Pitrou <solipsis@pitrou.net> parents: 64748 diff changeset	768
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	769 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	770 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	771 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	772 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	773 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	774 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	775 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	776 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	777
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	778 ### Lower-level APIs ###
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	779
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	780 def fileno(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	781 return self.raw.fileno()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	782
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	783 def isatty(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	784 return self.raw.isatty()
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
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	787 class BytesIO(BufferedIOBase):
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 """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	790
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	791 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	792 buf = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	793 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	794 buf += initial_bytes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	795 self._buffer = buf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	796 self._pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	797
55398 538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	798 def __getstate__(self):
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	799 if self.closed:
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	800 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	801 return self.__dict__.copy()
538850b38931 Issue #6218: Make io.BytesIO and io.StringIO picklable. Alexandre Vassalotti <alexandre@peadrop.com> parents: 55609 diff changeset	802
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	803 def getvalue(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	804 """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	805 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	806 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	807 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	808 return bytes(self._buffer)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	809
64496 21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	810 def getbuffer(self):
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	811 """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	812 """
21405812f312 Issue #5506: BytesIO objects now have a getbuffer() method exporting a Antoine Pitrou <solipsis@pitrou.net> parents: 64478 diff changeset	813 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	814
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	815 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	816 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	817 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	818 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	819 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	820 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	821 n = len(self._buffer)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	822 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	823 return b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	824 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	825 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	826 self._pos = newpos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	827 return bytes(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	828
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	829 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	830 """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	831 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	832 return self.read(n)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	833
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	834 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	835 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	836 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	837 if isinstance(b, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	838 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	839 n = len(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	840 if n == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	841 return 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	842 pos = self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	843 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	844 # 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	845 # 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	846 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	847 self._buffer += padding
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	848 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	849 self._pos += n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	850 return n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	851
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	852 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	853 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	854 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	855 try:
59588 6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	856 pos.__index__
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	857 except AttributeError as err:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	858 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	859 if whence == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	860 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	861 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	862 self._pos = pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	863 elif whence == 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	864 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	865 elif whence == 2:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	866 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	867 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	868 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	869 return self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	870
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	871 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	872 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	873 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	874 return self._pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	875
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	876 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	877 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	878 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	879 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	880 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	881 else:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	882 try:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	883 pos.__index__
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	884 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	885 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	886 if pos < 0:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	887 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	888 del self._buffer[pos:]
58631 d887db501a22 Merged revisions 77895-77896 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 57792 diff changeset	889 return pos
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	890
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	891 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	892 return True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	893
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	894 def writable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	895 return True
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 seekable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	898 return True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	899
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	900
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	901 class BufferedReader(_BufferedIOMixin):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	902
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	903 """BufferedReader(raw[, buffer_size])
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	904
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	905 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	906
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	907 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	908 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	909 is used.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	910 """
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 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	913 """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	914 """
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	915 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	916 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	917
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	918 _BufferedIOMixin.__init__(self, raw)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	919 if buffer_size <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	920 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	921 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	922 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	923 self._read_lock = Lock()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	924
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	925 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	926 self._read_buf = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	927 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	928
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	929 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	930 """Read n bytes.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	931
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	932 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	933 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	934 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	935 block.
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 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	938 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	939 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	940 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	941
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	942 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	943 nodata_val = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	944 empty_values = (b"", None)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	945 buf = self._read_buf
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	946 pos = self._read_pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	947
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	948 # 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	949 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	950 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	951 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	952 current_size = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	953 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	954 # 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	955 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	956 chunk = self.raw.read()
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	957 except IOError as e:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	958 if e.errno != EINTR:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	959 raise
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	960 continue
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	961 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	962 nodata_val = chunk
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	963 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	964 current_size += len(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	965 chunks.append(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	966 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	967
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	968 # 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	969 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	970 if n <= avail:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	971 # 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	972 self._read_pos += n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	973 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	974 # 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	975 # 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	976 chunks = [buf[pos:]]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	977 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	978 while avail < n:
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	979 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	980 chunk = self.raw.read(wanted)
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	981 except IOError as e:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	982 if e.errno != EINTR:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	983 raise
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	984 continue
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	985 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	986 nodata_val = chunk
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	987 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	988 avail += len(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	989 chunks.append(chunk)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	990 # 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	991 # read() would have blocked.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	992 n = min(n, avail)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	993 out = b"".join(chunks)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	994 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	995 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	996 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	997
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	998 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	999 """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	1000
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1001 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	1002 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	1003 than self.buffer_size.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1004 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1005 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1006 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	1007
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1008 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	1009 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	1010 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	1011 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	1012 to_read = self.buffer_size - have
68027 66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1013 while True:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1014 try:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1015 current = self.raw.read(to_read)
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1016 except IOError as e:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1017 if e.errno != EINTR:
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1018 raise
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1019 continue
66ed71a6e29a Merged revisions 88610 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 67580 diff changeset	1020 break
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1021 if current:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1022 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	1023 self._read_pos = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1024 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	1025
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1026 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1027 """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	1028 # 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	1029 # 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	1030 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1031 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	1032 if n == 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1033 return b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1034 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1035 self._peek_unlocked(1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1036 return self._read_unlocked(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1037 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	1038
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1039 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1040 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	1041
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1042 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	1043 if not (0 <= whence <= 2):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1044 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	1045 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1046 if whence == 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1047 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	1048 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	1049 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1050 return pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1051
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1052 class BufferedWriter(_BufferedIOMixin):
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 """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	1055
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1056 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	1057 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	1058 DEFAULT_BUFFER_SIZE.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1059 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1060
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1061 _warning_stack_offset = 2
cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1062
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1063 def __init__(self, raw,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1064 buffer_size=DEFAULT_BUFFER_SIZE, max_buffer_size=None):
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1065 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	1066 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	1067
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1068 _BufferedIOMixin.__init__(self, raw)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1069 if buffer_size <= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1070 raise ValueError("invalid buffer size")
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1071 if max_buffer_size is not None:
cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1072 warnings.warn("max_buffer_size is deprecated", DeprecationWarning,
cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1073 self._warning_stack_offset)
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1074 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	1075 self._write_buf = bytearray()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1076 self._write_lock = Lock()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1077
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1078 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1079 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1080 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	1081 if isinstance(b, str):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1082 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	1083 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1084 # 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	1085 # partial writes
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1086 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	1087 # 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	1088 # 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	1089 self._flush_unlocked()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1090 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	1091 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	1092 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	1093 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	1094 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1095 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1096 except BlockingIOError as e:
52038 1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1097 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	1098 # 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	1099 # write and cut back our buffer.
1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1100 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	1101 written -= overage
52038 1f9de53983c1 remove usage of the deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52023 diff changeset	1102 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	1103 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	1104 return written
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1105
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1106 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	1107 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1108 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1109 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1110 pos = self.raw.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1111 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	1112
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1113 def flush(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1114 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1115 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1116
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1117 def _flush_unlocked(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1118 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1119 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	1120 while self._write_buf:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1121 try:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1122 n = self.raw.write(self._write_buf)
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1123 except BlockingIOError:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1124 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	1125 "should not raise BlockingIOError")
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1126 except IOError as e:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1127 if e.errno != EINTR:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1128 raise
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1129 continue
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1130 if n is None:
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1131 raise BlockingIOError(
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1132 errno.EAGAIN,
ac2c4c62b486 Issue #13322: Fix BufferedWriter.write() to ensure that BlockingIOError is Antoine Pitrou <solipsis@pitrou.net> parents: 73319 diff changeset	1133 "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	1134 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	1135 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	1136 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	1137
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1138 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1139 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	1140
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1141 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	1142 if not (0 <= whence <= 2):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1143 raise ValueError("invalid whence")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1144 with self._write_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1145 self._flush_unlocked()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1146 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	1147
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1148
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1149 class BufferedRWPair(BufferedIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1150
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1151 """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	1152
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1153 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	1154 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	1155 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	1156
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1157 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	1158 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	1159 DEFAULT_BUFFER_SIZE.
51991 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
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1162 # 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	1163 # objects) is questionable.
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 def __init__(self, reader, writer,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1166 buffer_size=DEFAULT_BUFFER_SIZE, max_buffer_size=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1167 """Constructor.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1168
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1169 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	1170 """
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1171 if max_buffer_size is not None:
cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1172 warnings.warn("max_buffer_size is deprecated", DeprecationWarning, 2)
53253 d74b9a8e66f6 Issue #5734: BufferedRWPair was poorly tested and had several glaring bugs. Antoine Pitrou <solipsis@pitrou.net> parents: 53230 diff changeset	1173
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
52344 cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1230 _warning_stack_offset = 3
cc13cc224ff5 officially deprecated max_buffer_size Benjamin Peterson <benjamin@python.org> parents: 52247 diff changeset	1231
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1232 def __init__(self, raw,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1233 buffer_size=DEFAULT_BUFFER_SIZE, max_buffer_size=None):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1234 raw._checkSeekable()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1235 BufferedReader.__init__(self, raw, buffer_size)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1236 BufferedWriter.__init__(self, raw, buffer_size, max_buffer_size)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1237
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1238 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	1239 if not (0 <= whence <= 2):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1240 raise ValueError("invalid whence")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1241 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1242 if self._read_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1243 # Undo read ahead.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1244 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1245 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	1246 # 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	1247 # 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	1248 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	1249 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1250 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1251 if pos < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1252 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	1253 return pos
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1254
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1255 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1256 if self._write_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1257 return BufferedWriter.tell(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1258 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1259 return BufferedReader.tell(self)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1260
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1261 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	1262 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1263 pos = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1264 # 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	1265 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	1266
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1267 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	1268 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1269 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1270 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1271 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	1272
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1273 def readinto(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1274 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1275 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	1276
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1277 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	1278 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1279 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	1280
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1281 def read1(self, n):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1282 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1283 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	1284
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1285 def write(self, b):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1286 if self._read_buf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1287 # Undo readahead
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1288 with self._read_lock:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1289 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	1290 self._reset_read_buf()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1291 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	1292
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1293
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1294 class TextIOBase(IOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1295
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1296 """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	1297
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1298 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	1299 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	1300 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	1301 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1302
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	1303 def read(self, n=-1):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1304 """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	1305
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1306 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	1307 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	1308
7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1309 Returns a string.
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1310 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1311 self._unsupported("read")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1312
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1313 def write(self, s):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1314 """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	1315 self._unsupported("write")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1316
67576 cbdc8b1e6bd3 More PEP 8: no space around "=" in argument lists. Georg Brandl <georg@python.org> parents: 67574 diff changeset	1317 def truncate(self, pos=None):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1318 """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	1319 self._unsupported("truncate")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1320
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1321 def readline(self):
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1322 """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	1323
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1324 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	1325 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1326 self._unsupported("readline")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1327
67572 efdf25617b7c Backport 87978: Do not expose function type annotations in the standard library. Raymond Hettinger <python@rcn.com> parents: 67074 diff changeset	1328 def detach(self):
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1329 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1330 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	1331
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1332 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	1333 unusable state.
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1334 """
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1335 self._unsupported("detach")
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1336
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1337 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1338 def encoding(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1339 """Subclasses should override."""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1340 return None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1341
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1342 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1343 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1344 """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	1345
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1346 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	1347
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1348 Subclasses should override.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1349 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1350 return None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1351
54599 1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1352 @property
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1353 def errors(self):
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1354 """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	1355
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1356 Subclasses should override."""
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1357 return None
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	1358
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1359 io.TextIOBase.register(TextIOBase)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1360
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1361
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1362 class IncrementalNewlineDecoder(codecs.IncrementalDecoder):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1363 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	1364 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	1365 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	1366 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	1367 one piece.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1368 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1369 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	1370 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	1371 self.translate = translate
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1372 self.decoder = decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1373 self.seennl = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1374 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1375
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1376 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	1377 # 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	1378 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	1379 output = input
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1380 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1381 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	1382 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	1383 output = "\r" + output
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1384 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1385
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1386 # 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	1387 # 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	1388 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	1389 output = output[:-1]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1390 self.pendingcr = True
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1391
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1392 # 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	1393 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	1394 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	1395 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	1396 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	1397 \| (crlf and self._CRLF)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1398
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1399 if self.translate:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1400 if crlf:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1401 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	1402 if cr:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1403 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	1404
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1405 return output
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1406
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1407 def getstate(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1408 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	1409 buf = b""
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1410 flag = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1411 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1412 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	1413 flag <<= 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1414 if self.pendingcr:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1415 flag \|= 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1416 return buf, flag
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1417
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1418 def setstate(self, state):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1419 buf, flag = state
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1420 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	1421 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	1422 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	1423
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1424 def reset(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1425 self.seennl = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1426 self.pendingcr = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1427 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	1428 self.decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1429
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1430 _LF = 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1431 _CR = 2
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1432 _CRLF = 4
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1433
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1434 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1435 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1436 return (None,
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1437 "\n",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1438 "\r",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1439 ("\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",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1441 ("\n", "\r\n"),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1442 ("\r", "\r\n"),
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1443 ("\r", "\n", "\r\n")
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1444 )[self.seennl]
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
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1447 class TextIOWrapper(TextIOBase):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1448
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1449 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	1450
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1451 encoding gives the name of the encoding that the stream will be
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1452 decoded or encoded with. It defaults to locale.getpreferredencoding.
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 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	1455 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	1456
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1457 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	1458 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	1459 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	1460 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	1461 caller. Conversely, on output, '\n' is translated to the system
73319 ca4c7543c823 Fix typo Éric Araujo <merwok@netwok.org> parents: 71482 diff changeset	1462 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	1463 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	1464 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	1465 newline.
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 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	1468 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	1469 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1470
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1471 _CHUNK_SIZE = 2048
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1472
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:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1491 encoding = locale.getpreferredencoding()
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')
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1518
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	1519 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	1520 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	1521 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	1522 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	1523 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	1524 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	1525 # 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	1526 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	1527
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1528 # 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	1529 # 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	1530 # 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	1531 # 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	1532
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1533 # Naming convention:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1534 # - "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	1535 # - "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	1536
52078 1045fd63fa73 give TextIOWrapper a repr that tells you the encoding Benjamin Peterson <benjamin@python.org> parents: 52038 diff changeset	1537 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	1538 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	1539 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	1540 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	1541 except AttributeError:
67500 f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1542 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	1543 else:
67500 f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1544 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	1545 try:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1546 mode = self.mode
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1547 except AttributeError:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1548 pass
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1549 else:
f8c683184aff Issue #10872: The repr() of TextIOWrapper objects now includes the mode Antoine Pitrou <solipsis@pitrou.net> parents: 67073 diff changeset	1550 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	1551 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	1552
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1553 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1554 def encoding(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1555 return self._encoding
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1556
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1557 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1558 def errors(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1559 return self._errors
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1560
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1561 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1562 def line_buffering(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1563 return self._line_buffering
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1564
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1565 @property
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1566 def buffer(self):
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1567 return self._buffer
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1568
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1569 def seekable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1570 return self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1571
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1572 def readable(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1573 return self.buffer.readable()
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 writable(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.writable()
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 flush(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1579 self.buffer.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1580 self._telling = self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1581
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1582 def close(self):
61183 ca01abd8ad87 Merged revisions 80722 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 58631 diff changeset	1583 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	1584 self.flush()
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1585 self.buffer.close()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1586
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1587 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1588 def closed(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1589 return self.buffer.closed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1590
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1591 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1592 def name(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1593 return self.buffer.name
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1594
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1595 def fileno(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.fileno()
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 isatty(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.isatty()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1600
67574 8719dd712384 Issue 10899: Remove function type annotations from the stdlib Raymond Hettinger <python@rcn.com> parents: 67571 diff changeset	1601 def write(self, s):
67580 7cbb5f3b6954 Issue #10899: Move function type annotations into docstrings. Raymond Hettinger <python@rcn.com> parents: 67576 diff changeset	1602 '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	1603 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1604 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	1605 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	1606 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	1607 s.__class__.__name__)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1608 length = len(s)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1609 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	1610 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	1611 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	1612 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	1613 # 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	1614 b = encoder.encode(s)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1615 self.buffer.write(b)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1616 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	1617 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1618 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1619 if self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1620 self._decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1621 return length
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1622
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1623 def _get_encoder(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1624 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	1625 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	1626 return self._encoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1627
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1628 def _get_decoder(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1629 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	1630 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	1631 if self._readuniversal:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1632 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	1633 self._decoder = decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1634 return decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1635
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1636 # 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	1637 # 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	1638 # 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	1639 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	1640 """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	1641 self._decoded_chars = chars
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1642 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	1643
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1644 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	1645 """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	1646 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	1647 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1648 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	1649 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1650 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	1651 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	1652 return chars
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1653
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1654 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	1655 """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	1656 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	1657 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	1658 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	1659
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1660 def _read_chunk(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1661 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1662 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	1663 """
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 # 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	1666 # 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	1667 # 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	1668 # 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	1669 # converted.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1670
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1671 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	1672 raise ValueError("no decoder")
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._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1675 # 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	1676 # 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	1677
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1678 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	1679 # 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	1680 # 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	1681
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1682 # 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	1683 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	1684 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	1685 else:
9144014028f3 Issue #12591: Allow io.TextIOWrapper to work with raw IO objects (without Antoine Pitrou <solipsis@pitrou.net> parents: 70386 diff changeset	1686 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	1687 eof = not input_chunk
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1688 self._set_decoded_chars(self._decoder.decode(input_chunk, eof))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1689
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1690 if self._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1691 # 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	1692 # 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	1693 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	1694
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1695 return not eof
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1696
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1697 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	1698 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	1699 # 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	1700 # 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	1701 # 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	1702 # 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	1703 # 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	1704 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	1705 (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	1706
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1707 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	1708 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	1709 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	1710 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	1711 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	1712 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	1713
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1714 def tell(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1715 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	1716 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	1717 if not self._telling:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1718 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	1719 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1720 position = self.buffer.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1721 decoder = self._decoder
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1722 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	1723 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1724 # This should never happen.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1725 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	1726 return position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1727
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1728 # 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	1729 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	1730 position -= len(next_input)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1731
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1732 # 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	1733 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	1734 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	1735 # 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	1736 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	1737
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1738 # 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	1739 # 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	1740 saved_state = decoder.getstate()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1741 try:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1742 # Note our initial start point.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1743 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	1744 start_pos = position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1745 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	1746 need_eof = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1747
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1748 # 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	1749 # 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	1750 # (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	1751 # can safely start from there and advance to this location).
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1752 next_byte = bytearray(1)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1753 for next_byte[0] in next_input:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1754 bytes_fed += 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1755 chars_decoded += len(decoder.decode(next_byte))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1756 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	1757 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	1758 # 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	1759 start_pos += bytes_fed
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1760 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	1761 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	1762 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	1763 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1764 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1765 # 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	1766 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	1767 need_eof = 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1768 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	1769 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	1770
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1771 # 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	1772 return self._pack_cookie(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1773 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	1774 finally:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1775 decoder.setstate(saved_state)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1776
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1777 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	1778 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1779 if pos is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1780 pos = self.tell()
58631 d887db501a22 Merged revisions 77895-77896 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 57792 diff changeset	1781 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	1782
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1783 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1784 if self.buffer is None:
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1785 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	1786 self.flush()
67074 5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1787 buffer = self._buffer
5cf8555e5be5 Merged revisions 87427 via svnmerge from Antoine Pitrou <solipsis@pitrou.net> parents: 64751 diff changeset	1788 self._buffer = None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1789 return buffer
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	1790
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1791 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	1792 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1793 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	1794 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	1795 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	1796 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	1797 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	1798 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	1799 # 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	1800 # 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	1801 whence = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1802 cookie = self.tell()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1803 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	1804 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	1805 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	1806 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1807 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	1808 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1809 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1810 if self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1811 self._decoder.reset()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1812 return position
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1813 if whence != 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1814 raise ValueError("invalid whence (%r, should be 0, 1 or 2)" %
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1815 (whence,))
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1816 if cookie < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1817 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	1818 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1819
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1820 # 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	1821 # 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	1822 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	1823 self._unpack_cookie(cookie)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1824
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1825 # 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	1826 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	1827 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1828 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1829
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1830 # 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	1831 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	1832 self._decoder.reset()
33e9a145fd38 fix #4862 in _pyio: reset the decoder on seek(0) Benjamin Peterson <benjamin@python.org> parents: 51991 diff changeset	1833 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	1834 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	1835 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	1836 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	1837
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1838 if chars_to_skip:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1839 # 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	1840 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	1841 self._set_decoded_chars(
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1842 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	1843 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	1844
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1845 # 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	1846 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	1847 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	1848 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	1849
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	1850 # 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	1851 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	1852 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	1853 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	1854 # 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	1855 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	1856 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	1857 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	1858 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	1859 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	1860 encoder.reset()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1861 return cookie
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 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	1864 self._checkReadable()
51991 3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1865 if n is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1866 n = -1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1867 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	1868 try:
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1869 n.__index__
6774e8c6c39f Only the parts which are relevant for 3.x branch. Florent Xicluna <florent.xicluna@gmail.com> parents: 58629 diff changeset	1870 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	1871 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	1872 if n < 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1873 # Read everything.
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1874 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	1875 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	1876 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1877 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1878 return result
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1879 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1880 # 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	1881 eof = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1882 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	1883 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	1884 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	1885 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	1886 return result
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 def __next__(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1889 self._telling = False
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1890 line = self.readline()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1891 if not line:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1892 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1893 self._telling = self._seekable
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1894 raise StopIteration
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1895 return line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1896
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1897 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	1898 if self.closed:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1899 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	1900 if limit is None:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1901 limit = -1
53367 c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	1902 elif not isinstance(limit, int):
c62cc2a5764b readline() args must be an int #3521 Benjamin Peterson <benjamin@python.org> parents: 53253 diff changeset	1903 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	1904
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1905 # 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	1906 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	1907
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1908 start = 0
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1909 # 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	1910 if not self._decoder:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1911 self._get_decoder()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1912
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1913 pos = endpos = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1914 while True:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1915 if self._readtranslate:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1916 # 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	1917 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	1918 if pos >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1919 endpos = pos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1920 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1921 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1922 start = len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1923
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1924 elif self._readuniversal:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1925 # 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	1926 # 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	1927
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1928 # 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	1929 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	1930 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	1931 if crpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1932 if nlpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1933 # Nothing found
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1934 start = len(line)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1935 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1936 # Found \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1937 endpos = nlpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1938 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1939 elif nlpos == -1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1940 # Found lone \r
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1941 endpos = crpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1942 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1943 elif nlpos < crpos:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1944 # Found \n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1945 endpos = nlpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1946 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1947 elif nlpos == crpos + 1:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1948 # Found \r\n
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1949 endpos = crpos + 2
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1950 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1951 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1952 # Found \r
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1953 endpos = crpos + 1
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1954 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1955 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1956 # non-universal
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1957 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	1958 if pos >= 0:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1959 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	1960 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1961
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1962 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	1963 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	1964 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1965
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1966 # 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	1967 while self._read_chunk():
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1968 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1969 break
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1970 if self._decoded_chars:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1971 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	1972 else:
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1973 # end of file
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1974 self._set_decoded_chars('')
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1975 self._snapshot = None
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1976 return line
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1977
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1978 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	1979 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	1980
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1981 # 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	1982 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	1983 return line[:endpos]
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1984
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1985 @property
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1986 def newlines(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1987 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	1988
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1989
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1990 class StringIO(TextIOWrapper):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1991 """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	1992
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1993 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	1994 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	1995 """
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1996
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	1997 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	1998 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	1999 encoding="utf-8",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2000 errors="strict",
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2001 newline=newline)
52816 61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2002 # 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	2003 # C version, even under Windows.
61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2004 if newline is None:
61b511d05ee9 Fix test_memoryio under Windows Antoine Pitrou <solipsis@pitrou.net> parents: 52702 diff changeset	2005 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	2006 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	2007 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	2008 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	2009 .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	2010 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	2011 self.write(initial_value)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2012 self.seek(0)
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2013
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2014 def getvalue(self):
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2015 self.flush()
3049ac17e256 merge the io-c branch: C implementation of the io module Benjamin Peterson <benjamin@python.org> parents: diff changeset	2016 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	2017
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2018 def __repr__(self):
cf093a763053 hack StringIO's repr, so it doesn't give an encoding Benjamin Peterson <benjamin@python.org> parents: 52078 diff changeset	2019 # 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	2020 # 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	2021 return object.__repr__(self)
52247 2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2022
2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2023 @property
54599 1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2024 def errors(self):
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2025 return None
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2026
1f8d98720acc give the C implementation of TextIOWrapper the errors property #6217 Benjamin Peterson <benjamin@python.org> parents: 54288 diff changeset	2027 @property
52247 2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2028 def encoding(self):
2a3af211f0e1 stringio doesn't have an encoding Benjamin Peterson <benjamin@python.org> parents: 52079 diff changeset	2029 return None
53649 bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2030
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2031 def detach(self):
bc04cebca7e6 implement a detach() method for BufferedIOBase and TextIOBase #5883 Benjamin Peterson <benjamin@python.org> parents: 53367 diff changeset	2032 # 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	2033 self._unsupported("detach")

Mercurial > cpython-lru_cache-weakref

annotate Lib/_pyio.py @ 78069:a8aa77458e12 3.2