blob: 3732f46f4a55b64cdf07f02a0f3a6f047c1fe341 [file] [log] [blame]
Antoine Pitrou19690592009-06-12 20:14:08 +00001/*
2 An implementation of the I/O abstract base classes hierarchy
3 as defined by PEP 3116 - "New I/O"
4
5 Classes defined here: IOBase, RawIOBase.
6
7 Written by Amaury Forgeot d'Arc and Antoine Pitrou
8*/
9
10
11#define PY_SSIZE_T_CLEAN
12#include "Python.h"
13#include "structmember.h"
14#include "_iomodule.h"
15
16/*
17 * IOBase class, an abstract class
18 */
19
20typedef struct {
21 PyObject_HEAD
22
23 PyObject *dict;
24 PyObject *weakreflist;
25} iobase;
26
27PyDoc_STRVAR(iobase_doc,
28 "The abstract base class for all I/O classes, acting on streams of\n"
29 "bytes. There is no public constructor.\n"
30 "\n"
31 "This class provides dummy implementations for many methods that\n"
32 "derived classes can override selectively; the default implementations\n"
33 "represent a file that cannot be read, written or seeked.\n"
34 "\n"
35 "Even though IOBase does not declare read, readinto, or write because\n"
36 "their signatures will vary, implementations and clients should\n"
37 "consider those methods part of the interface. Also, implementations\n"
38 "may raise a IOError when operations they do not support are called.\n"
39 "\n"
40 "The basic type used for binary data read from or written to a file is\n"
41 "bytes. bytearrays are accepted too, and in some cases (such as\n"
42 "readinto) needed. Text I/O classes work with str data.\n"
43 "\n"
44 "Note that calling any method (even inquiries) on a closed stream is\n"
45 "undefined. Implementations may raise IOError in this case.\n"
46 "\n"
47 "IOBase (and its subclasses) support the iterator protocol, meaning\n"
48 "that an IOBase object can be iterated over yielding the lines in a\n"
49 "stream.\n"
50 "\n"
51 "IOBase also supports the :keyword:`with` statement. In this example,\n"
52 "fp is closed after the suite of the with statment is complete:\n"
53 "\n"
54 "with open('spam.txt', 'r') as fp:\n"
55 " fp.write('Spam and eggs!')\n");
56
57/* Use this macro whenever you want to check the internal `closed` status
58 of the IOBase object rather than the virtual `closed` attribute as returned
59 by whatever subclass. */
60
61#define IS_CLOSED(self) \
62 PyObject_HasAttrString(self, "__IOBase_closed")
63
64/* Internal methods */
65static PyObject *
66iobase_unsupported(const char *message)
67{
68 PyErr_SetString(_PyIO_unsupported_operation, message);
69 return NULL;
70}
71
72/* Positionning */
73
74PyDoc_STRVAR(iobase_seek_doc,
75 "Change stream position.\n"
76 "\n"
77 "Change the stream position to byte offset offset. offset is\n"
78 "interpreted relative to the position indicated by whence. Values\n"
79 "for whence are:\n"
80 "\n"
81 "* 0 -- start of stream (the default); offset should be zero or positive\n"
82 "* 1 -- current stream position; offset may be negative\n"
83 "* 2 -- end of stream; offset is usually negative\n"
84 "\n"
85 "Return the new absolute position.");
86
87static PyObject *
88iobase_seek(PyObject *self, PyObject *args)
89{
90 return iobase_unsupported("seek");
91}
92
93PyDoc_STRVAR(iobase_tell_doc,
94 "Return current stream position.");
95
96static PyObject *
97iobase_tell(PyObject *self, PyObject *args)
98{
99 return PyObject_CallMethod(self, "seek", "ii", 0, 1);
100}
101
102PyDoc_STRVAR(iobase_truncate_doc,
103 "Truncate file to size bytes.\n"
104 "\n"
105 "Size defaults to the current IO position as reported by tell(). Return\n"
106 "the new size.");
107
108static PyObject *
109iobase_truncate(PyObject *self, PyObject *args)
110{
111 return iobase_unsupported("truncate");
112}
113
114/* Flush and close methods */
115
116PyDoc_STRVAR(iobase_flush_doc,
117 "Flush write buffers, if applicable.\n"
118 "\n"
119 "This is not implemented for read-only and non-blocking streams.\n");
120
121static PyObject *
122iobase_flush(PyObject *self, PyObject *args)
123{
124 /* XXX Should this return the number of bytes written??? */
125 if (IS_CLOSED(self)) {
126 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file.");
127 return NULL;
128 }
129 Py_RETURN_NONE;
130}
131
132PyDoc_STRVAR(iobase_close_doc,
133 "Flush and close the IO object.\n"
134 "\n"
135 "This method has no effect if the file is already closed.\n");
136
137static int
138iobase_closed(PyObject *self)
139{
140 PyObject *res;
141 int closed;
142 /* This gets the derived attribute, which is *not* __IOBase_closed
143 in most cases! */
144 res = PyObject_GetAttr(self, _PyIO_str_closed);
145 if (res == NULL)
146 return 0;
147 closed = PyObject_IsTrue(res);
148 Py_DECREF(res);
149 return closed;
150}
151
152static PyObject *
153iobase_closed_get(PyObject *self, void *context)
154{
155 return PyBool_FromLong(IS_CLOSED(self));
156}
157
158PyObject *
159_PyIOBase_check_closed(PyObject *self, PyObject *args)
160{
161 if (iobase_closed(self)) {
162 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file.");
163 return NULL;
164 }
165 if (args == Py_True)
166 return Py_None;
167 else
168 Py_RETURN_NONE;
169}
170
171/* XXX: IOBase thinks it has to maintain its own internal state in
172 `__IOBase_closed` and call flush() by itself, but it is redundant with
173 whatever behaviour a non-trivial derived class will implement. */
174
175static PyObject *
176iobase_close(PyObject *self, PyObject *args)
177{
178 PyObject *res;
179
180 if (IS_CLOSED(self))
181 Py_RETURN_NONE;
182
183 res = PyObject_CallMethodObjArgs(self, _PyIO_str_flush, NULL);
184 PyObject_SetAttrString(self, "__IOBase_closed", Py_True);
185 if (res == NULL) {
186 /* If flush() fails, just give up */
187 if (PyErr_ExceptionMatches(PyExc_IOError))
188 PyErr_Clear();
189 else
190 return NULL;
191 }
192 Py_XDECREF(res);
193 Py_RETURN_NONE;
194}
195
196/* Finalization and garbage collection support */
197
198int
199_PyIOBase_finalize(PyObject *self)
200{
201 PyObject *res;
202 PyObject *tp, *v, *tb;
203 int closed = 1;
204 int is_zombie;
205
206 /* If _PyIOBase_finalize() is called from a destructor, we need to
207 resurrect the object as calling close() can invoke arbitrary code. */
208 is_zombie = (Py_REFCNT(self) == 0);
209 if (is_zombie) {
210 ++Py_REFCNT(self);
211 }
212 PyErr_Fetch(&tp, &v, &tb);
213 /* If `closed` doesn't exist or can't be evaluated as bool, then the
214 object is probably in an unusable state, so ignore. */
215 res = PyObject_GetAttr(self, _PyIO_str_closed);
216 if (res == NULL)
217 PyErr_Clear();
218 else {
219 closed = PyObject_IsTrue(res);
220 Py_DECREF(res);
221 if (closed == -1)
222 PyErr_Clear();
223 }
224 if (closed == 0) {
225 res = PyObject_CallMethodObjArgs((PyObject *) self, _PyIO_str_close,
226 NULL);
227 /* Silencing I/O errors is bad, but printing spurious tracebacks is
228 equally as bad, and potentially more frequent (because of
229 shutdown issues). */
230 if (res == NULL)
231 PyErr_Clear();
232 else
233 Py_DECREF(res);
234 }
235 PyErr_Restore(tp, v, tb);
236 if (is_zombie) {
237 if (--Py_REFCNT(self) != 0) {
238 /* The object lives again. The following code is taken from
239 slot_tp_del in typeobject.c. */
240 Py_ssize_t refcnt = Py_REFCNT(self);
241 _Py_NewReference(self);
242 Py_REFCNT(self) = refcnt;
243 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
244 * we need to undo that. */
245 _Py_DEC_REFTOTAL;
246 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
247 * chain, so no more to do there.
248 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
249 * _Py_NewReference bumped tp_allocs: both of those need to be
250 * undone.
251 */
252#ifdef COUNT_ALLOCS
253 --Py_TYPE(self)->tp_frees;
254 --Py_TYPE(self)->tp_allocs;
255#endif
256 return -1;
257 }
258 }
259 return 0;
260}
261
262static int
263iobase_traverse(iobase *self, visitproc visit, void *arg)
264{
265 Py_VISIT(self->dict);
266 return 0;
267}
268
269static int
270iobase_clear(iobase *self)
271{
272 if (_PyIOBase_finalize((PyObject *) self) < 0)
273 return -1;
274 Py_CLEAR(self->dict);
275 return 0;
276}
277
278/* Destructor */
279
280static void
281iobase_dealloc(iobase *self)
282{
283 /* NOTE: since IOBaseObject has its own dict, Python-defined attributes
284 are still available here for close() to use.
285 However, if the derived class declares a __slots__, those slots are
286 already gone.
287 */
288 if (_PyIOBase_finalize((PyObject *) self) < 0) {
289 /* When called from a heap type's dealloc, the type will be
290 decref'ed on return (see e.g. subtype_dealloc in typeobject.c). */
291 if (PyType_HasFeature(Py_TYPE(self), Py_TPFLAGS_HEAPTYPE))
292 Py_INCREF(Py_TYPE(self));
293 return;
294 }
295 _PyObject_GC_UNTRACK(self);
296 if (self->weakreflist != NULL)
297 PyObject_ClearWeakRefs((PyObject *) self);
298 Py_CLEAR(self->dict);
299 Py_TYPE(self)->tp_free((PyObject *) self);
300}
301
302/* Inquiry methods */
303
304PyDoc_STRVAR(iobase_seekable_doc,
305 "Return whether object supports random access.\n"
306 "\n"
307 "If False, seek(), tell() and truncate() will raise IOError.\n"
308 "This method may need to do a test seek().");
309
310static PyObject *
311iobase_seekable(PyObject *self, PyObject *args)
312{
313 Py_RETURN_FALSE;
314}
315
316PyObject *
317_PyIOBase_check_seekable(PyObject *self, PyObject *args)
318{
319 PyObject *res = PyObject_CallMethodObjArgs(self, _PyIO_str_seekable, NULL);
320 if (res == NULL)
321 return NULL;
322 if (res != Py_True) {
323 Py_CLEAR(res);
324 PyErr_SetString(PyExc_IOError, "File or stream is not seekable.");
325 return NULL;
326 }
327 if (args == Py_True) {
328 Py_DECREF(res);
329 }
330 return res;
331}
332
333PyDoc_STRVAR(iobase_readable_doc,
334 "Return whether object was opened for reading.\n"
335 "\n"
336 "If False, read() will raise IOError.");
337
338static PyObject *
339iobase_readable(PyObject *self, PyObject *args)
340{
341 Py_RETURN_FALSE;
342}
343
344/* May be called with any object */
345PyObject *
346_PyIOBase_check_readable(PyObject *self, PyObject *args)
347{
348 PyObject *res = PyObject_CallMethodObjArgs(self, _PyIO_str_readable, NULL);
349 if (res == NULL)
350 return NULL;
351 if (res != Py_True) {
352 Py_CLEAR(res);
353 PyErr_SetString(PyExc_IOError, "File or stream is not readable.");
354 return NULL;
355 }
356 if (args == Py_True) {
357 Py_DECREF(res);
358 }
359 return res;
360}
361
362PyDoc_STRVAR(iobase_writable_doc,
363 "Return whether object was opened for writing.\n"
364 "\n"
365 "If False, read() will raise IOError.");
366
367static PyObject *
368iobase_writable(PyObject *self, PyObject *args)
369{
370 Py_RETURN_FALSE;
371}
372
373/* May be called with any object */
374PyObject *
375_PyIOBase_check_writable(PyObject *self, PyObject *args)
376{
377 PyObject *res = PyObject_CallMethodObjArgs(self, _PyIO_str_writable, NULL);
378 if (res == NULL)
379 return NULL;
380 if (res != Py_True) {
381 Py_CLEAR(res);
382 PyErr_SetString(PyExc_IOError, "File or stream is not writable.");
383 return NULL;
384 }
385 if (args == Py_True) {
386 Py_DECREF(res);
387 }
388 return res;
389}
390
391/* Context manager */
392
393static PyObject *
394iobase_enter(PyObject *self, PyObject *args)
395{
396 if (_PyIOBase_check_closed(self, Py_True) == NULL)
397 return NULL;
398
399 Py_INCREF(self);
400 return self;
401}
402
403static PyObject *
404iobase_exit(PyObject *self, PyObject *args)
405{
406 return PyObject_CallMethodObjArgs(self, _PyIO_str_close, NULL);
407}
408
409/* Lower-level APIs */
410
411/* XXX Should these be present even if unimplemented? */
412
413PyDoc_STRVAR(iobase_fileno_doc,
414 "Returns underlying file descriptor if one exists.\n"
415 "\n"
416 "An IOError is raised if the IO object does not use a file descriptor.\n");
417
418static PyObject *
419iobase_fileno(PyObject *self, PyObject *args)
420{
421 return iobase_unsupported("fileno");
422}
423
424PyDoc_STRVAR(iobase_isatty_doc,
425 "Return whether this is an 'interactive' stream.\n"
426 "\n"
427 "Return False if it can't be determined.\n");
428
429static PyObject *
430iobase_isatty(PyObject *self, PyObject *args)
431{
432 if (_PyIOBase_check_closed(self, Py_True) == NULL)
433 return NULL;
434 Py_RETURN_FALSE;
435}
436
437/* Readline(s) and writelines */
438
439PyDoc_STRVAR(iobase_readline_doc,
440 "Read and return a line from the stream.\n"
441 "\n"
442 "If limit is specified, at most limit bytes will be read.\n"
443 "\n"
444 "The line terminator is always b'\n' for binary files; for text\n"
445 "files, the newlines argument to open can be used to select the line\n"
446 "terminator(s) recognized.\n");
447
448static PyObject *
449iobase_readline(PyObject *self, PyObject *args)
450{
451 /* For backwards compatibility, a (slowish) readline(). */
452
453 Py_ssize_t limit = -1;
454 int has_peek = 0;
455 PyObject *buffer, *result;
456 Py_ssize_t old_size = -1;
457
Benjamin Petersonddd392c2009-12-13 19:19:07 +0000458 if (!PyArg_ParseTuple(args, "|O&:readline", &_PyIO_ConvertSsize_t, &limit)) {
Antoine Pitrou19690592009-06-12 20:14:08 +0000459 return NULL;
460 }
461
462 if (PyObject_HasAttrString(self, "peek"))
463 has_peek = 1;
464
465 buffer = PyByteArray_FromStringAndSize(NULL, 0);
466 if (buffer == NULL)
467 return NULL;
468
469 while (limit < 0 || Py_SIZE(buffer) < limit) {
470 Py_ssize_t nreadahead = 1;
471 PyObject *b;
472
473 if (has_peek) {
474 PyObject *readahead = PyObject_CallMethod(self, "peek", "i", 1);
475 if (readahead == NULL)
476 goto fail;
477 if (!PyBytes_Check(readahead)) {
478 PyErr_Format(PyExc_IOError,
479 "peek() should have returned a bytes object, "
480 "not '%.200s'", Py_TYPE(readahead)->tp_name);
481 Py_DECREF(readahead);
482 goto fail;
483 }
484 if (PyBytes_GET_SIZE(readahead) > 0) {
485 Py_ssize_t n = 0;
486 const char *buf = PyBytes_AS_STRING(readahead);
487 if (limit >= 0) {
488 do {
489 if (n >= PyBytes_GET_SIZE(readahead) || n >= limit)
490 break;
491 if (buf[n++] == '\n')
492 break;
493 } while (1);
494 }
495 else {
496 do {
497 if (n >= PyBytes_GET_SIZE(readahead))
498 break;
499 if (buf[n++] == '\n')
500 break;
501 } while (1);
502 }
503 nreadahead = n;
504 }
505 Py_DECREF(readahead);
506 }
507
508 b = PyObject_CallMethod(self, "read", "n", nreadahead);
509 if (b == NULL)
510 goto fail;
511 if (!PyBytes_Check(b)) {
512 PyErr_Format(PyExc_IOError,
513 "read() should have returned a bytes object, "
514 "not '%.200s'", Py_TYPE(b)->tp_name);
515 Py_DECREF(b);
516 goto fail;
517 }
518 if (PyBytes_GET_SIZE(b) == 0) {
519 Py_DECREF(b);
520 break;
521 }
522
523 old_size = PyByteArray_GET_SIZE(buffer);
524 PyByteArray_Resize(buffer, old_size + PyBytes_GET_SIZE(b));
525 memcpy(PyByteArray_AS_STRING(buffer) + old_size,
526 PyBytes_AS_STRING(b), PyBytes_GET_SIZE(b));
527
528 Py_DECREF(b);
529
530 if (PyByteArray_AS_STRING(buffer)[PyByteArray_GET_SIZE(buffer) - 1] == '\n')
531 break;
532 }
533
534 result = PyBytes_FromStringAndSize(PyByteArray_AS_STRING(buffer),
535 PyByteArray_GET_SIZE(buffer));
536 Py_DECREF(buffer);
537 return result;
538 fail:
539 Py_DECREF(buffer);
540 return NULL;
541}
542
543static PyObject *
544iobase_iter(PyObject *self)
545{
546 if (_PyIOBase_check_closed(self, Py_True) == NULL)
547 return NULL;
548
549 Py_INCREF(self);
550 return self;
551}
552
553static PyObject *
554iobase_iternext(PyObject *self)
555{
556 PyObject *line = PyObject_CallMethodObjArgs(self, _PyIO_str_readline, NULL);
557
558 if (line == NULL)
559 return NULL;
560
561 if (PyObject_Size(line) == 0) {
562 Py_DECREF(line);
563 return NULL;
564 }
565
566 return line;
567}
568
569PyDoc_STRVAR(iobase_readlines_doc,
570 "Return a list of lines from the stream.\n"
571 "\n"
572 "hint can be specified to control the number of lines read: no more\n"
573 "lines will be read if the total size (in bytes/characters) of all\n"
574 "lines so far exceeds hint.");
575
576static PyObject *
577iobase_readlines(PyObject *self, PyObject *args)
578{
579 Py_ssize_t hint = -1, length = 0;
Benjamin Petersonaef18992009-12-13 19:27:02 +0000580 PyObject *result;
Antoine Pitrou19690592009-06-12 20:14:08 +0000581
Benjamin Petersonddd392c2009-12-13 19:19:07 +0000582 if (!PyArg_ParseTuple(args, "|O&:readlines", &_PyIO_ConvertSsize_t, &hint)) {
Antoine Pitrou19690592009-06-12 20:14:08 +0000583 return NULL;
584 }
Antoine Pitrou19690592009-06-12 20:14:08 +0000585
586 result = PyList_New(0);
587 if (result == NULL)
588 return NULL;
589
590 if (hint <= 0) {
591 /* XXX special-casing this made sense in the Python version in order
592 to remove the bytecode interpretation overhead, but it could
593 probably be removed here. */
594 PyObject *ret = PyObject_CallMethod(result, "extend", "O", self);
595 if (ret == NULL) {
596 Py_DECREF(result);
597 return NULL;
598 }
599 Py_DECREF(ret);
600 return result;
601 }
602
603 while (1) {
604 PyObject *line = PyIter_Next(self);
605 if (line == NULL) {
606 if (PyErr_Occurred()) {
607 Py_DECREF(result);
608 return NULL;
609 }
610 else
611 break; /* StopIteration raised */
612 }
613
614 if (PyList_Append(result, line) < 0) {
615 Py_DECREF(line);
616 Py_DECREF(result);
617 return NULL;
618 }
619 length += PyObject_Size(line);
620 Py_DECREF(line);
621
622 if (length > hint)
623 break;
624 }
625 return result;
626}
627
628static PyObject *
629iobase_writelines(PyObject *self, PyObject *args)
630{
631 PyObject *lines, *iter, *res;
632
633 if (!PyArg_ParseTuple(args, "O:writelines", &lines)) {
634 return NULL;
635 }
636
637 if (_PyIOBase_check_closed(self, Py_True) == NULL)
638 return NULL;
639
640 iter = PyObject_GetIter(lines);
641 if (iter == NULL)
642 return NULL;
643
644 while (1) {
645 PyObject *line = PyIter_Next(iter);
646 if (line == NULL) {
647 if (PyErr_Occurred()) {
648 Py_DECREF(iter);
649 return NULL;
650 }
651 else
652 break; /* Stop Iteration */
653 }
654
655 res = PyObject_CallMethodObjArgs(self, _PyIO_str_write, line, NULL);
656 Py_DECREF(line);
657 if (res == NULL) {
658 Py_DECREF(iter);
659 return NULL;
660 }
661 Py_DECREF(res);
662 }
663 Py_DECREF(iter);
664 Py_RETURN_NONE;
665}
666
667static PyMethodDef iobase_methods[] = {
668 {"seek", iobase_seek, METH_VARARGS, iobase_seek_doc},
669 {"tell", iobase_tell, METH_NOARGS, iobase_tell_doc},
670 {"truncate", iobase_truncate, METH_VARARGS, iobase_truncate_doc},
671 {"flush", iobase_flush, METH_NOARGS, iobase_flush_doc},
672 {"close", iobase_close, METH_NOARGS, iobase_close_doc},
673
674 {"seekable", iobase_seekable, METH_NOARGS, iobase_seekable_doc},
675 {"readable", iobase_readable, METH_NOARGS, iobase_readable_doc},
676 {"writable", iobase_writable, METH_NOARGS, iobase_writable_doc},
677
678 {"_checkClosed", _PyIOBase_check_closed, METH_NOARGS},
679 {"_checkSeekable", _PyIOBase_check_seekable, METH_NOARGS},
680 {"_checkReadable", _PyIOBase_check_readable, METH_NOARGS},
681 {"_checkWritable", _PyIOBase_check_writable, METH_NOARGS},
682
683 {"fileno", iobase_fileno, METH_NOARGS, iobase_fileno_doc},
684 {"isatty", iobase_isatty, METH_NOARGS, iobase_isatty_doc},
685
686 {"__enter__", iobase_enter, METH_NOARGS},
687 {"__exit__", iobase_exit, METH_VARARGS},
688
689 {"readline", iobase_readline, METH_VARARGS, iobase_readline_doc},
690 {"readlines", iobase_readlines, METH_VARARGS, iobase_readlines_doc},
691 {"writelines", iobase_writelines, METH_VARARGS},
692
693 {NULL, NULL}
694};
695
696static PyGetSetDef iobase_getset[] = {
697 {"closed", (getter)iobase_closed_get, NULL, NULL},
698 {NULL}
699};
700
701
702PyTypeObject PyIOBase_Type = {
703 PyVarObject_HEAD_INIT(NULL, 0)
704 "_io._IOBase", /*tp_name*/
705 sizeof(iobase), /*tp_basicsize*/
706 0, /*tp_itemsize*/
707 (destructor)iobase_dealloc, /*tp_dealloc*/
708 0, /*tp_print*/
709 0, /*tp_getattr*/
710 0, /*tp_setattr*/
711 0, /*tp_compare */
712 0, /*tp_repr*/
713 0, /*tp_as_number*/
714 0, /*tp_as_sequence*/
715 0, /*tp_as_mapping*/
716 0, /*tp_hash */
717 0, /*tp_call*/
718 0, /*tp_str*/
719 0, /*tp_getattro*/
720 0, /*tp_setattro*/
721 0, /*tp_as_buffer*/
722 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
723 | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
724 iobase_doc, /* tp_doc */
725 (traverseproc)iobase_traverse, /* tp_traverse */
726 (inquiry)iobase_clear, /* tp_clear */
727 0, /* tp_richcompare */
728 offsetof(iobase, weakreflist), /* tp_weaklistoffset */
729 iobase_iter, /* tp_iter */
730 iobase_iternext, /* tp_iternext */
731 iobase_methods, /* tp_methods */
732 0, /* tp_members */
733 iobase_getset, /* tp_getset */
734 0, /* tp_base */
735 0, /* tp_dict */
736 0, /* tp_descr_get */
737 0, /* tp_descr_set */
738 offsetof(iobase, dict), /* tp_dictoffset */
739 0, /* tp_init */
740 0, /* tp_alloc */
741 PyType_GenericNew, /* tp_new */
742};
743
744
745/*
746 * RawIOBase class, Inherits from IOBase.
747 */
748PyDoc_STRVAR(rawiobase_doc,
749 "Base class for raw binary I/O.");
750
751/*
752 * The read() method is implemented by calling readinto(); derived classes
753 * that want to support read() only need to implement readinto() as a
754 * primitive operation. In general, readinto() can be more efficient than
755 * read().
756 *
757 * (It would be tempting to also provide an implementation of readinto() in
758 * terms of read(), in case the latter is a more suitable primitive operation,
759 * but that would lead to nasty recursion in case a subclass doesn't implement
760 * either.)
761*/
762
763static PyObject *
764rawiobase_read(PyObject *self, PyObject *args)
765{
766 Py_ssize_t n = -1;
767 PyObject *b, *res;
768
769 if (!PyArg_ParseTuple(args, "|n:read", &n)) {
770 return NULL;
771 }
772
773 if (n < 0)
774 return PyObject_CallMethod(self, "readall", NULL);
775
776 /* TODO: allocate a bytes object directly instead and manually construct
777 a writable memoryview pointing to it. */
778 b = PyByteArray_FromStringAndSize(NULL, n);
779 if (b == NULL)
780 return NULL;
781
782 res = PyObject_CallMethodObjArgs(self, _PyIO_str_readinto, b, NULL);
783 if (res == NULL) {
784 Py_DECREF(b);
785 return NULL;
786 }
787
788 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
789 Py_DECREF(res);
790 if (n == -1 && PyErr_Occurred()) {
791 Py_DECREF(b);
792 return NULL;
793 }
794
795 res = PyBytes_FromStringAndSize(PyByteArray_AsString(b), n);
796 Py_DECREF(b);
797 return res;
798}
799
800
801PyDoc_STRVAR(rawiobase_readall_doc,
802 "Read until EOF, using multiple read() call.");
803
804static PyObject *
805rawiobase_readall(PyObject *self, PyObject *args)
806{
807 int r;
808 PyObject *chunks = PyList_New(0);
809 PyObject *result;
810
811 if (chunks == NULL)
812 return NULL;
813
814 while (1) {
815 PyObject *data = PyObject_CallMethod(self, "read",
816 "i", DEFAULT_BUFFER_SIZE);
817 if (!data) {
818 Py_DECREF(chunks);
819 return NULL;
820 }
821 if (!PyBytes_Check(data)) {
822 Py_DECREF(chunks);
823 Py_DECREF(data);
824 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
825 return NULL;
826 }
827 if (PyBytes_GET_SIZE(data) == 0) {
828 /* EOF */
829 Py_DECREF(data);
830 break;
831 }
832 r = PyList_Append(chunks, data);
833 Py_DECREF(data);
834 if (r < 0) {
835 Py_DECREF(chunks);
836 return NULL;
837 }
838 }
839 result = _PyBytes_Join(_PyIO_empty_bytes, chunks);
840 Py_DECREF(chunks);
841 return result;
842}
843
844static PyMethodDef rawiobase_methods[] = {
845 {"read", rawiobase_read, METH_VARARGS},
846 {"readall", rawiobase_readall, METH_NOARGS, rawiobase_readall_doc},
847 {NULL, NULL}
848};
849
850PyTypeObject PyRawIOBase_Type = {
851 PyVarObject_HEAD_INIT(NULL, 0)
852 "_io._RawIOBase", /*tp_name*/
853 0, /*tp_basicsize*/
854 0, /*tp_itemsize*/
855 0, /*tp_dealloc*/
856 0, /*tp_print*/
857 0, /*tp_getattr*/
858 0, /*tp_setattr*/
859 0, /*tp_compare */
860 0, /*tp_repr*/
861 0, /*tp_as_number*/
862 0, /*tp_as_sequence*/
863 0, /*tp_as_mapping*/
864 0, /*tp_hash */
865 0, /*tp_call*/
866 0, /*tp_str*/
867 0, /*tp_getattro*/
868 0, /*tp_setattro*/
869 0, /*tp_as_buffer*/
870 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
871 rawiobase_doc, /* tp_doc */
872 0, /* tp_traverse */
873 0, /* tp_clear */
874 0, /* tp_richcompare */
875 0, /* tp_weaklistoffset */
876 0, /* tp_iter */
877 0, /* tp_iternext */
878 rawiobase_methods, /* tp_methods */
879 0, /* tp_members */
880 0, /* tp_getset */
881 &PyIOBase_Type, /* tp_base */
882 0, /* tp_dict */
883 0, /* tp_descr_get */
884 0, /* tp_descr_set */
885 0, /* tp_dictoffset */
886 0, /* tp_init */
887 0, /* tp_alloc */
888 0, /* tp_new */
889};