blob: 358a654a98ca5847144bc730711eb59001948154 [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001/*
2 An implementation of Buffered I/O as defined by PEP 3116 - "New I/O"
Antoine Pitrou3486a982011-05-12 01:57:53 +02003
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00004 Classes defined here: BufferedIOBase, BufferedReader, BufferedWriter,
5 BufferedRandom.
Antoine Pitrou3486a982011-05-12 01:57:53 +02006
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00007 Written by Amaury Forgeot d'Arc and Antoine Pitrou
8*/
9
10#define PY_SSIZE_T_CLEAN
11#include "Python.h"
Eric Snow2ebc5ce2017-09-07 23:51:28 -060012#include "internal/pystate.h"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000013#include "structmember.h"
14#include "pythread.h"
15#include "_iomodule.h"
16
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030017/*[clinic input]
18module _io
19class _io._BufferedIOBase "PyObject *" "&PyBufferedIOBase_Type"
20class _io._Buffered "buffered *" "&PyBufferedIOBase_Type"
21class _io.BufferedReader "buffered *" "&PyBufferedReader_Type"
22class _io.BufferedWriter "buffered *" "&PyBufferedWriter_Type"
23class _io.BufferedRWPair "rwpair *" "&PyBufferedRWPair_Type"
24class _io.BufferedRandom "buffered *" "&PyBufferedRandom_Type"
25[clinic start generated code]*/
26/*[clinic end generated code: output=da39a3ee5e6b4b0d input=59460b9c5639984d]*/
27
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020028_Py_IDENTIFIER(close);
29_Py_IDENTIFIER(_dealloc_warn);
30_Py_IDENTIFIER(flush);
31_Py_IDENTIFIER(isatty);
Martin v. Löwis767046a2011-10-14 15:35:36 +020032_Py_IDENTIFIER(mode);
33_Py_IDENTIFIER(name);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020034_Py_IDENTIFIER(peek);
35_Py_IDENTIFIER(read);
36_Py_IDENTIFIER(read1);
37_Py_IDENTIFIER(readable);
38_Py_IDENTIFIER(readinto);
Benjamin Petersona96fea02014-06-22 14:17:44 -070039_Py_IDENTIFIER(readinto1);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020040_Py_IDENTIFIER(writable);
41_Py_IDENTIFIER(write);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +020042
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000043/*
44 * BufferedIOBase class, inherits from IOBase.
45 */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +000046PyDoc_STRVAR(bufferediobase_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000047 "Base class for buffered IO objects.\n"
48 "\n"
49 "The main difference with RawIOBase is that the read() method\n"
50 "supports omitting the size argument, and does not have a default\n"
51 "implementation that defers to readinto().\n"
52 "\n"
53 "In addition, read(), readinto() and write() may raise\n"
54 "BlockingIOError if the underlying raw stream is in non-blocking\n"
55 "mode and not ready; unlike their raw counterparts, they will never\n"
56 "return None.\n"
57 "\n"
58 "A typical implementation should not inherit from a RawIOBase\n"
59 "implementation, but wrap one.\n"
60 );
61
62static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030063_bufferediobase_readinto_generic(PyObject *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000064{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000065 Py_ssize_t len;
66 PyObject *data;
67
Benjamin Petersona96fea02014-06-22 14:17:44 -070068 data = _PyObject_CallMethodId(self,
69 readinto1 ? &PyId_read1 : &PyId_read,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030070 "n", buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000071 if (data == NULL)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030072 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000073
74 if (!PyBytes_Check(data)) {
75 Py_DECREF(data);
76 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030077 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000078 }
79
Serhiy Storchakafff9a312017-03-21 08:53:25 +020080 len = PyBytes_GET_SIZE(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030081 if (len > buffer->len) {
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030082 PyErr_Format(PyExc_ValueError,
83 "read() returned too much data: "
84 "%zd bytes requested, %zd returned",
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030085 buffer->len, len);
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030086 Py_DECREF(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030087 return NULL;
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030088 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030089 memcpy(buffer->buf, PyBytes_AS_STRING(data), len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000090
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000091 Py_DECREF(data);
92
93 return PyLong_FromSsize_t(len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000094}
95
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030096/*[clinic input]
97_io._BufferedIOBase.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -070098 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030099 /
100[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700101
102static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300103_io__BufferedIOBase_readinto_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700104/*[clinic end generated code: output=8c8cda6684af8038 input=00a6b9a38f29830a]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700105{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300106 return _bufferediobase_readinto_generic(self, buffer, 0);
107}
108
109/*[clinic input]
110_io._BufferedIOBase.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700111 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300112 /
113[clinic start generated code]*/
114
115static PyObject *
116_io__BufferedIOBase_readinto1_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700117/*[clinic end generated code: output=358623e4fd2b69d3 input=ebad75b4aadfb9be]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300118{
119 return _bufferediobase_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -0700120}
121
122static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000123bufferediobase_unsupported(const char *message)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000124{
Antoine Pitrou712cb732013-12-21 15:51:54 +0100125 _PyIO_State *state = IO_STATE();
126 if (state != NULL)
127 PyErr_SetString(state->unsupported_operation, message);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000128 return NULL;
129}
130
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300131/*[clinic input]
132_io._BufferedIOBase.detach
133
134Disconnect this buffer from its underlying raw stream and return it.
135
136After the raw stream has been detached, the buffer is in an unusable
137state.
138[clinic start generated code]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000139
140static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300141_io__BufferedIOBase_detach_impl(PyObject *self)
142/*[clinic end generated code: output=754977c8d10ed88c input=822427fb58fe4169]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000143{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000144 return bufferediobase_unsupported("detach");
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000145}
146
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000147PyDoc_STRVAR(bufferediobase_read_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000148 "Read and return up to n bytes.\n"
149 "\n"
150 "If the argument is omitted, None, or negative, reads and\n"
151 "returns all data until EOF.\n"
152 "\n"
153 "If the argument is positive, and the underlying raw stream is\n"
154 "not 'interactive', multiple raw reads may be issued to satisfy\n"
155 "the byte count (unless EOF is reached first). But for\n"
156 "interactive raw streams (as well as sockets and pipes), at most\n"
157 "one raw read will be issued, and a short result does not imply\n"
158 "that EOF is imminent.\n"
159 "\n"
160 "Returns an empty bytes object on EOF.\n"
161 "\n"
162 "Returns None if the underlying raw stream was open in non-blocking\n"
163 "mode and no data is available at the moment.\n");
164
165static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000166bufferediobase_read(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000167{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000168 return bufferediobase_unsupported("read");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000169}
170
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000171PyDoc_STRVAR(bufferediobase_read1_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000172 "Read and return up to n bytes, with at most one read() call\n"
173 "to the underlying raw stream. A short result does not imply\n"
174 "that EOF is imminent.\n"
175 "\n"
176 "Returns an empty bytes object on EOF.\n");
177
178static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000179bufferediobase_read1(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000180{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000181 return bufferediobase_unsupported("read1");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000182}
183
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000184PyDoc_STRVAR(bufferediobase_write_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000185 "Write the given buffer to the IO stream.\n"
186 "\n"
Martin Panter6bb91f32016-05-28 00:41:57 +0000187 "Returns the number of bytes written, which is always the length of b\n"
188 "in bytes.\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000189 "\n"
190 "Raises BlockingIOError if the buffer is full and the\n"
191 "underlying raw stream cannot accept more data at the moment.\n");
192
193static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000194bufferediobase_write(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000195{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000196 return bufferediobase_unsupported("write");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000197}
198
199
Antoine Pitrou317def92017-12-13 01:39:26 +0100200typedef struct {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000201 PyObject_HEAD
202
203 PyObject *raw;
204 int ok; /* Initialized? */
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000205 int detached;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000206 int readable;
207 int writable;
Antoine Pitrou796564c2013-07-30 19:59:21 +0200208 char finalizing;
Antoine Pitrou3486a982011-05-12 01:57:53 +0200209
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000210 /* True if this is a vanilla Buffered object (rather than a user derived
211 class) *and* the raw stream is a vanilla FileIO object. */
212 int fast_closed_checks;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000213
214 /* Absolute position inside the raw stream (-1 if unknown). */
215 Py_off_t abs_pos;
216
217 /* A static buffer of size `buffer_size` */
218 char *buffer;
219 /* Current logical position in the buffer. */
220 Py_off_t pos;
221 /* Position of the raw stream in the buffer. */
222 Py_off_t raw_pos;
223
224 /* Just after the last buffered byte in the buffer, or -1 if the buffer
225 isn't ready for reading. */
226 Py_off_t read_end;
227
228 /* Just after the last byte actually written */
229 Py_off_t write_pos;
230 /* Just after the last byte waiting to be written, or -1 if the buffer
231 isn't ready for writing. */
232 Py_off_t write_end;
233
234 PyThread_type_lock lock;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200235 volatile unsigned long owner;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000236
237 Py_ssize_t buffer_size;
238 Py_ssize_t buffer_mask;
239
240 PyObject *dict;
241 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000242} buffered;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000243
244/*
245 Implementation notes:
Antoine Pitrou3486a982011-05-12 01:57:53 +0200246
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000247 * BufferedReader, BufferedWriter and BufferedRandom try to share most
248 methods (this is helped by the members `readable` and `writable`, which
249 are initialized in the respective constructors)
250 * They also share a single buffer for reading and writing. This enables
251 interleaved reads and writes without flushing. It also makes the logic
252 a bit trickier to get right.
253 * The absolute position of the raw stream is cached, if possible, in the
254 `abs_pos` member. It must be updated every time an operation is done
255 on the raw stream. If not sure, it can be reinitialized by calling
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000256 _buffered_raw_tell(), which queries the raw stream (_buffered_raw_seek()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000257 also does it). To read it, use RAW_TELL().
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000258 * Three helpers, _bufferedreader_raw_read, _bufferedwriter_raw_write and
259 _bufferedwriter_flush_unlocked do a lot of useful housekeeping.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000260
261 NOTE: we should try to maintain block alignment of reads and writes to the
262 raw stream (according to the buffer size), but for now it is only done
263 in read() and friends.
Antoine Pitrou3486a982011-05-12 01:57:53 +0200264
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000265*/
266
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000267/* These macros protect the buffered object against concurrent operations. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000268
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000269static int
270_enter_buffered_busy(buffered *self)
271{
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200272 int relax_locking;
273 PyLockStatus st;
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000274 if (self->owner == PyThread_get_thread_ident()) {
275 PyErr_Format(PyExc_RuntimeError,
276 "reentrant call inside %R", self);
277 return 0;
Antoine Pitrou5800b272009-11-01 12:05:48 +0000278 }
Eric Snow2ebc5ce2017-09-07 23:51:28 -0600279 relax_locking = _Py_IsFinalizing();
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000280 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200281 if (!relax_locking)
282 st = PyThread_acquire_lock(self->lock, 1);
283 else {
284 /* When finalizing, we don't want a deadlock to happen with daemon
285 * threads abruptly shut down while they owned the lock.
286 * Therefore, only wait for a grace period (1 s.).
287 * Note that non-daemon threads have already exited here, so this
288 * shouldn't affect carefully written threaded I/O code.
289 */
Steve Dower6baa0f92015-05-23 08:59:25 -0700290 st = PyThread_acquire_lock_timed(self->lock, (PY_TIMEOUT_T)1e6, 0);
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200291 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000292 Py_END_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200293 if (relax_locking && st != PY_LOCK_ACQUIRED) {
294 PyObject *msgobj = PyUnicode_FromFormat(
295 "could not acquire lock for %A at interpreter "
296 "shutdown, possibly due to daemon threads",
297 (PyObject *) self);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200298 const char *msg = PyUnicode_AsUTF8(msgobj);
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200299 Py_FatalError(msg);
300 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000301 return 1;
302}
303
304#define ENTER_BUFFERED(self) \
305 ( (PyThread_acquire_lock(self->lock, 0) ? \
306 1 : _enter_buffered_busy(self)) \
307 && (self->owner = PyThread_get_thread_ident(), 1) )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000308
309#define LEAVE_BUFFERED(self) \
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000310 do { \
311 self->owner = 0; \
312 PyThread_release_lock(self->lock); \
313 } while(0);
314
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000315#define CHECK_INITIALIZED(self) \
316 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000317 if (self->detached) { \
318 PyErr_SetString(PyExc_ValueError, \
319 "raw stream has been detached"); \
320 } else { \
321 PyErr_SetString(PyExc_ValueError, \
322 "I/O operation on uninitialized object"); \
323 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000324 return NULL; \
325 }
326
327#define CHECK_INITIALIZED_INT(self) \
328 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000329 if (self->detached) { \
330 PyErr_SetString(PyExc_ValueError, \
331 "raw stream has been detached"); \
332 } else { \
333 PyErr_SetString(PyExc_ValueError, \
334 "I/O operation on uninitialized object"); \
335 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000336 return -1; \
337 }
338
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000339#define IS_CLOSED(self) \
benfogle9703f092017-11-10 16:03:40 -0500340 (!self->buffer || \
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000341 (self->fast_closed_checks \
342 ? _PyFileIO_closed(self->raw) \
benfogle9703f092017-11-10 16:03:40 -0500343 : buffered_closed(self)))
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000344
345#define CHECK_CLOSED(self, error_msg) \
346 if (IS_CLOSED(self)) { \
347 PyErr_SetString(PyExc_ValueError, error_msg); \
348 return NULL; \
349 }
350
351
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000352#define VALID_READ_BUFFER(self) \
353 (self->readable && self->read_end != -1)
354
355#define VALID_WRITE_BUFFER(self) \
356 (self->writable && self->write_end != -1)
357
358#define ADJUST_POSITION(self, _new_pos) \
359 do { \
360 self->pos = _new_pos; \
361 if (VALID_READ_BUFFER(self) && self->read_end < self->pos) \
362 self->read_end = self->pos; \
363 } while(0)
364
365#define READAHEAD(self) \
366 ((self->readable && VALID_READ_BUFFER(self)) \
367 ? (self->read_end - self->pos) : 0)
368
369#define RAW_OFFSET(self) \
370 (((VALID_READ_BUFFER(self) || VALID_WRITE_BUFFER(self)) \
371 && self->raw_pos >= 0) ? self->raw_pos - self->pos : 0)
372
373#define RAW_TELL(self) \
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000374 (self->abs_pos != -1 ? self->abs_pos : _buffered_raw_tell(self))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000375
376#define MINUS_LAST_BLOCK(self, size) \
377 (self->buffer_mask ? \
378 (size & ~self->buffer_mask) : \
379 (self->buffer_size * (size / self->buffer_size)))
380
381
382static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000383buffered_dealloc(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000384{
Antoine Pitrou796564c2013-07-30 19:59:21 +0200385 self->finalizing = 1;
386 if (_PyIOBase_finalize((PyObject *) self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000387 return;
388 _PyObject_GC_UNTRACK(self);
389 self->ok = 0;
390 if (self->weakreflist != NULL)
391 PyObject_ClearWeakRefs((PyObject *)self);
392 Py_CLEAR(self->raw);
393 if (self->buffer) {
394 PyMem_Free(self->buffer);
395 self->buffer = NULL;
396 }
397 if (self->lock) {
398 PyThread_free_lock(self->lock);
399 self->lock = NULL;
400 }
401 Py_CLEAR(self->dict);
402 Py_TYPE(self)->tp_free((PyObject *)self);
403}
404
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200405static PyObject *
406buffered_sizeof(buffered *self, void *unused)
407{
408 Py_ssize_t res;
409
Serhiy Storchaka5c4064e2015-12-19 20:05:25 +0200410 res = _PyObject_SIZE(Py_TYPE(self));
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200411 if (self->buffer)
412 res += self->buffer_size;
413 return PyLong_FromSsize_t(res);
414}
415
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000416static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000417buffered_traverse(buffered *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000418{
419 Py_VISIT(self->raw);
420 Py_VISIT(self->dict);
421 return 0;
422}
423
424static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000425buffered_clear(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000426{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000427 self->ok = 0;
428 Py_CLEAR(self->raw);
429 Py_CLEAR(self->dict);
430 return 0;
431}
432
Antoine Pitroue033e062010-10-29 10:38:18 +0000433/* Because this can call arbitrary code, it shouldn't be called when
434 the refcount is 0 (that is, not directly from tp_dealloc unless
435 the refcount has been temporarily re-incremented). */
Matthias Klosebee33162010-11-16 20:07:51 +0000436static PyObject *
Antoine Pitroue033e062010-10-29 10:38:18 +0000437buffered_dealloc_warn(buffered *self, PyObject *source)
438{
439 if (self->ok && self->raw) {
440 PyObject *r;
Victor Stinner61bdb0d2016-12-09 15:39:28 +0100441 r = _PyObject_CallMethodIdObjArgs(self->raw, &PyId__dealloc_warn,
442 source, NULL);
Antoine Pitroue033e062010-10-29 10:38:18 +0000443 if (r)
444 Py_DECREF(r);
445 else
446 PyErr_Clear();
447 }
448 Py_RETURN_NONE;
449}
450
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000451/*
452 * _BufferedIOMixin methods
453 * This is not a class, just a collection of methods that will be reused
454 * by BufferedReader and BufferedWriter
455 */
456
457/* Flush and close */
458
459static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000460buffered_simple_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000461{
462 CHECK_INITIALIZED(self)
463 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_flush, NULL);
464}
465
466static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000467buffered_closed(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000468{
469 int closed;
470 PyObject *res;
471 CHECK_INITIALIZED_INT(self)
472 res = PyObject_GetAttr(self->raw, _PyIO_str_closed);
473 if (res == NULL)
474 return -1;
475 closed = PyObject_IsTrue(res);
476 Py_DECREF(res);
477 return closed;
478}
479
480static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000481buffered_closed_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000482{
483 CHECK_INITIALIZED(self)
484 return PyObject_GetAttr(self->raw, _PyIO_str_closed);
485}
486
487static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000488buffered_close(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000489{
Benjamin Peterson68623612012-12-20 11:53:11 -0600490 PyObject *res = NULL, *exc = NULL, *val, *tb;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000491 int r;
492
493 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000494 if (!ENTER_BUFFERED(self))
495 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000496
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000497 r = buffered_closed(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000498 if (r < 0)
499 goto end;
500 if (r > 0) {
501 res = Py_None;
502 Py_INCREF(res);
503 goto end;
504 }
Antoine Pitroue033e062010-10-29 10:38:18 +0000505
Antoine Pitrou796564c2013-07-30 19:59:21 +0200506 if (self->finalizing) {
Antoine Pitroue033e062010-10-29 10:38:18 +0000507 PyObject *r = buffered_dealloc_warn(self, (PyObject *) self);
508 if (r)
509 Py_DECREF(r);
510 else
511 PyErr_Clear();
512 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000513 /* flush() will most probably re-take the lock, so drop it first */
514 LEAVE_BUFFERED(self)
515 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000516 if (!ENTER_BUFFERED(self))
517 return NULL;
Benjamin Peterson68623612012-12-20 11:53:11 -0600518 if (res == NULL)
519 PyErr_Fetch(&exc, &val, &tb);
520 else
521 Py_DECREF(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000522
523 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_close, NULL);
524
Jesus Ceadc469452012-10-04 12:37:56 +0200525 if (self->buffer) {
526 PyMem_Free(self->buffer);
527 self->buffer = NULL;
528 }
529
Benjamin Peterson68623612012-12-20 11:53:11 -0600530 if (exc != NULL) {
Serhiy Storchakae2bd2a72014-10-08 22:31:52 +0300531 _PyErr_ChainExceptions(exc, val, tb);
532 Py_CLEAR(res);
Benjamin Peterson68623612012-12-20 11:53:11 -0600533 }
534
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000535end:
536 LEAVE_BUFFERED(self)
537 return res;
538}
539
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000540/* detach */
541
542static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000543buffered_detach(buffered *self, PyObject *args)
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000544{
545 PyObject *raw, *res;
546 CHECK_INITIALIZED(self)
547 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
548 if (res == NULL)
549 return NULL;
550 Py_DECREF(res);
551 raw = self->raw;
552 self->raw = NULL;
553 self->detached = 1;
554 self->ok = 0;
555 return raw;
556}
557
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000558/* Inquiries */
559
560static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000561buffered_seekable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000562{
563 CHECK_INITIALIZED(self)
564 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seekable, NULL);
565}
566
567static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000568buffered_readable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000569{
570 CHECK_INITIALIZED(self)
571 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readable, NULL);
572}
573
574static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000575buffered_writable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000576{
577 CHECK_INITIALIZED(self)
578 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_writable, NULL);
579}
580
581static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000582buffered_name_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000583{
584 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200585 return _PyObject_GetAttrId(self->raw, &PyId_name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000586}
587
588static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000589buffered_mode_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000590{
591 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200592 return _PyObject_GetAttrId(self->raw, &PyId_mode);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000593}
594
595/* Lower-level APIs */
596
597static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000598buffered_fileno(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000599{
600 CHECK_INITIALIZED(self)
601 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_fileno, NULL);
602}
603
604static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000605buffered_isatty(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000606{
607 CHECK_INITIALIZED(self)
608 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_isatty, NULL);
609}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000610
Antoine Pitrou243757e2010-11-05 21:15:39 +0000611/* Serialization */
612
613static PyObject *
614buffered_getstate(buffered *self, PyObject *args)
615{
616 PyErr_Format(PyExc_TypeError,
617 "cannot serialize '%s' object", Py_TYPE(self)->tp_name);
618 return NULL;
619}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000620
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000621/* Forward decls */
622static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100623_bufferedwriter_flush_unlocked(buffered *);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000624static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000625_bufferedreader_fill_buffer(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000626static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000627_bufferedreader_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000628static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000629_bufferedwriter_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000630static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +0200631_bufferedreader_peek_unlocked(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000632static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000633_bufferedreader_read_all(buffered *self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000634static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000635_bufferedreader_read_fast(buffered *self, Py_ssize_t);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000636static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000637_bufferedreader_read_generic(buffered *self, Py_ssize_t);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200638static Py_ssize_t
639_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000640
641/*
642 * Helpers
643 */
644
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100645/* Sets the current error to BlockingIOError */
646static void
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200647_set_BlockingIOError(const char *msg, Py_ssize_t written)
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100648{
649 PyObject *err;
Victor Stinnerace47d72013-07-18 01:41:08 +0200650 PyErr_Clear();
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100651 err = PyObject_CallFunction(PyExc_BlockingIOError, "isn",
652 errno, msg, written);
653 if (err)
654 PyErr_SetObject(PyExc_BlockingIOError, err);
655 Py_XDECREF(err);
656}
657
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000658/* Returns the address of the `written` member if a BlockingIOError was
659 raised, NULL otherwise. The error is always re-raised. */
660static Py_ssize_t *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000661_buffered_check_blocking_error(void)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000662{
663 PyObject *t, *v, *tb;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200664 PyOSErrorObject *err;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000665
666 PyErr_Fetch(&t, &v, &tb);
667 if (v == NULL || !PyErr_GivenExceptionMatches(v, PyExc_BlockingIOError)) {
668 PyErr_Restore(t, v, tb);
669 return NULL;
670 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200671 err = (PyOSErrorObject *) v;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000672 /* TODO: sanity check (err->written >= 0) */
673 PyErr_Restore(t, v, tb);
674 return &err->written;
675}
676
677static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000678_buffered_raw_tell(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000679{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000680 Py_off_t n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000681 PyObject *res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000682 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_tell, NULL);
683 if (res == NULL)
684 return -1;
685 n = PyNumber_AsOff_t(res, PyExc_ValueError);
686 Py_DECREF(res);
687 if (n < 0) {
688 if (!PyErr_Occurred())
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300689 PyErr_Format(PyExc_OSError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000690 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200691 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000692 return -1;
693 }
694 self->abs_pos = n;
695 return n;
696}
697
698static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000699_buffered_raw_seek(buffered *self, Py_off_t target, int whence)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000700{
701 PyObject *res, *posobj, *whenceobj;
702 Py_off_t n;
703
704 posobj = PyLong_FromOff_t(target);
705 if (posobj == NULL)
706 return -1;
707 whenceobj = PyLong_FromLong(whence);
708 if (whenceobj == NULL) {
709 Py_DECREF(posobj);
710 return -1;
711 }
712 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seek,
713 posobj, whenceobj, NULL);
714 Py_DECREF(posobj);
715 Py_DECREF(whenceobj);
716 if (res == NULL)
717 return -1;
718 n = PyNumber_AsOff_t(res, PyExc_ValueError);
719 Py_DECREF(res);
720 if (n < 0) {
721 if (!PyErr_Occurred())
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300722 PyErr_Format(PyExc_OSError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000723 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200724 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000725 return -1;
726 }
727 self->abs_pos = n;
728 return n;
729}
730
731static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000732_buffered_init(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000733{
734 Py_ssize_t n;
735 if (self->buffer_size <= 0) {
736 PyErr_SetString(PyExc_ValueError,
737 "buffer size must be strictly positive");
738 return -1;
739 }
740 if (self->buffer)
741 PyMem_Free(self->buffer);
742 self->buffer = PyMem_Malloc(self->buffer_size);
743 if (self->buffer == NULL) {
744 PyErr_NoMemory();
745 return -1;
746 }
Antoine Pitrouc881f152010-08-01 16:53:42 +0000747 if (self->lock)
748 PyThread_free_lock(self->lock);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000749 self->lock = PyThread_allocate_lock();
750 if (self->lock == NULL) {
751 PyErr_SetString(PyExc_RuntimeError, "can't allocate read lock");
752 return -1;
753 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000754 self->owner = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000755 /* Find out whether buffer_size is a power of 2 */
756 /* XXX is this optimization useful? */
757 for (n = self->buffer_size - 1; n & 1; n >>= 1)
758 ;
759 if (n == 0)
760 self->buffer_mask = self->buffer_size - 1;
761 else
762 self->buffer_mask = 0;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000763 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000764 PyErr_Clear();
765 return 0;
766}
767
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300768/* Return 1 if an OSError with errno == EINTR is set (and then
Antoine Pitrou707ce822011-02-25 21:24:11 +0000769 clears the error indicator), 0 otherwise.
770 Should only be called when PyErr_Occurred() is true.
771*/
Gregory P. Smith51359922012-06-23 23:55:39 -0700772int
773_PyIO_trap_eintr(void)
Antoine Pitrou707ce822011-02-25 21:24:11 +0000774{
775 static PyObject *eintr_int = NULL;
776 PyObject *typ, *val, *tb;
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300777 PyOSErrorObject *env_err;
Antoine Pitrou707ce822011-02-25 21:24:11 +0000778
779 if (eintr_int == NULL) {
780 eintr_int = PyLong_FromLong(EINTR);
781 assert(eintr_int != NULL);
782 }
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300783 if (!PyErr_ExceptionMatches(PyExc_OSError))
Antoine Pitrou707ce822011-02-25 21:24:11 +0000784 return 0;
785 PyErr_Fetch(&typ, &val, &tb);
786 PyErr_NormalizeException(&typ, &val, &tb);
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +0300787 env_err = (PyOSErrorObject *) val;
Antoine Pitrou707ce822011-02-25 21:24:11 +0000788 assert(env_err != NULL);
789 if (env_err->myerrno != NULL &&
790 PyObject_RichCompareBool(env_err->myerrno, eintr_int, Py_EQ) > 0) {
791 Py_DECREF(typ);
792 Py_DECREF(val);
793 Py_XDECREF(tb);
794 return 1;
795 }
796 /* This silences any error set by PyObject_RichCompareBool() */
797 PyErr_Restore(typ, val, tb);
798 return 0;
799}
800
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000801/*
802 * Shared methods and wrappers
803 */
804
805static PyObject *
Antoine Pitroue05565e2011-08-20 14:39:23 +0200806buffered_flush_and_rewind_unlocked(buffered *self)
807{
808 PyObject *res;
809
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100810 res = _bufferedwriter_flush_unlocked(self);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200811 if (res == NULL)
812 return NULL;
813 Py_DECREF(res);
814
815 if (self->readable) {
816 /* Rewind the raw stream so that its position corresponds to
817 the current logical position. */
818 Py_off_t n;
819 n = _buffered_raw_seek(self, -RAW_OFFSET(self), 1);
820 _bufferedreader_reset_buf(self);
821 if (n == -1)
822 return NULL;
823 }
824 Py_RETURN_NONE;
825}
826
827static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000828buffered_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000829{
830 PyObject *res;
831
832 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000833 CHECK_CLOSED(self, "flush of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000834
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000835 if (!ENTER_BUFFERED(self))
836 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200837 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000838 LEAVE_BUFFERED(self)
839
840 return res;
841}
842
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300843/*[clinic input]
844_io._Buffered.peek
845 size: Py_ssize_t = 0
846 /
847
848[clinic start generated code]*/
849
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000850static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300851_io__Buffered_peek_impl(buffered *self, Py_ssize_t size)
852/*[clinic end generated code: output=ba7a097ca230102b input=37ffb97d06ff4adb]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000853{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000854 PyObject *res = NULL;
855
856 CHECK_INITIALIZED(self)
Berker Peksagd10d6ae2015-05-12 17:01:05 +0300857 CHECK_CLOSED(self, "peek of closed file")
858
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000859 if (!ENTER_BUFFERED(self))
860 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000861
862 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200863 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000864 if (res == NULL)
865 goto end;
866 Py_CLEAR(res);
867 }
Victor Stinnerbc93a112011-06-01 00:01:24 +0200868 res = _bufferedreader_peek_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000869
870end:
871 LEAVE_BUFFERED(self)
872 return res;
873}
874
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300875/*[clinic input]
876_io._Buffered.read
Serhiy Storchaka762bf402017-03-30 09:15:31 +0300877 size as n: Py_ssize_t(accept={int, NoneType}) = -1
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300878 /
879[clinic start generated code]*/
880
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000881static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300882_io__Buffered_read_impl(buffered *self, Py_ssize_t n)
Serhiy Storchaka762bf402017-03-30 09:15:31 +0300883/*[clinic end generated code: output=f41c78bb15b9bbe9 input=7df81e82e08a68a2]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000884{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000885 PyObject *res;
886
887 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000888 if (n < -1) {
889 PyErr_SetString(PyExc_ValueError,
Martin Panterccb2c0e2016-10-20 23:48:14 +0000890 "read length must be non-negative or -1");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000891 return NULL;
892 }
893
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000894 CHECK_CLOSED(self, "read of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000895
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000896 if (n == -1) {
897 /* The number of bytes is unspecified, read until the end of stream */
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000898 if (!ENTER_BUFFERED(self))
899 return NULL;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000900 res = _bufferedreader_read_all(self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000901 }
902 else {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000903 res = _bufferedreader_read_fast(self, n);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200904 if (res != Py_None)
905 return res;
906 Py_DECREF(res);
907 if (!ENTER_BUFFERED(self))
908 return NULL;
909 res = _bufferedreader_read_generic(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000910 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000911
Antoine Pitroue05565e2011-08-20 14:39:23 +0200912 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000913 return res;
914}
915
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300916/*[clinic input]
917_io._Buffered.read1
Martin Panterccb2c0e2016-10-20 23:48:14 +0000918 size as n: Py_ssize_t = -1
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300919 /
920[clinic start generated code]*/
921
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000922static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300923_io__Buffered_read1_impl(buffered *self, Py_ssize_t n)
Martin Panterccb2c0e2016-10-20 23:48:14 +0000924/*[clinic end generated code: output=bcc4fb4e54d103a3 input=7d22de9630b61774]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000925{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300926 Py_ssize_t have, r;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000927 PyObject *res = NULL;
928
929 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000930 if (n < 0) {
Martin Panterccb2c0e2016-10-20 23:48:14 +0000931 n = self->buffer_size;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000932 }
Berker Peksagd10d6ae2015-05-12 17:01:05 +0300933
934 CHECK_CLOSED(self, "read of closed file")
935
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000936 if (n == 0)
937 return PyBytes_FromStringAndSize(NULL, 0);
938
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000939 /* Return up to n bytes. If at least one byte is buffered, we
940 only return buffered bytes. Otherwise, we do one raw read. */
941
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000942 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
943 if (have > 0) {
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100944 n = Py_MIN(have, n);
945 res = _bufferedreader_read_fast(self, n);
946 assert(res != Py_None);
947 return res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000948 }
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100949 res = PyBytes_FromStringAndSize(NULL, n);
950 if (res == NULL)
951 return NULL;
952 if (!ENTER_BUFFERED(self)) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200953 Py_DECREF(res);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100954 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200955 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000956 _bufferedreader_reset_buf(self);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100957 r = _bufferedreader_raw_read(self, PyBytes_AS_STRING(res), n);
958 LEAVE_BUFFERED(self)
959 if (r == -1) {
960 Py_DECREF(res);
961 return NULL;
962 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000963 if (r == -2)
964 r = 0;
965 if (n > r)
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100966 _PyBytes_Resize(&res, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000967 return res;
968}
969
970static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300971_buffered_readinto_generic(buffered *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000972{
Antoine Pitrou3486a982011-05-12 01:57:53 +0200973 Py_ssize_t n, written = 0, remaining;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000974 PyObject *res = NULL;
975
976 CHECK_INITIALIZED(self)
Antoine Pitrou3486a982011-05-12 01:57:53 +0200977
Antoine Pitrou3486a982011-05-12 01:57:53 +0200978 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
979 if (n > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300980 if (n >= buffer->len) {
981 memcpy(buffer->buf, self->buffer + self->pos, buffer->len);
982 self->pos += buffer->len;
983 return PyLong_FromSsize_t(buffer->len);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200984 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300985 memcpy(buffer->buf, self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200986 self->pos += n;
987 written = n;
988 }
989
990 if (!ENTER_BUFFERED(self))
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300991 return NULL;
Antoine Pitrou3486a982011-05-12 01:57:53 +0200992
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000993 if (self->writable) {
Antoine Pitroue8bb1a02011-08-20 14:52:04 +0200994 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000995 if (res == NULL)
996 goto end;
Antoine Pitrou3486a982011-05-12 01:57:53 +0200997 Py_CLEAR(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000998 }
Antoine Pitrou3486a982011-05-12 01:57:53 +0200999
1000 _bufferedreader_reset_buf(self);
1001 self->pos = 0;
1002
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001003 for (remaining = buffer->len - written;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001004 remaining > 0;
1005 written += n, remaining -= n) {
1006 /* If remaining bytes is larger than internal buffer size, copy
1007 * directly into caller's buffer. */
1008 if (remaining > self->buffer_size) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001009 n = _bufferedreader_raw_read(self, (char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001010 remaining);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001011 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001012
1013 /* In readinto1 mode, we do not want to fill the internal
1014 buffer if we already have some data to return */
1015 else if (!(readinto1 && written)) {
Antoine Pitrou3486a982011-05-12 01:57:53 +02001016 n = _bufferedreader_fill_buffer(self);
1017 if (n > 0) {
1018 if (n > remaining)
1019 n = remaining;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001020 memcpy((char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001021 self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001022 self->pos += n;
1023 continue; /* short circuit */
1024 }
1025 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001026 else
1027 n = 0;
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001028
Antoine Pitrou3486a982011-05-12 01:57:53 +02001029 if (n == 0 || (n == -2 && written > 0))
1030 break;
1031 if (n < 0) {
1032 if (n == -2) {
1033 Py_INCREF(Py_None);
1034 res = Py_None;
1035 }
1036 goto end;
1037 }
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001038
Benjamin Petersona96fea02014-06-22 14:17:44 -07001039 /* At most one read in readinto1 mode */
1040 if (readinto1) {
1041 written += n;
1042 break;
1043 }
Antoine Pitrou3486a982011-05-12 01:57:53 +02001044 }
1045 res = PyLong_FromSsize_t(written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001046
1047end:
Antoine Pitrou3486a982011-05-12 01:57:53 +02001048 LEAVE_BUFFERED(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001049 return res;
1050}
1051
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001052/*[clinic input]
1053_io._Buffered.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001054 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001055 /
1056[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001057
1058static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001059_io__Buffered_readinto_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001060/*[clinic end generated code: output=bcb376580b1d8170 input=ed6b98b7a20a3008]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001061{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001062 return _buffered_readinto_generic(self, buffer, 0);
1063}
1064
1065/*[clinic input]
1066_io._Buffered.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001067 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001068 /
1069[clinic start generated code]*/
1070
1071static PyObject *
1072_io__Buffered_readinto1_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001073/*[clinic end generated code: output=6e5c6ac5868205d6 input=4455c5d55fdf1687]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001074{
1075 return _buffered_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -07001076}
1077
1078
1079static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001080_buffered_readline(buffered *self, Py_ssize_t limit)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001081{
1082 PyObject *res = NULL;
1083 PyObject *chunks = NULL;
1084 Py_ssize_t n, written = 0;
1085 const char *start, *s, *end;
1086
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001087 CHECK_CLOSED(self, "readline of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001088
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001089 /* First, try to find a line in the buffer. This can run unlocked because
1090 the calls to the C API are simple enough that they can't trigger
1091 any thread switch. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001092 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1093 if (limit >= 0 && n > limit)
1094 n = limit;
1095 start = self->buffer + self->pos;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001096 s = memchr(start, '\n', n);
1097 if (s != NULL) {
1098 res = PyBytes_FromStringAndSize(start, s - start + 1);
1099 if (res != NULL)
1100 self->pos += s - start + 1;
1101 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001102 }
1103 if (n == limit) {
1104 res = PyBytes_FromStringAndSize(start, n);
1105 if (res != NULL)
1106 self->pos += n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001107 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001108 }
1109
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001110 if (!ENTER_BUFFERED(self))
1111 goto end_unlocked;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001112
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001113 /* Now we try to get some more from the raw stream */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001114 chunks = PyList_New(0);
1115 if (chunks == NULL)
1116 goto end;
1117 if (n > 0) {
1118 res = PyBytes_FromStringAndSize(start, n);
1119 if (res == NULL)
1120 goto end;
1121 if (PyList_Append(chunks, res) < 0) {
1122 Py_CLEAR(res);
1123 goto end;
1124 }
1125 Py_CLEAR(res);
1126 written += n;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001127 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001128 if (limit >= 0)
1129 limit -= n;
1130 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001131 if (self->writable) {
1132 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1133 if (r == NULL)
1134 goto end;
1135 Py_DECREF(r);
1136 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001137
1138 for (;;) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001139 _bufferedreader_reset_buf(self);
1140 n = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001141 if (n == -1)
1142 goto end;
1143 if (n <= 0)
1144 break;
1145 if (limit >= 0 && n > limit)
1146 n = limit;
1147 start = self->buffer;
1148 end = start + n;
1149 s = start;
1150 while (s < end) {
1151 if (*s++ == '\n') {
1152 res = PyBytes_FromStringAndSize(start, s - start);
1153 if (res == NULL)
1154 goto end;
1155 self->pos = s - start;
1156 goto found;
1157 }
1158 }
1159 res = PyBytes_FromStringAndSize(start, n);
1160 if (res == NULL)
1161 goto end;
1162 if (n == limit) {
1163 self->pos = n;
1164 break;
1165 }
1166 if (PyList_Append(chunks, res) < 0) {
1167 Py_CLEAR(res);
1168 goto end;
1169 }
1170 Py_CLEAR(res);
1171 written += n;
1172 if (limit >= 0)
1173 limit -= n;
1174 }
1175found:
1176 if (res != NULL && PyList_Append(chunks, res) < 0) {
1177 Py_CLEAR(res);
1178 goto end;
1179 }
Serhiy Storchaka48842712016-04-06 09:45:48 +03001180 Py_XSETREF(res, _PyBytes_Join(_PyIO_empty_bytes, chunks));
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001181
1182end:
1183 LEAVE_BUFFERED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001184end_unlocked:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001185 Py_XDECREF(chunks);
1186 return res;
1187}
1188
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001189/*[clinic input]
1190_io._Buffered.readline
Serhiy Storchaka762bf402017-03-30 09:15:31 +03001191 size: Py_ssize_t(accept={int, NoneType}) = -1
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001192 /
1193[clinic start generated code]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001194
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001195static PyObject *
1196_io__Buffered_readline_impl(buffered *self, Py_ssize_t size)
Serhiy Storchaka762bf402017-03-30 09:15:31 +03001197/*[clinic end generated code: output=24dd2aa6e33be83c input=673b6240e315ef8a]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001198{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001199 CHECK_INITIALIZED(self)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001200 return _buffered_readline(self, size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001201}
1202
1203
1204static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001205buffered_tell(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001206{
1207 Py_off_t pos;
1208
1209 CHECK_INITIALIZED(self)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001210 pos = _buffered_raw_tell(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001211 if (pos == -1)
1212 return NULL;
1213 pos -= RAW_OFFSET(self);
1214 /* TODO: sanity check (pos >= 0) */
1215 return PyLong_FromOff_t(pos);
1216}
1217
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001218/*[clinic input]
1219_io._Buffered.seek
1220 target as targetobj: object
1221 whence: int = 0
1222 /
1223[clinic start generated code]*/
1224
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001225static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001226_io__Buffered_seek_impl(buffered *self, PyObject *targetobj, int whence)
1227/*[clinic end generated code: output=7ae0e8dc46efdefb input=a9c4920bfcba6163]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001228{
1229 Py_off_t target, n;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001230 PyObject *res = NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001231
1232 CHECK_INITIALIZED(self)
Jesus Cea94363612012-06-22 18:32:07 +02001233
1234 /* Do some error checking instead of trusting OS 'seek()'
1235 ** error detection, just in case.
1236 */
1237 if ((whence < 0 || whence >2)
1238#ifdef SEEK_HOLE
1239 && (whence != SEEK_HOLE)
1240#endif
1241#ifdef SEEK_DATA
1242 && (whence != SEEK_DATA)
1243#endif
1244 ) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001245 PyErr_Format(PyExc_ValueError,
Jesus Cea94363612012-06-22 18:32:07 +02001246 "whence value %d unsupported", whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001247 return NULL;
1248 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001249
1250 CHECK_CLOSED(self, "seek of closed file")
1251
Antoine Pitrou1e44fec2011-10-04 12:26:20 +02001252 if (_PyIOBase_check_seekable(self->raw, Py_True) == NULL)
1253 return NULL;
1254
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001255 target = PyNumber_AsOff_t(targetobj, PyExc_ValueError);
1256 if (target == -1 && PyErr_Occurred())
1257 return NULL;
1258
Jesus Cea94363612012-06-22 18:32:07 +02001259 /* SEEK_SET and SEEK_CUR are special because we could seek inside the
1260 buffer. Other whence values must be managed without this optimization.
1261 Some Operating Systems can provide additional values, like
1262 SEEK_HOLE/SEEK_DATA. */
1263 if (((whence == 0) || (whence == 1)) && self->readable) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001264 Py_off_t current, avail;
1265 /* Check if seeking leaves us inside the current buffer,
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001266 so as to return quickly if possible. Also, we needn't take the
1267 lock in this fast path.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001268 Don't know how to do that when whence == 2, though. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001269 /* NOTE: RAW_TELL() can release the GIL but the object is in a stable
1270 state at this point. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001271 current = RAW_TELL(self);
1272 avail = READAHEAD(self);
1273 if (avail > 0) {
1274 Py_off_t offset;
1275 if (whence == 0)
1276 offset = target - (current - RAW_OFFSET(self));
1277 else
1278 offset = target;
1279 if (offset >= -self->pos && offset <= avail) {
1280 self->pos += offset;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001281 return PyLong_FromOff_t(current - avail + offset);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001282 }
1283 }
1284 }
1285
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001286 if (!ENTER_BUFFERED(self))
1287 return NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001288
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001289 /* Fallback: invoke raw seek() method and clear buffer */
1290 if (self->writable) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001291 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001292 if (res == NULL)
1293 goto end;
1294 Py_CLEAR(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001295 }
1296
1297 /* TODO: align on block boundary and read buffer if needed? */
1298 if (whence == 1)
1299 target -= RAW_OFFSET(self);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001300 n = _buffered_raw_seek(self, target, whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001301 if (n == -1)
1302 goto end;
1303 self->raw_pos = -1;
1304 res = PyLong_FromOff_t(n);
1305 if (res != NULL && self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001306 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001307
1308end:
1309 LEAVE_BUFFERED(self)
1310 return res;
1311}
1312
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001313/*[clinic input]
1314_io._Buffered.truncate
1315 pos: object = None
1316 /
1317[clinic start generated code]*/
1318
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001319static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001320_io__Buffered_truncate_impl(buffered *self, PyObject *pos)
1321/*[clinic end generated code: output=667ca03c60c270de input=8a1be34d57cca2d3]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001322{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001323 PyObject *res = NULL;
1324
1325 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001326 if (!ENTER_BUFFERED(self))
1327 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001328
1329 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +02001330 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001331 if (res == NULL)
1332 goto end;
1333 Py_CLEAR(res);
1334 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001335 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_truncate, pos, NULL);
1336 if (res == NULL)
1337 goto end;
1338 /* Reset cached position */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001339 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001340 PyErr_Clear();
1341
1342end:
1343 LEAVE_BUFFERED(self)
1344 return res;
1345}
1346
1347static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001348buffered_iternext(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001349{
1350 PyObject *line;
1351 PyTypeObject *tp;
1352
1353 CHECK_INITIALIZED(self);
1354
1355 tp = Py_TYPE(self);
1356 if (tp == &PyBufferedReader_Type ||
1357 tp == &PyBufferedRandom_Type) {
1358 /* Skip method call overhead for speed */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001359 line = _buffered_readline(self, -1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001360 }
1361 else {
1362 line = PyObject_CallMethodObjArgs((PyObject *)self,
1363 _PyIO_str_readline, NULL);
1364 if (line && !PyBytes_Check(line)) {
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03001365 PyErr_Format(PyExc_OSError,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001366 "readline() should have returned a bytes object, "
1367 "not '%.200s'", Py_TYPE(line)->tp_name);
1368 Py_DECREF(line);
1369 return NULL;
1370 }
1371 }
1372
1373 if (line == NULL)
1374 return NULL;
1375
1376 if (PyBytes_GET_SIZE(line) == 0) {
1377 /* Reached EOF or would have blocked */
1378 Py_DECREF(line);
1379 return NULL;
1380 }
1381
1382 return line;
1383}
1384
Antoine Pitrou716c4442009-05-23 19:04:03 +00001385static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001386buffered_repr(buffered *self)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001387{
1388 PyObject *nameobj, *res;
1389
Martin v. Löwis767046a2011-10-14 15:35:36 +02001390 nameobj = _PyObject_GetAttrId((PyObject *) self, &PyId_name);
Antoine Pitrou716c4442009-05-23 19:04:03 +00001391 if (nameobj == NULL) {
Benjamin Peterson10e76b62014-12-21 20:51:50 -06001392 if (PyErr_ExceptionMatches(PyExc_Exception))
Antoine Pitrou716c4442009-05-23 19:04:03 +00001393 PyErr_Clear();
1394 else
1395 return NULL;
1396 res = PyUnicode_FromFormat("<%s>", Py_TYPE(self)->tp_name);
1397 }
1398 else {
Serhiy Storchakaa5af6e12017-03-19 19:25:29 +02001399 int status = Py_ReprEnter((PyObject *)self);
1400 res = NULL;
1401 if (status == 0) {
1402 res = PyUnicode_FromFormat("<%s name=%R>",
1403 Py_TYPE(self)->tp_name, nameobj);
1404 Py_ReprLeave((PyObject *)self);
1405 }
1406 else if (status > 0) {
1407 PyErr_Format(PyExc_RuntimeError,
1408 "reentrant call inside %s.__repr__",
1409 Py_TYPE(self)->tp_name);
1410 }
Antoine Pitrou716c4442009-05-23 19:04:03 +00001411 Py_DECREF(nameobj);
1412 }
1413 return res;
1414}
1415
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001416/*
1417 * class BufferedReader
1418 */
1419
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001420static void _bufferedreader_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001421{
1422 self->read_end = -1;
1423}
1424
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001425/*[clinic input]
1426_io.BufferedReader.__init__
1427 raw: object
1428 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001429
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001430Create a new buffered reader using the given readable raw IO object.
1431[clinic start generated code]*/
1432
1433static int
1434_io_BufferedReader___init___impl(buffered *self, PyObject *raw,
1435 Py_ssize_t buffer_size)
1436/*[clinic end generated code: output=cddcfefa0ed294c4 input=fb887e06f11b4e48]*/
1437{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001438 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001439 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001440
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001441 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001442 return -1;
1443
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001444 Py_INCREF(raw);
Serhiy Storchaka48842712016-04-06 09:45:48 +03001445 Py_XSETREF(self->raw, raw);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001446 self->buffer_size = buffer_size;
1447 self->readable = 1;
1448 self->writable = 0;
1449
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001450 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001451 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001452 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001453
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001454 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedReader_Type &&
1455 Py_TYPE(raw) == &PyFileIO_Type);
1456
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001457 self->ok = 1;
1458 return 0;
1459}
1460
1461static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001462_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001463{
1464 Py_buffer buf;
1465 PyObject *memobj, *res;
1466 Py_ssize_t n;
1467 /* NOTE: the buffer needn't be released as its object is NULL. */
1468 if (PyBuffer_FillInfo(&buf, NULL, start, len, 0, PyBUF_CONTIG) == -1)
1469 return -1;
1470 memobj = PyMemoryView_FromBuffer(&buf);
1471 if (memobj == NULL)
1472 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001473 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1474 occurs so we needn't do it ourselves.
1475 We then retry reading, ignoring the signal if no handler has
1476 raised (see issue #10956).
1477 */
1478 do {
1479 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readinto, memobj, NULL);
Gregory P. Smith51359922012-06-23 23:55:39 -07001480 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001481 Py_DECREF(memobj);
1482 if (res == NULL)
1483 return -1;
1484 if (res == Py_None) {
1485 /* Non-blocking stream would have blocked. Special return code! */
1486 Py_DECREF(res);
1487 return -2;
1488 }
1489 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1490 Py_DECREF(res);
1491 if (n < 0 || n > len) {
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03001492 PyErr_Format(PyExc_OSError,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001493 "raw readinto() returned invalid length %zd "
1494 "(should have been between 0 and %zd)", n, len);
1495 return -1;
1496 }
1497 if (n > 0 && self->abs_pos != -1)
1498 self->abs_pos += n;
1499 return n;
1500}
1501
1502static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001503_bufferedreader_fill_buffer(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001504{
1505 Py_ssize_t start, len, n;
1506 if (VALID_READ_BUFFER(self))
1507 start = Py_SAFE_DOWNCAST(self->read_end, Py_off_t, Py_ssize_t);
1508 else
1509 start = 0;
1510 len = self->buffer_size - start;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001511 n = _bufferedreader_raw_read(self, self->buffer + start, len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001512 if (n <= 0)
1513 return n;
1514 self->read_end = start + n;
1515 self->raw_pos = start + n;
1516 return n;
1517}
1518
1519static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001520_bufferedreader_read_all(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001521{
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001522 Py_ssize_t current_size;
Serhiy Storchaka4d9aec02018-01-16 18:34:21 +02001523 PyObject *res = NULL, *data = NULL, *tmp = NULL, *chunks = NULL, *readall;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001524
1525 /* First copy what we have in the current buffer. */
1526 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1527 if (current_size) {
1528 data = PyBytes_FromStringAndSize(
1529 self->buffer + self->pos, current_size);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001530 if (data == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001531 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001532 self->pos += current_size;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001533 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001534 /* We're going past the buffer's bounds, flush it */
1535 if (self->writable) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001536 tmp = buffered_flush_and_rewind_unlocked(self);
1537 if (tmp == NULL)
1538 goto cleanup;
1539 Py_CLEAR(tmp);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001540 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001541 _bufferedreader_reset_buf(self);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001542
Serhiy Storchakaf320be72018-01-25 10:49:40 +02001543 if (_PyObject_LookupAttr(self->raw, _PyIO_str_readall, &readall) < 0) {
1544 goto cleanup;
1545 }
Serhiy Storchaka4d9aec02018-01-16 18:34:21 +02001546 if (readall) {
1547 tmp = _PyObject_CallNoArg(readall);
1548 Py_DECREF(readall);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001549 if (tmp == NULL)
1550 goto cleanup;
1551 if (tmp != Py_None && !PyBytes_Check(tmp)) {
Victor Stinnerb57f1082011-05-26 00:19:38 +02001552 PyErr_SetString(PyExc_TypeError, "readall() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001553 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001554 }
Serhiy Storchaka4d9aec02018-01-16 18:34:21 +02001555 if (current_size == 0) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001556 res = tmp;
Serhiy Storchaka4d9aec02018-01-16 18:34:21 +02001557 } else {
1558 if (tmp != Py_None) {
1559 PyBytes_Concat(&data, tmp);
1560 }
1561 res = data;
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001562 }
Serhiy Storchaka4d9aec02018-01-16 18:34:21 +02001563 goto cleanup;
1564 }
Victor Stinnerb57f1082011-05-26 00:19:38 +02001565
1566 chunks = PyList_New(0);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001567 if (chunks == NULL)
1568 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001569
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001570 while (1) {
1571 if (data) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001572 if (PyList_Append(chunks, data) < 0)
1573 goto cleanup;
1574 Py_CLEAR(data);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001575 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001576
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001577 /* Read until EOF or until read() would block. */
1578 data = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_read, NULL);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001579 if (data == NULL)
1580 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001581 if (data != Py_None && !PyBytes_Check(data)) {
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001582 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001583 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001584 }
1585 if (data == Py_None || PyBytes_GET_SIZE(data) == 0) {
1586 if (current_size == 0) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001587 res = data;
1588 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001589 }
1590 else {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001591 tmp = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1592 res = tmp;
1593 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001594 }
1595 }
1596 current_size += PyBytes_GET_SIZE(data);
1597 if (self->abs_pos != -1)
1598 self->abs_pos += PyBytes_GET_SIZE(data);
1599 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001600cleanup:
1601 /* res is either NULL or a borrowed ref */
1602 Py_XINCREF(res);
1603 Py_XDECREF(data);
1604 Py_XDECREF(tmp);
1605 Py_XDECREF(chunks);
1606 return res;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001607}
1608
1609/* Read n bytes from the buffer if it can, otherwise return None.
1610 This function is simple enough that it can run unlocked. */
1611static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001612_bufferedreader_read_fast(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001613{
1614 Py_ssize_t current_size;
1615
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001616 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1617 if (n <= current_size) {
1618 /* Fast path: the data to read is fully buffered. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001619 PyObject *res = PyBytes_FromStringAndSize(self->buffer + self->pos, n);
1620 if (res != NULL)
1621 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001622 return res;
1623 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001624 Py_RETURN_NONE;
1625}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001626
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001627/* Generic read function: read from the stream until enough bytes are read,
1628 * or until an EOF occurs or until read() would block.
1629 */
1630static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001631_bufferedreader_read_generic(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001632{
1633 PyObject *res = NULL;
1634 Py_ssize_t current_size, remaining, written;
1635 char *out;
1636
1637 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1638 if (n <= current_size)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001639 return _bufferedreader_read_fast(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001640
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001641 res = PyBytes_FromStringAndSize(NULL, n);
1642 if (res == NULL)
1643 goto error;
1644 out = PyBytes_AS_STRING(res);
1645 remaining = n;
1646 written = 0;
1647 if (current_size > 0) {
1648 memcpy(out, self->buffer + self->pos, current_size);
1649 remaining -= current_size;
1650 written += current_size;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001651 self->pos += current_size;
1652 }
1653 /* Flush the write buffer if necessary */
1654 if (self->writable) {
1655 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1656 if (r == NULL)
1657 goto error;
1658 Py_DECREF(r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001659 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001660 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001661 while (remaining > 0) {
1662 /* We want to read a whole block at the end into buffer.
1663 If we had readv() we could do this in one pass. */
1664 Py_ssize_t r = MINUS_LAST_BLOCK(self, remaining);
1665 if (r == 0)
1666 break;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001667 r = _bufferedreader_raw_read(self, out + written, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001668 if (r == -1)
1669 goto error;
1670 if (r == 0 || r == -2) {
1671 /* EOF occurred or read() would block. */
1672 if (r == 0 || written > 0) {
1673 if (_PyBytes_Resize(&res, written))
1674 goto error;
1675 return res;
1676 }
1677 Py_DECREF(res);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001678 Py_RETURN_NONE;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001679 }
1680 remaining -= r;
1681 written += r;
1682 }
1683 assert(remaining <= self->buffer_size);
1684 self->pos = 0;
1685 self->raw_pos = 0;
1686 self->read_end = 0;
Antoine Pitrou32cfede2010-08-11 13:31:33 +00001687 /* NOTE: when the read is satisfied, we avoid issuing any additional
1688 reads, which could block indefinitely (e.g. on a socket).
1689 See issue #9550. */
1690 while (remaining > 0 && self->read_end < self->buffer_size) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001691 Py_ssize_t r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001692 if (r == -1)
1693 goto error;
1694 if (r == 0 || r == -2) {
1695 /* EOF occurred or read() would block. */
1696 if (r == 0 || written > 0) {
1697 if (_PyBytes_Resize(&res, written))
1698 goto error;
1699 return res;
1700 }
1701 Py_DECREF(res);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001702 Py_RETURN_NONE;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001703 }
1704 if (remaining > r) {
1705 memcpy(out + written, self->buffer + self->pos, r);
1706 written += r;
1707 self->pos += r;
1708 remaining -= r;
1709 }
1710 else if (remaining > 0) {
1711 memcpy(out + written, self->buffer + self->pos, remaining);
1712 written += remaining;
1713 self->pos += remaining;
1714 remaining = 0;
1715 }
1716 if (remaining == 0)
1717 break;
1718 }
1719
1720 return res;
1721
1722error:
1723 Py_XDECREF(res);
1724 return NULL;
1725}
1726
1727static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +02001728_bufferedreader_peek_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001729{
1730 Py_ssize_t have, r;
1731
1732 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1733 /* Constraints:
1734 1. we don't want to advance the file position.
1735 2. we don't want to lose block alignment, so we can't shift the buffer
1736 to make some place.
1737 Therefore, we either return `have` bytes (if > 0), or a full buffer.
1738 */
1739 if (have > 0) {
1740 return PyBytes_FromStringAndSize(self->buffer + self->pos, have);
1741 }
1742
1743 /* Fill the buffer from the raw stream, and copy it to the result. */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001744 _bufferedreader_reset_buf(self);
1745 r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001746 if (r == -1)
1747 return NULL;
1748 if (r == -2)
1749 r = 0;
1750 self->pos = 0;
1751 return PyBytes_FromStringAndSize(self->buffer, r);
1752}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001753
1754
Benjamin Peterson59406a92009-03-26 17:10:29 +00001755
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001756/*
1757 * class BufferedWriter
1758 */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001759static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001760_bufferedwriter_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001761{
1762 self->write_pos = 0;
1763 self->write_end = -1;
1764}
1765
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001766/*[clinic input]
1767_io.BufferedWriter.__init__
1768 raw: object
1769 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001770
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001771A buffer for a writeable sequential RawIO object.
1772
1773The constructor creates a BufferedWriter for the given writeable raw
1774stream. If the buffer_size is not given, it defaults to
1775DEFAULT_BUFFER_SIZE.
1776[clinic start generated code]*/
1777
1778static int
1779_io_BufferedWriter___init___impl(buffered *self, PyObject *raw,
1780 Py_ssize_t buffer_size)
1781/*[clinic end generated code: output=c8942a020c0dee64 input=914be9b95e16007b]*/
1782{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001783 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001784 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001785
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001786 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001787 return -1;
1788
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001789 Py_INCREF(raw);
Serhiy Storchaka48842712016-04-06 09:45:48 +03001790 Py_XSETREF(self->raw, raw);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001791 self->readable = 0;
1792 self->writable = 1;
1793
1794 self->buffer_size = buffer_size;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001795 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001796 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001797 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001798 self->pos = 0;
1799
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001800 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedWriter_Type &&
1801 Py_TYPE(raw) == &PyFileIO_Type);
1802
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001803 self->ok = 1;
1804 return 0;
1805}
1806
1807static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001808_bufferedwriter_raw_write(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001809{
1810 Py_buffer buf;
1811 PyObject *memobj, *res;
1812 Py_ssize_t n;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001813 int errnum;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001814 /* NOTE: the buffer needn't be released as its object is NULL. */
1815 if (PyBuffer_FillInfo(&buf, NULL, start, len, 1, PyBUF_CONTIG_RO) == -1)
1816 return -1;
1817 memobj = PyMemoryView_FromBuffer(&buf);
1818 if (memobj == NULL)
1819 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001820 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1821 occurs so we needn't do it ourselves.
1822 We then retry writing, ignoring the signal if no handler has
1823 raised (see issue #10956).
1824 */
1825 do {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001826 errno = 0;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001827 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_write, memobj, NULL);
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001828 errnum = errno;
Gregory P. Smith51359922012-06-23 23:55:39 -07001829 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001830 Py_DECREF(memobj);
1831 if (res == NULL)
1832 return -1;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001833 if (res == Py_None) {
1834 /* Non-blocking stream would have blocked. Special return code!
1835 Being paranoid we reset errno in case it is changed by code
1836 triggered by a decref. errno is used by _set_BlockingIOError(). */
1837 Py_DECREF(res);
1838 errno = errnum;
1839 return -2;
1840 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001841 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1842 Py_DECREF(res);
1843 if (n < 0 || n > len) {
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03001844 PyErr_Format(PyExc_OSError,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001845 "raw write() returned invalid length %zd "
1846 "(should have been between 0 and %zd)", n, len);
1847 return -1;
1848 }
1849 if (n > 0 && self->abs_pos != -1)
1850 self->abs_pos += n;
1851 return n;
1852}
1853
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001854static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001855_bufferedwriter_flush_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001856{
1857 Py_ssize_t written = 0;
1858 Py_off_t n, rewind;
1859
1860 if (!VALID_WRITE_BUFFER(self) || self->write_pos == self->write_end)
1861 goto end;
1862 /* First, rewind */
1863 rewind = RAW_OFFSET(self) + (self->pos - self->write_pos);
1864 if (rewind != 0) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001865 n = _buffered_raw_seek(self, -rewind, 1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001866 if (n < 0) {
1867 goto error;
1868 }
1869 self->raw_pos -= rewind;
1870 }
1871 while (self->write_pos < self->write_end) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001872 n = _bufferedwriter_raw_write(self,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001873 self->buffer + self->write_pos,
1874 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1875 Py_off_t, Py_ssize_t));
1876 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001877 goto error;
1878 }
1879 else if (n == -2) {
1880 _set_BlockingIOError("write could not complete without blocking",
1881 0);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001882 goto error;
1883 }
1884 self->write_pos += n;
1885 self->raw_pos = self->write_pos;
1886 written += Py_SAFE_DOWNCAST(n, Py_off_t, Py_ssize_t);
Antoine Pitroub46b9d52010-08-21 19:09:32 +00001887 /* Partial writes can return successfully when interrupted by a
1888 signal (see write(2)). We must run signal handlers before
1889 blocking another time, possibly indefinitely. */
1890 if (PyErr_CheckSignals() < 0)
1891 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001892 }
1893
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001894
1895end:
Nitish Chandra059f58c2018-01-28 21:30:09 +05301896 /* This ensures that after return from this function,
1897 VALID_WRITE_BUFFER(self) returns false.
1898
1899 This is a required condition because when a tell() is called
1900 after flushing and if VALID_READ_BUFFER(self) is false, we need
1901 VALID_WRITE_BUFFER(self) to be false to have
1902 RAW_OFFSET(self) == 0.
1903
1904 Issue: https://bugs.python.org/issue32228 */
1905 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001906 Py_RETURN_NONE;
1907
1908error:
1909 return NULL;
1910}
1911
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001912/*[clinic input]
1913_io.BufferedWriter.write
1914 buffer: Py_buffer
1915 /
1916[clinic start generated code]*/
1917
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001918static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001919_io_BufferedWriter_write_impl(buffered *self, Py_buffer *buffer)
1920/*[clinic end generated code: output=7f8d1365759bfc6b input=dd87dd85fc7f8850]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001921{
1922 PyObject *res = NULL;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00001923 Py_ssize_t written, avail, remaining;
1924 Py_off_t offset;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001925
1926 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001927
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001928 if (!ENTER_BUFFERED(self))
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001929 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001930
benfogle9703f092017-11-10 16:03:40 -05001931 /* Issue #31976: Check for closed file after acquiring the lock. Another
1932 thread could be holding the lock while closing the file. */
1933 if (IS_CLOSED(self)) {
1934 PyErr_SetString(PyExc_ValueError, "write to closed file");
1935 goto error;
1936 }
1937
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001938 /* Fast path: the data to write can be fully buffered. */
1939 if (!VALID_READ_BUFFER(self) && !VALID_WRITE_BUFFER(self)) {
1940 self->pos = 0;
1941 self->raw_pos = 0;
1942 }
1943 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001944 if (buffer->len <= avail) {
1945 memcpy(self->buffer + self->pos, buffer->buf, buffer->len);
Antoine Pitrou7c404892011-05-13 00:13:33 +02001946 if (!VALID_WRITE_BUFFER(self) || self->write_pos > self->pos) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001947 self->write_pos = self->pos;
1948 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001949 ADJUST_POSITION(self, self->pos + buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001950 if (self->pos > self->write_end)
1951 self->write_end = self->pos;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001952 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001953 goto end;
1954 }
1955
1956 /* First write the current buffer */
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001957 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001958 if (res == NULL) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001959 Py_ssize_t *w = _buffered_check_blocking_error();
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001960 if (w == NULL)
1961 goto error;
1962 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001963 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001964 /* Make some place by shifting the buffer. */
1965 assert(VALID_WRITE_BUFFER(self));
1966 memmove(self->buffer, self->buffer + self->write_pos,
1967 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1968 Py_off_t, Py_ssize_t));
1969 self->write_end -= self->write_pos;
1970 self->raw_pos -= self->write_pos;
1971 self->pos -= self->write_pos;
1972 self->write_pos = 0;
1973 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->write_end,
1974 Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001975 if (buffer->len <= avail) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001976 /* Everything can be buffered */
1977 PyErr_Clear();
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001978 memcpy(self->buffer + self->write_end, buffer->buf, buffer->len);
1979 self->write_end += buffer->len;
1980 self->pos += buffer->len;
1981 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001982 goto end;
1983 }
1984 /* Buffer as much as possible. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001985 memcpy(self->buffer + self->write_end, buffer->buf, avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001986 self->write_end += avail;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001987 self->pos += avail;
1988 /* XXX Modifying the existing exception e using the pointer w
1989 will change e.characters_written but not e.args[2].
1990 Therefore we just replace with a new error. */
1991 _set_BlockingIOError("write could not complete without blocking",
1992 avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001993 goto error;
1994 }
1995 Py_CLEAR(res);
1996
Antoine Pitroua0ceb732009-08-06 20:29:56 +00001997 /* Adjust the raw stream position if it is away from the logical stream
1998 position. This happens if the read buffer has been filled but not
1999 modified (and therefore _bufferedwriter_flush_unlocked() didn't rewind
2000 the raw stream by itself).
2001 Fixes issue #6629.
2002 */
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002003 offset = RAW_OFFSET(self);
2004 if (offset != 0) {
2005 if (_buffered_raw_seek(self, -offset, 1) < 0)
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002006 goto error;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002007 self->raw_pos -= offset;
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002008 }
2009
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002010 /* Then write buf itself. At this point the buffer has been emptied. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002011 remaining = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002012 written = 0;
2013 while (remaining > self->buffer_size) {
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002014 Py_ssize_t n = _bufferedwriter_raw_write(
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002015 self, (char *) buffer->buf + written, buffer->len - written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002016 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002017 goto error;
2018 } else if (n == -2) {
2019 /* Write failed because raw file is non-blocking */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002020 if (remaining > self->buffer_size) {
2021 /* Can't buffer everything, still buffer as much as possible */
2022 memcpy(self->buffer,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002023 (char *) buffer->buf + written, self->buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002024 self->raw_pos = 0;
2025 ADJUST_POSITION(self, self->buffer_size);
2026 self->write_end = self->buffer_size;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002027 written += self->buffer_size;
2028 _set_BlockingIOError("write could not complete without "
2029 "blocking", written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002030 goto error;
2031 }
2032 PyErr_Clear();
2033 break;
2034 }
2035 written += n;
2036 remaining -= n;
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002037 /* Partial writes can return successfully when interrupted by a
2038 signal (see write(2)). We must run signal handlers before
2039 blocking another time, possibly indefinitely. */
2040 if (PyErr_CheckSignals() < 0)
2041 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002042 }
2043 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002044 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002045 if (remaining > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002046 memcpy(self->buffer, (char *) buffer->buf + written, remaining);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002047 written += remaining;
2048 }
2049 self->write_pos = 0;
2050 /* TODO: sanity check (remaining >= 0) */
2051 self->write_end = remaining;
2052 ADJUST_POSITION(self, remaining);
2053 self->raw_pos = 0;
2054
2055end:
2056 res = PyLong_FromSsize_t(written);
2057
2058error:
2059 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002060 return res;
2061}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002062
2063
2064
2065/*
2066 * BufferedRWPair
2067 */
2068
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002069/* XXX The usefulness of this (compared to having two separate IO objects) is
2070 * questionable.
2071 */
2072
2073typedef struct {
2074 PyObject_HEAD
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002075 buffered *reader;
2076 buffered *writer;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002077 PyObject *dict;
2078 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002079} rwpair;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002080
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002081/*[clinic input]
2082_io.BufferedRWPair.__init__
2083 reader: object
2084 writer: object
2085 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2086 /
2087
2088A buffered reader and writer object together.
2089
2090A buffered reader object and buffered writer object put together to
2091form a sequential IO object that can read and write. This is typically
2092used with a socket or two-way pipe.
2093
2094reader and writer are RawIOBase objects that are readable and
2095writeable respectively. If the buffer_size is omitted it defaults to
2096DEFAULT_BUFFER_SIZE.
2097[clinic start generated code]*/
2098
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002099static int
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002100_io_BufferedRWPair___init___impl(rwpair *self, PyObject *reader,
2101 PyObject *writer, Py_ssize_t buffer_size)
2102/*[clinic end generated code: output=327e73d1aee8f984 input=620d42d71f33a031]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002103{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002104 if (_PyIOBase_check_readable(reader, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002105 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002106 if (_PyIOBase_check_writable(writer, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002107 return -1;
2108
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002109 self->reader = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002110 (PyObject *) &PyBufferedReader_Type, "On", reader, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002111 if (self->reader == NULL)
2112 return -1;
2113
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002114 self->writer = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002115 (PyObject *) &PyBufferedWriter_Type, "On", writer, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002116 if (self->writer == NULL) {
2117 Py_CLEAR(self->reader);
2118 return -1;
2119 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002120
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002121 return 0;
2122}
2123
2124static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002125bufferedrwpair_traverse(rwpair *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002126{
2127 Py_VISIT(self->dict);
2128 return 0;
2129}
2130
2131static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002132bufferedrwpair_clear(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002133{
2134 Py_CLEAR(self->reader);
2135 Py_CLEAR(self->writer);
2136 Py_CLEAR(self->dict);
2137 return 0;
2138}
2139
2140static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002141bufferedrwpair_dealloc(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002142{
2143 _PyObject_GC_UNTRACK(self);
Benjamin Petersonbbd0a322014-09-29 22:46:57 -04002144 if (self->weakreflist != NULL)
2145 PyObject_ClearWeakRefs((PyObject *)self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002146 Py_CLEAR(self->reader);
2147 Py_CLEAR(self->writer);
2148 Py_CLEAR(self->dict);
2149 Py_TYPE(self)->tp_free((PyObject *) self);
2150}
2151
2152static PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002153_forward_call(buffered *self, _Py_Identifier *name, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002154{
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002155 PyObject *func, *ret;
2156 if (self == NULL) {
2157 PyErr_SetString(PyExc_ValueError,
2158 "I/O operation on uninitialized object");
2159 return NULL;
2160 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002161
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002162 func = _PyObject_GetAttrId((PyObject *)self, name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002163 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002164 PyErr_SetString(PyExc_AttributeError, name->string);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002165 return NULL;
2166 }
2167
2168 ret = PyObject_CallObject(func, args);
2169 Py_DECREF(func);
2170 return ret;
2171}
2172
2173static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002174bufferedrwpair_read(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002175{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002176 return _forward_call(self->reader, &PyId_read, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002177}
2178
2179static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002180bufferedrwpair_peek(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002181{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002182 return _forward_call(self->reader, &PyId_peek, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002183}
2184
2185static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002186bufferedrwpair_read1(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002187{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002188 return _forward_call(self->reader, &PyId_read1, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002189}
2190
2191static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002192bufferedrwpair_readinto(rwpair *self, PyObject *args)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002193{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002194 return _forward_call(self->reader, &PyId_readinto, args);
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002195}
2196
2197static PyObject *
Benjamin Petersona96fea02014-06-22 14:17:44 -07002198bufferedrwpair_readinto1(rwpair *self, PyObject *args)
2199{
2200 return _forward_call(self->reader, &PyId_readinto1, args);
2201}
2202
2203static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002204bufferedrwpair_write(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002205{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002206 return _forward_call(self->writer, &PyId_write, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002207}
2208
2209static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002210bufferedrwpair_flush(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002211{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002212 return _forward_call(self->writer, &PyId_flush, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002213}
2214
2215static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002216bufferedrwpair_readable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002217{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002218 return _forward_call(self->reader, &PyId_readable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002219}
2220
2221static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002222bufferedrwpair_writable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002223{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002224 return _forward_call(self->writer, &PyId_writable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002225}
2226
2227static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002228bufferedrwpair_close(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002229{
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002230 PyObject *exc = NULL, *val, *tb;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002231 PyObject *ret = _forward_call(self->writer, &PyId_close, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002232 if (ret == NULL)
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002233 PyErr_Fetch(&exc, &val, &tb);
2234 else
2235 Py_DECREF(ret);
2236 ret = _forward_call(self->reader, &PyId_close, args);
2237 if (exc != NULL) {
2238 _PyErr_ChainExceptions(exc, val, tb);
2239 Py_CLEAR(ret);
2240 }
2241 return ret;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002242}
2243
2244static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002245bufferedrwpair_isatty(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002246{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002247 PyObject *ret = _forward_call(self->writer, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002248
2249 if (ret != Py_False) {
2250 /* either True or exception */
2251 return ret;
2252 }
2253 Py_DECREF(ret);
2254
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002255 return _forward_call(self->reader, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002256}
2257
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002258static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002259bufferedrwpair_closed_get(rwpair *self, void *context)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002260{
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002261 if (self->writer == NULL) {
2262 PyErr_SetString(PyExc_RuntimeError,
2263 "the BufferedRWPair object is being garbage-collected");
2264 return NULL;
2265 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002266 return PyObject_GetAttr((PyObject *) self->writer, _PyIO_str_closed);
2267}
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002268
2269
2270
2271/*
2272 * BufferedRandom
2273 */
2274
2275/*[clinic input]
2276_io.BufferedRandom.__init__
2277 raw: object
2278 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2279
2280A buffered interface to random access streams.
2281
2282The constructor creates a reader and writer for a seekable stream,
2283raw, given in the first argument. If the buffer_size is omitted it
2284defaults to DEFAULT_BUFFER_SIZE.
2285[clinic start generated code]*/
2286
2287static int
2288_io_BufferedRandom___init___impl(buffered *self, PyObject *raw,
2289 Py_ssize_t buffer_size)
2290/*[clinic end generated code: output=d3d64eb0f64e64a3 input=a4e818fb86d0e50c]*/
2291{
2292 self->ok = 0;
2293 self->detached = 0;
2294
2295 if (_PyIOBase_check_seekable(raw, Py_True) == NULL)
2296 return -1;
2297 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
2298 return -1;
2299 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
2300 return -1;
2301
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002302 Py_INCREF(raw);
Serhiy Storchaka48842712016-04-06 09:45:48 +03002303 Py_XSETREF(self->raw, raw);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002304 self->buffer_size = buffer_size;
2305 self->readable = 1;
2306 self->writable = 1;
2307
2308 if (_buffered_init(self) < 0)
2309 return -1;
2310 _bufferedreader_reset_buf(self);
2311 _bufferedwriter_reset_buf(self);
2312 self->pos = 0;
2313
2314 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedRandom_Type &&
2315 Py_TYPE(raw) == &PyFileIO_Type);
2316
2317 self->ok = 1;
2318 return 0;
2319}
2320
2321#include "clinic/bufferedio.c.h"
2322
2323
2324static PyMethodDef bufferediobase_methods[] = {
2325 _IO__BUFFEREDIOBASE_DETACH_METHODDEF
2326 {"read", bufferediobase_read, METH_VARARGS, bufferediobase_read_doc},
2327 {"read1", bufferediobase_read1, METH_VARARGS, bufferediobase_read1_doc},
2328 _IO__BUFFEREDIOBASE_READINTO_METHODDEF
2329 _IO__BUFFEREDIOBASE_READINTO1_METHODDEF
2330 {"write", bufferediobase_write, METH_VARARGS, bufferediobase_write_doc},
2331 {NULL, NULL}
2332};
2333
2334PyTypeObject PyBufferedIOBase_Type = {
2335 PyVarObject_HEAD_INIT(NULL, 0)
2336 "_io._BufferedIOBase", /*tp_name*/
2337 0, /*tp_basicsize*/
2338 0, /*tp_itemsize*/
2339 0, /*tp_dealloc*/
2340 0, /*tp_print*/
2341 0, /*tp_getattr*/
2342 0, /*tp_setattr*/
2343 0, /*tp_compare */
2344 0, /*tp_repr*/
2345 0, /*tp_as_number*/
2346 0, /*tp_as_sequence*/
2347 0, /*tp_as_mapping*/
2348 0, /*tp_hash */
2349 0, /*tp_call*/
2350 0, /*tp_str*/
2351 0, /*tp_getattro*/
2352 0, /*tp_setattro*/
2353 0, /*tp_as_buffer*/
2354 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2355 | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2356 bufferediobase_doc, /* tp_doc */
2357 0, /* tp_traverse */
2358 0, /* tp_clear */
2359 0, /* tp_richcompare */
2360 0, /* tp_weaklistoffset */
2361 0, /* tp_iter */
2362 0, /* tp_iternext */
2363 bufferediobase_methods, /* tp_methods */
2364 0, /* tp_members */
2365 0, /* tp_getset */
2366 &PyIOBase_Type, /* tp_base */
2367 0, /* tp_dict */
2368 0, /* tp_descr_get */
2369 0, /* tp_descr_set */
2370 0, /* tp_dictoffset */
2371 0, /* tp_init */
2372 0, /* tp_alloc */
2373 0, /* tp_new */
2374 0, /* tp_free */
2375 0, /* tp_is_gc */
2376 0, /* tp_bases */
2377 0, /* tp_mro */
2378 0, /* tp_cache */
2379 0, /* tp_subclasses */
2380 0, /* tp_weaklist */
2381 0, /* tp_del */
2382 0, /* tp_version_tag */
2383 0, /* tp_finalize */
2384};
2385
2386
2387static PyMethodDef bufferedreader_methods[] = {
2388 /* BufferedIOMixin methods */
2389 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2390 {"flush", (PyCFunction)buffered_simple_flush, METH_NOARGS},
2391 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2392 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2393 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002394 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2395 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2396 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2397 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2398
2399 _IO__BUFFERED_READ_METHODDEF
2400 _IO__BUFFERED_PEEK_METHODDEF
2401 _IO__BUFFERED_READ1_METHODDEF
2402 _IO__BUFFERED_READINTO_METHODDEF
2403 _IO__BUFFERED_READINTO1_METHODDEF
2404 _IO__BUFFERED_READLINE_METHODDEF
2405 _IO__BUFFERED_SEEK_METHODDEF
2406 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2407 _IO__BUFFERED_TRUNCATE_METHODDEF
2408 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2409 {NULL, NULL}
2410};
2411
2412static PyMemberDef bufferedreader_members[] = {
2413 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2414 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2415 {NULL}
2416};
2417
2418static PyGetSetDef bufferedreader_getset[] = {
2419 {"closed", (getter)buffered_closed_get, NULL, NULL},
2420 {"name", (getter)buffered_name_get, NULL, NULL},
2421 {"mode", (getter)buffered_mode_get, NULL, NULL},
2422 {NULL}
2423};
2424
2425
2426PyTypeObject PyBufferedReader_Type = {
2427 PyVarObject_HEAD_INIT(NULL, 0)
2428 "_io.BufferedReader", /*tp_name*/
2429 sizeof(buffered), /*tp_basicsize*/
2430 0, /*tp_itemsize*/
2431 (destructor)buffered_dealloc, /*tp_dealloc*/
2432 0, /*tp_print*/
2433 0, /*tp_getattr*/
2434 0, /*tp_setattr*/
2435 0, /*tp_compare */
2436 (reprfunc)buffered_repr, /*tp_repr*/
2437 0, /*tp_as_number*/
2438 0, /*tp_as_sequence*/
2439 0, /*tp_as_mapping*/
2440 0, /*tp_hash */
2441 0, /*tp_call*/
2442 0, /*tp_str*/
2443 0, /*tp_getattro*/
2444 0, /*tp_setattro*/
2445 0, /*tp_as_buffer*/
2446 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2447 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2448 _io_BufferedReader___init____doc__, /* tp_doc */
2449 (traverseproc)buffered_traverse, /* tp_traverse */
2450 (inquiry)buffered_clear, /* tp_clear */
2451 0, /* tp_richcompare */
2452 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2453 0, /* tp_iter */
2454 (iternextfunc)buffered_iternext, /* tp_iternext */
2455 bufferedreader_methods, /* tp_methods */
2456 bufferedreader_members, /* tp_members */
2457 bufferedreader_getset, /* tp_getset */
2458 0, /* tp_base */
2459 0, /* tp_dict */
2460 0, /* tp_descr_get */
2461 0, /* tp_descr_set */
2462 offsetof(buffered, dict), /* tp_dictoffset */
2463 _io_BufferedReader___init__, /* tp_init */
2464 0, /* tp_alloc */
2465 PyType_GenericNew, /* tp_new */
2466 0, /* tp_free */
2467 0, /* tp_is_gc */
2468 0, /* tp_bases */
2469 0, /* tp_mro */
2470 0, /* tp_cache */
2471 0, /* tp_subclasses */
2472 0, /* tp_weaklist */
2473 0, /* tp_del */
2474 0, /* tp_version_tag */
2475 0, /* tp_finalize */
2476};
2477
2478
2479static PyMethodDef bufferedwriter_methods[] = {
2480 /* BufferedIOMixin methods */
2481 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2482 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2483 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002484 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2485 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2486 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2487 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2488 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2489
2490 _IO_BUFFEREDWRITER_WRITE_METHODDEF
2491 _IO__BUFFERED_TRUNCATE_METHODDEF
2492 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
2493 _IO__BUFFERED_SEEK_METHODDEF
2494 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2495 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2496 {NULL, NULL}
2497};
2498
2499static PyMemberDef bufferedwriter_members[] = {
2500 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2501 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2502 {NULL}
2503};
2504
2505static PyGetSetDef bufferedwriter_getset[] = {
2506 {"closed", (getter)buffered_closed_get, NULL, NULL},
2507 {"name", (getter)buffered_name_get, NULL, NULL},
2508 {"mode", (getter)buffered_mode_get, NULL, NULL},
2509 {NULL}
2510};
2511
2512
2513PyTypeObject PyBufferedWriter_Type = {
2514 PyVarObject_HEAD_INIT(NULL, 0)
2515 "_io.BufferedWriter", /*tp_name*/
2516 sizeof(buffered), /*tp_basicsize*/
2517 0, /*tp_itemsize*/
2518 (destructor)buffered_dealloc, /*tp_dealloc*/
2519 0, /*tp_print*/
2520 0, /*tp_getattr*/
2521 0, /*tp_setattr*/
2522 0, /*tp_compare */
2523 (reprfunc)buffered_repr, /*tp_repr*/
2524 0, /*tp_as_number*/
2525 0, /*tp_as_sequence*/
2526 0, /*tp_as_mapping*/
2527 0, /*tp_hash */
2528 0, /*tp_call*/
2529 0, /*tp_str*/
2530 0, /*tp_getattro*/
2531 0, /*tp_setattro*/
2532 0, /*tp_as_buffer*/
2533 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2534 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2535 _io_BufferedWriter___init____doc__, /* tp_doc */
2536 (traverseproc)buffered_traverse, /* tp_traverse */
2537 (inquiry)buffered_clear, /* tp_clear */
2538 0, /* tp_richcompare */
2539 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2540 0, /* tp_iter */
2541 0, /* tp_iternext */
2542 bufferedwriter_methods, /* tp_methods */
2543 bufferedwriter_members, /* tp_members */
2544 bufferedwriter_getset, /* tp_getset */
2545 0, /* tp_base */
2546 0, /* tp_dict */
2547 0, /* tp_descr_get */
2548 0, /* tp_descr_set */
2549 offsetof(buffered, dict), /* tp_dictoffset */
2550 _io_BufferedWriter___init__, /* tp_init */
2551 0, /* tp_alloc */
2552 PyType_GenericNew, /* tp_new */
2553 0, /* tp_free */
2554 0, /* tp_is_gc */
2555 0, /* tp_bases */
2556 0, /* tp_mro */
2557 0, /* tp_cache */
2558 0, /* tp_subclasses */
2559 0, /* tp_weaklist */
2560 0, /* tp_del */
2561 0, /* tp_version_tag */
2562 0, /* tp_finalize */
2563};
2564
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002565
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002566static PyMethodDef bufferedrwpair_methods[] = {
2567 {"read", (PyCFunction)bufferedrwpair_read, METH_VARARGS},
2568 {"peek", (PyCFunction)bufferedrwpair_peek, METH_VARARGS},
2569 {"read1", (PyCFunction)bufferedrwpair_read1, METH_VARARGS},
2570 {"readinto", (PyCFunction)bufferedrwpair_readinto, METH_VARARGS},
Benjamin Petersona96fea02014-06-22 14:17:44 -07002571 {"readinto1", (PyCFunction)bufferedrwpair_readinto1, METH_VARARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002572
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002573 {"write", (PyCFunction)bufferedrwpair_write, METH_VARARGS},
2574 {"flush", (PyCFunction)bufferedrwpair_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002575
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002576 {"readable", (PyCFunction)bufferedrwpair_readable, METH_NOARGS},
2577 {"writable", (PyCFunction)bufferedrwpair_writable, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002578
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002579 {"close", (PyCFunction)bufferedrwpair_close, METH_NOARGS},
2580 {"isatty", (PyCFunction)bufferedrwpair_isatty, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002581
Antoine Pitrou243757e2010-11-05 21:15:39 +00002582 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2583
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002584 {NULL, NULL}
2585};
2586
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002587static PyGetSetDef bufferedrwpair_getset[] = {
2588 {"closed", (getter)bufferedrwpair_closed_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002589 {NULL}
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002590};
2591
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002592PyTypeObject PyBufferedRWPair_Type = {
2593 PyVarObject_HEAD_INIT(NULL, 0)
2594 "_io.BufferedRWPair", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002595 sizeof(rwpair), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002596 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002597 (destructor)bufferedrwpair_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002598 0, /*tp_print*/
2599 0, /*tp_getattr*/
2600 0, /*tp_setattr*/
2601 0, /*tp_compare */
2602 0, /*tp_repr*/
2603 0, /*tp_as_number*/
2604 0, /*tp_as_sequence*/
2605 0, /*tp_as_mapping*/
2606 0, /*tp_hash */
2607 0, /*tp_call*/
2608 0, /*tp_str*/
2609 0, /*tp_getattro*/
2610 0, /*tp_setattro*/
2611 0, /*tp_as_buffer*/
2612 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002613 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002614 _io_BufferedRWPair___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002615 (traverseproc)bufferedrwpair_traverse, /* tp_traverse */
2616 (inquiry)bufferedrwpair_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002617 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002618 offsetof(rwpair, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002619 0, /* tp_iter */
2620 0, /* tp_iternext */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002621 bufferedrwpair_methods, /* tp_methods */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002622 0, /* tp_members */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002623 bufferedrwpair_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002624 0, /* tp_base */
2625 0, /* tp_dict */
2626 0, /* tp_descr_get */
2627 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002628 offsetof(rwpair, dict), /* tp_dictoffset */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002629 _io_BufferedRWPair___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002630 0, /* tp_alloc */
2631 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002632 0, /* tp_free */
2633 0, /* tp_is_gc */
2634 0, /* tp_bases */
2635 0, /* tp_mro */
2636 0, /* tp_cache */
2637 0, /* tp_subclasses */
2638 0, /* tp_weaklist */
2639 0, /* tp_del */
2640 0, /* tp_version_tag */
2641 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002642};
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002643
2644
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002645static PyMethodDef bufferedrandom_methods[] = {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002646 /* BufferedIOMixin methods */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002647 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2648 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2649 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2650 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2651 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2652 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2653 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
Antoine Pitroue033e062010-10-29 10:38:18 +00002654 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
Antoine Pitrou243757e2010-11-05 21:15:39 +00002655 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002656
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002657 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002658
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002659 _IO__BUFFERED_SEEK_METHODDEF
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002660 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002661 _IO__BUFFERED_TRUNCATE_METHODDEF
2662 _IO__BUFFERED_READ_METHODDEF
2663 _IO__BUFFERED_READ1_METHODDEF
2664 _IO__BUFFERED_READINTO_METHODDEF
2665 _IO__BUFFERED_READINTO1_METHODDEF
2666 _IO__BUFFERED_READLINE_METHODDEF
2667 _IO__BUFFERED_PEEK_METHODDEF
2668 _IO_BUFFEREDWRITER_WRITE_METHODDEF
Antoine Pitrou10f0c502012-07-29 19:02:46 +02002669 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002670 {NULL, NULL}
2671};
2672
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002673static PyMemberDef bufferedrandom_members[] = {
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002674 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
Antoine Pitrou796564c2013-07-30 19:59:21 +02002675 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002676 {NULL}
2677};
2678
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002679static PyGetSetDef bufferedrandom_getset[] = {
2680 {"closed", (getter)buffered_closed_get, NULL, NULL},
2681 {"name", (getter)buffered_name_get, NULL, NULL},
2682 {"mode", (getter)buffered_mode_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002683 {NULL}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002684};
2685
2686
2687PyTypeObject PyBufferedRandom_Type = {
2688 PyVarObject_HEAD_INIT(NULL, 0)
2689 "_io.BufferedRandom", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002690 sizeof(buffered), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002691 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002692 (destructor)buffered_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002693 0, /*tp_print*/
2694 0, /*tp_getattr*/
2695 0, /*tp_setattr*/
2696 0, /*tp_compare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002697 (reprfunc)buffered_repr, /*tp_repr*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002698 0, /*tp_as_number*/
2699 0, /*tp_as_sequence*/
2700 0, /*tp_as_mapping*/
2701 0, /*tp_hash */
2702 0, /*tp_call*/
2703 0, /*tp_str*/
2704 0, /*tp_getattro*/
2705 0, /*tp_setattro*/
2706 0, /*tp_as_buffer*/
2707 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002708 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002709 _io_BufferedRandom___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002710 (traverseproc)buffered_traverse, /* tp_traverse */
2711 (inquiry)buffered_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002712 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002713 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002714 0, /* tp_iter */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002715 (iternextfunc)buffered_iternext, /* tp_iternext */
2716 bufferedrandom_methods, /* tp_methods */
2717 bufferedrandom_members, /* tp_members */
2718 bufferedrandom_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002719 0, /* tp_base */
2720 0, /*tp_dict*/
2721 0, /* tp_descr_get */
2722 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002723 offsetof(buffered, dict), /*tp_dictoffset*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002724 _io_BufferedRandom___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002725 0, /* tp_alloc */
2726 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002727 0, /* tp_free */
2728 0, /* tp_is_gc */
2729 0, /* tp_bases */
2730 0, /* tp_mro */
2731 0, /* tp_cache */
2732 0, /* tp_subclasses */
2733 0, /* tp_weaklist */
2734 0, /* tp_del */
2735 0, /* tp_version_tag */
2736 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002737};