7 Py_ssize_t string_size
;
11 #define CHECK_CLOSED(self) \
12 if ((self)->buf == NULL) { \
13 PyErr_SetString(PyExc_ValueError, \
14 "I/O operation on closed file."); \
18 /* Internal routine to get a line from the buffer of a BytesIO
19 object. Returns the length between the current position to the
20 next newline character. */
22 get_line(BytesIOObject
*self
, char **output
)
28 assert(self
->buf
!= NULL
);
30 /* Move to the end of the line, up to the end of the string, s. */
31 str_end
= self
->buf
+ self
->string_size
;
32 for (n
= self
->buf
+ self
->pos
;
33 n
< str_end
&& *n
!= '\n';
36 /* Skip the newline character */
40 /* Get the length from the current position to the end of the line. */
41 len
= n
- (self
->buf
+ self
->pos
);
42 *output
= self
->buf
+ self
->pos
;
45 assert(self
->pos
< PY_SSIZE_T_MAX
- len
);
51 /* Internal routine for changing the size of the buffer of BytesIO objects.
52 The caller should ensure that the 'size' argument is non-negative. Returns
53 0 on success, -1 otherwise. */
55 resize_buffer(BytesIOObject
*self
, size_t size
)
57 /* Here, unsigned types are used to avoid dealing with signed integer
58 overflow, which is undefined in C. */
59 size_t alloc
= self
->buf_size
;
62 assert(self
->buf
!= NULL
);
64 /* For simplicity, stay in the range of the signed type. Anyway, Python
65 doesn't allow strings to be longer than this. */
66 if (size
> PY_SSIZE_T_MAX
)
69 if (size
< alloc
/ 2) {
70 /* Major downsize; resize down to exact size. */
73 else if (size
< alloc
) {
74 /* Within allocated size; quick exit */
77 else if (size
<= alloc
* 1.125) {
78 /* Moderate upsize; overallocate similar to list_resize() */
79 alloc
= size
+ (size
>> 3) + (size
< 9 ? 3 : 6);
82 /* Major upsize; resize up to exact size */
86 if (alloc
> ((size_t)-1) / sizeof(char))
88 new_buf
= (char *)PyMem_Realloc(self
->buf
, alloc
* sizeof(char));
89 if (new_buf
== NULL
) {
93 self
->buf_size
= alloc
;
99 PyErr_SetString(PyExc_OverflowError
,
100 "new buffer size too large");
104 /* Internal routine for writing a string of bytes to the buffer of a BytesIO
105 object. Returns the number of bytes wrote, or -1 on error. */
107 write_bytes(BytesIOObject
*self
, const char *bytes
, Py_ssize_t len
)
109 assert(self
->buf
!= NULL
);
110 assert(self
->pos
>= 0);
113 if ((size_t)self
->pos
+ len
> self
->buf_size
) {
114 if (resize_buffer(self
, (size_t)self
->pos
+ len
) < 0)
118 if (self
->pos
> self
->string_size
) {
119 /* In case of overseek, pad with null bytes the buffer region between
120 the end of stream and the current position.
123 | |<---used--->|<----------available----------->|
124 | | <--to pad-->|<---to write---> |
127 memset(self
->buf
+ self
->string_size
, '\0',
128 (self
->pos
- self
->string_size
) * sizeof(char));
131 /* Copy the data to the internal buffer, overwriting some of the existing
132 data if self->pos < self->string_size. */
133 memcpy(self
->buf
+ self
->pos
, bytes
, len
);
136 /* Set the new length of the internal string if it has changed. */
137 if (self
->string_size
< self
->pos
) {
138 self
->string_size
= self
->pos
;
145 bytesio_get_closed(BytesIOObject
*self
)
147 if (self
->buf
== NULL
)
153 /* Generic getter for the writable, readable and seekable properties */
155 return_true(BytesIOObject
*self
)
160 PyDoc_STRVAR(flush_doc
,
161 "flush() -> None. Does nothing.");
164 bytesio_flush(BytesIOObject
*self
)
169 PyDoc_STRVAR(getval_doc
,
170 "getvalue() -> bytes.\n"
172 "Retrieve the entire contents of the BytesIO object.");
175 bytesio_getvalue(BytesIOObject
*self
)
178 return PyString_FromStringAndSize(self
->buf
, self
->string_size
);
181 PyDoc_STRVAR(isatty_doc
,
182 "isatty() -> False.\n"
184 "Always returns False since BytesIO objects are not connected\n"
185 "to a tty-like device.");
188 bytesio_isatty(BytesIOObject
*self
)
194 PyDoc_STRVAR(tell_doc
,
195 "tell() -> current file position, an integer\n");
198 bytesio_tell(BytesIOObject
*self
)
201 return PyInt_FromSsize_t(self
->pos
);
204 PyDoc_STRVAR(read_doc
,
205 "read([size]) -> read at most size bytes, returned as a string.\n"
207 "If the size argument is negative, read until EOF is reached.\n"
208 "Return an empty string at EOF.");
211 bytesio_read(BytesIOObject
*self
, PyObject
*args
)
215 PyObject
*arg
= Py_None
;
219 if (!PyArg_ParseTuple(args
, "|O:read", &arg
))
222 if (PyInt_Check(arg
)) {
223 size
= PyInt_AsSsize_t(arg
);
225 else if (arg
== Py_None
) {
226 /* Read until EOF is reached, by default. */
230 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
231 Py_TYPE(arg
)->tp_name
);
235 /* adjust invalid sizes */
236 n
= self
->string_size
- self
->pos
;
237 if (size
< 0 || size
> n
) {
243 assert(self
->buf
!= NULL
);
244 output
= self
->buf
+ self
->pos
;
247 return PyString_FromStringAndSize(output
, size
);
251 PyDoc_STRVAR(read1_doc
,
252 "read1(size) -> read at most size bytes, returned as a string.\n"
254 "If the size argument is negative or omitted, read until EOF is reached.\n"
255 "Return an empty string at EOF.");
258 bytesio_read1(BytesIOObject
*self
, PyObject
*n
)
262 arg
= PyTuple_Pack(1, n
);
265 res
= bytesio_read(self
, arg
);
270 PyDoc_STRVAR(readline_doc
,
271 "readline([size]) -> next line from the file, as a string.\n"
273 "Retain newline. A non-negative size argument limits the maximum\n"
274 "number of bytes to return (an incomplete line may be returned then).\n"
275 "Return an empty string at EOF.\n");
278 bytesio_readline(BytesIOObject
*self
, PyObject
*args
)
282 PyObject
*arg
= Py_None
;
286 if (!PyArg_ParseTuple(args
, "|O:readline", &arg
))
289 if (PyInt_Check(arg
)) {
290 size
= PyInt_AsSsize_t(arg
);
292 else if (arg
== Py_None
) {
293 /* No size limit, by default. */
297 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
298 Py_TYPE(arg
)->tp_name
);
302 n
= get_line(self
, &output
);
304 if (size
>= 0 && size
< n
) {
310 return PyString_FromStringAndSize(output
, n
);
313 PyDoc_STRVAR(readlines_doc
,
314 "readlines([size]) -> list of strings, each a line from the file.\n"
316 "Call readline() repeatedly and return a list of the lines so read.\n"
317 "The optional size argument, if given, is an approximate bound on the\n"
318 "total number of bytes in the lines returned.\n");
321 bytesio_readlines(BytesIOObject
*self
, PyObject
*args
)
323 Py_ssize_t maxsize
, size
, n
;
324 PyObject
*result
, *line
;
326 PyObject
*arg
= Py_None
;
330 if (!PyArg_ParseTuple(args
, "|O:readlines", &arg
))
333 if (PyInt_Check(arg
)) {
334 maxsize
= PyInt_AsSsize_t(arg
);
336 else if (arg
== Py_None
) {
337 /* No size limit, by default. */
341 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
342 Py_TYPE(arg
)->tp_name
);
347 result
= PyList_New(0);
351 while ((n
= get_line(self
, &output
)) != 0) {
352 line
= PyString_FromStringAndSize(output
, n
);
355 if (PyList_Append(result
, line
) == -1) {
361 if (maxsize
> 0 && size
>= maxsize
)
371 PyDoc_STRVAR(readinto_doc
,
372 "readinto(bytearray) -> int. Read up to len(b) bytes into b.\n"
374 "Returns number of bytes read (0 for EOF), or None if the object\n"
375 "is set not to block as has no data to read.");
378 bytesio_readinto(BytesIOObject
*self
, PyObject
*buffer
)
385 if (PyObject_AsWriteBuffer(buffer
, &raw_buffer
, &len
) == -1)
388 if (self
->pos
+ len
> self
->string_size
)
389 len
= self
->string_size
- self
->pos
;
391 memcpy(raw_buffer
, self
->buf
+ self
->pos
, len
);
392 assert(self
->pos
+ len
< PY_SSIZE_T_MAX
);
396 return PyInt_FromSsize_t(len
);
399 PyDoc_STRVAR(truncate_doc
,
400 "truncate([size]) -> int. Truncate the file to at most size bytes.\n"
402 "Size defaults to the current file position, as returned by tell().\n"
403 "Returns the new size. Imply an absolute seek to the position size.");
406 bytesio_truncate(BytesIOObject
*self
, PyObject
*args
)
409 PyObject
*arg
= Py_None
;
413 if (!PyArg_ParseTuple(args
, "|O:truncate", &arg
))
416 if (PyInt_Check(arg
)) {
417 size
= PyInt_AsSsize_t(arg
);
419 else if (arg
== Py_None
) {
420 /* Truncate to current position if no argument is passed. */
424 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
425 Py_TYPE(arg
)->tp_name
);
430 PyErr_Format(PyExc_ValueError
,
431 "negative size value %zd", size
);
435 if (size
< self
->string_size
) {
436 self
->string_size
= size
;
437 if (resize_buffer(self
, size
) < 0)
442 return PyInt_FromSsize_t(size
);
446 bytesio_iternext(BytesIOObject
*self
)
453 n
= get_line(self
, &next
);
458 return PyString_FromStringAndSize(next
, n
);
461 PyDoc_STRVAR(seek_doc
,
462 "seek(pos, whence=0) -> int. Change stream position.\n"
464 "Seek to byte offset pos relative to position indicated by whence:\n"
465 " 0 Start of stream (the default). pos should be >= 0;\n"
466 " 1 Current position - pos may be negative;\n"
467 " 2 End of stream - pos usually negative.\n"
468 "Returns the new absolute position.");
471 bytesio_seek(BytesIOObject
*self
, PyObject
*args
)
473 PyObject
*pos_obj
, *mode_obj
;
479 /* Special-case for 2.x to prevent floats from passing through.
480 This only needed to make a test in test_io succeed. */
481 if (!PyArg_UnpackTuple(args
, "seek", 1, 2, &pos_obj
, &mode_obj
))
483 if (PyFloat_Check(pos_obj
)) {
484 PyErr_SetString(PyExc_TypeError
,
485 "position argument must be an integer");
489 if (!PyArg_ParseTuple(args
, "n|i:seek", &pos
, &mode
))
492 if (pos
< 0 && mode
== 0) {
493 PyErr_Format(PyExc_ValueError
,
494 "negative seek value %zd", pos
);
498 /* mode 0: offset relative to beginning of the string.
499 mode 1: offset relative to current position.
500 mode 2: offset relative the end of the string. */
502 if (pos
> PY_SSIZE_T_MAX
- self
->pos
) {
503 PyErr_SetString(PyExc_OverflowError
,
504 "new position too large");
509 else if (mode
== 2) {
510 if (pos
> PY_SSIZE_T_MAX
- self
->string_size
) {
511 PyErr_SetString(PyExc_OverflowError
,
512 "new position too large");
515 pos
+= self
->string_size
;
517 else if (mode
!= 0) {
518 PyErr_Format(PyExc_ValueError
,
519 "invalid whence (%i, should be 0, 1 or 2)", mode
);
527 return PyInt_FromSsize_t(self
->pos
);
530 PyDoc_STRVAR(write_doc
,
531 "write(bytes) -> int. Write bytes to file.\n"
533 "Return the number of bytes written.");
536 bytesio_write(BytesIOObject
*self
, PyObject
*obj
)
544 /* Special-case in 2.x to prevent unicode objects to pass through. */
545 if (PyUnicode_Check(obj
)) {
546 PyErr_SetString(PyExc_TypeError
,
547 "expecting a bytes object, got unicode");
551 if (PyObject_AsReadBuffer(obj
, (void *)&bytes
, &size
) < 0)
555 n
= write_bytes(self
, bytes
, size
);
560 return PyInt_FromSsize_t(n
);
563 PyDoc_STRVAR(writelines_doc
,
564 "writelines(sequence_of_strings) -> None. Write strings to the file.\n"
566 "Note that newlines are not added. The sequence can be any iterable\n"
567 "object producing strings. This is equivalent to calling write() for\n"
571 bytesio_writelines(BytesIOObject
*self
, PyObject
*v
)
578 it
= PyObject_GetIter(v
);
582 while ((item
= PyIter_Next(it
)) != NULL
) {
583 ret
= bytesio_write(self
, item
);
593 /* See if PyIter_Next failed */
594 if (PyErr_Occurred())
600 PyDoc_STRVAR(close_doc
,
601 "close() -> None. Disable all I/O operations.");
604 bytesio_close(BytesIOObject
*self
)
606 if (self
->buf
!= NULL
) {
607 PyMem_Free(self
->buf
);
614 bytesio_dealloc(BytesIOObject
*self
)
616 if (self
->buf
!= NULL
) {
617 PyMem_Free(self
->buf
);
620 Py_TYPE(self
)->tp_free(self
);
624 bytesio_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
)
628 assert(type
!= NULL
&& type
->tp_alloc
!= NULL
);
629 self
= (BytesIOObject
*)type
->tp_alloc(type
, 0);
633 self
->string_size
= 0;
636 self
->buf
= (char *)PyMem_Malloc(0);
637 if (self
->buf
== NULL
) {
639 return PyErr_NoMemory();
642 return (PyObject
*)self
;
646 bytesio_init(BytesIOObject
*self
, PyObject
*args
, PyObject
*kwds
)
648 PyObject
*initvalue
= NULL
;
650 if (!PyArg_ParseTuple(args
, "|O:BytesIO", &initvalue
))
653 /* In case, __init__ is called multiple times. */
654 self
->string_size
= 0;
657 if (initvalue
&& initvalue
!= Py_None
) {
659 res
= bytesio_write(self
, initvalue
);
669 static PyGetSetDef bytesio_getsetlist
[] = {
670 {"closed", (getter
)bytesio_get_closed
, NULL
,
671 "True if the file is closed."},
675 static struct PyMethodDef bytesio_methods
[] = {
676 {"readable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
677 {"seekable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
678 {"writable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
679 {"close", (PyCFunction
)bytesio_close
, METH_NOARGS
, close_doc
},
680 {"flush", (PyCFunction
)bytesio_flush
, METH_NOARGS
, flush_doc
},
681 {"isatty", (PyCFunction
)bytesio_isatty
, METH_NOARGS
, isatty_doc
},
682 {"tell", (PyCFunction
)bytesio_tell
, METH_NOARGS
, tell_doc
},
683 {"write", (PyCFunction
)bytesio_write
, METH_O
, write_doc
},
684 {"writelines", (PyCFunction
)bytesio_writelines
, METH_O
, writelines_doc
},
685 {"read1", (PyCFunction
)bytesio_read1
, METH_O
, read1_doc
},
686 {"readinto", (PyCFunction
)bytesio_readinto
, METH_O
, readinto_doc
},
687 {"readline", (PyCFunction
)bytesio_readline
, METH_VARARGS
, readline_doc
},
688 {"readlines", (PyCFunction
)bytesio_readlines
, METH_VARARGS
, readlines_doc
},
689 {"read", (PyCFunction
)bytesio_read
, METH_VARARGS
, read_doc
},
690 {"getvalue", (PyCFunction
)bytesio_getvalue
, METH_VARARGS
, getval_doc
},
691 {"seek", (PyCFunction
)bytesio_seek
, METH_VARARGS
, seek_doc
},
692 {"truncate", (PyCFunction
)bytesio_truncate
, METH_VARARGS
, truncate_doc
},
693 {NULL
, NULL
} /* sentinel */
696 PyDoc_STRVAR(bytesio_doc
,
697 "BytesIO([buffer]) -> object\n"
699 "Create a buffered I/O implementation using an in-memory bytes\n"
700 "buffer, ready for reading and writing.");
702 static PyTypeObject BytesIO_Type
= {
703 PyVarObject_HEAD_INIT(NULL
, 0)
704 "_bytesio._BytesIO", /*tp_name*/
705 sizeof(BytesIOObject
), /*tp_basicsize*/
707 (destructor
)bytesio_dealloc
, /*tp_dealloc*/
714 0, /*tp_as_sequence*/
722 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /*tp_flags*/
723 bytesio_doc
, /*tp_doc*/
726 0, /*tp_richcompare*/
727 0, /*tp_weaklistoffset*/
728 PyObject_SelfIter
, /*tp_iter*/
729 (iternextfunc
)bytesio_iternext
, /*tp_iternext*/
730 bytesio_methods
, /*tp_methods*/
732 bytesio_getsetlist
, /*tp_getset*/
738 (initproc
)bytesio_init
, /*tp_init*/
740 bytesio_new
, /*tp_new*/
748 if (PyType_Ready(&BytesIO_Type
) < 0)
750 m
= Py_InitModule("_bytesio", NULL
);
753 Py_INCREF(&BytesIO_Type
);
754 PyModule_AddObject(m
, "_BytesIO", (PyObject
*)&BytesIO_Type
);