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
);
224 if (size
== -1 && PyErr_Occurred())
227 else if (arg
== Py_None
) {
228 /* Read until EOF is reached, by default. */
232 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
233 Py_TYPE(arg
)->tp_name
);
237 /* adjust invalid sizes */
238 n
= self
->string_size
- self
->pos
;
239 if (size
< 0 || size
> n
) {
245 assert(self
->buf
!= NULL
);
246 output
= self
->buf
+ self
->pos
;
249 return PyString_FromStringAndSize(output
, size
);
253 PyDoc_STRVAR(read1_doc
,
254 "read1(size) -> read at most size bytes, returned as a string.\n"
256 "If the size argument is negative or omitted, read until EOF is reached.\n"
257 "Return an empty string at EOF.");
260 bytesio_read1(BytesIOObject
*self
, PyObject
*n
)
264 arg
= PyTuple_Pack(1, n
);
267 res
= bytesio_read(self
, arg
);
272 PyDoc_STRVAR(readline_doc
,
273 "readline([size]) -> next line from the file, as a string.\n"
275 "Retain newline. A non-negative size argument limits the maximum\n"
276 "number of bytes to return (an incomplete line may be returned then).\n"
277 "Return an empty string at EOF.\n");
280 bytesio_readline(BytesIOObject
*self
, PyObject
*args
)
284 PyObject
*arg
= Py_None
;
288 if (!PyArg_ParseTuple(args
, "|O:readline", &arg
))
291 if (PyInt_Check(arg
)) {
292 size
= PyInt_AsSsize_t(arg
);
293 if (size
== -1 && PyErr_Occurred())
296 else if (arg
== Py_None
) {
297 /* No size limit, by default. */
301 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
302 Py_TYPE(arg
)->tp_name
);
306 n
= get_line(self
, &output
);
308 if (size
>= 0 && size
< n
) {
314 return PyString_FromStringAndSize(output
, n
);
317 PyDoc_STRVAR(readlines_doc
,
318 "readlines([size]) -> list of strings, each a line from the file.\n"
320 "Call readline() repeatedly and return a list of the lines so read.\n"
321 "The optional size argument, if given, is an approximate bound on the\n"
322 "total number of bytes in the lines returned.\n");
325 bytesio_readlines(BytesIOObject
*self
, PyObject
*args
)
327 Py_ssize_t maxsize
, size
, n
;
328 PyObject
*result
, *line
;
330 PyObject
*arg
= Py_None
;
334 if (!PyArg_ParseTuple(args
, "|O:readlines", &arg
))
337 if (PyInt_Check(arg
)) {
338 maxsize
= PyInt_AsSsize_t(arg
);
339 if (maxsize
== -1 && PyErr_Occurred())
342 else if (arg
== Py_None
) {
343 /* No size limit, by default. */
347 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
348 Py_TYPE(arg
)->tp_name
);
353 result
= PyList_New(0);
357 while ((n
= get_line(self
, &output
)) != 0) {
358 line
= PyString_FromStringAndSize(output
, n
);
361 if (PyList_Append(result
, line
) == -1) {
367 if (maxsize
> 0 && size
>= maxsize
)
377 PyDoc_STRVAR(readinto_doc
,
378 "readinto(bytearray) -> int. Read up to len(b) bytes into b.\n"
380 "Returns number of bytes read (0 for EOF), or None if the object\n"
381 "is set not to block as has no data to read.");
384 bytesio_readinto(BytesIOObject
*self
, PyObject
*buffer
)
391 if (PyObject_AsWriteBuffer(buffer
, &raw_buffer
, &len
) == -1)
394 if (self
->pos
+ len
> self
->string_size
)
395 len
= self
->string_size
- self
->pos
;
397 memcpy(raw_buffer
, self
->buf
+ self
->pos
, len
);
398 assert(self
->pos
+ len
< PY_SSIZE_T_MAX
);
402 return PyInt_FromSsize_t(len
);
405 PyDoc_STRVAR(truncate_doc
,
406 "truncate([size]) -> int. Truncate the file to at most size bytes.\n"
408 "Size defaults to the current file position, as returned by tell().\n"
409 "Returns the new size. Imply an absolute seek to the position size.");
412 bytesio_truncate(BytesIOObject
*self
, PyObject
*args
)
415 PyObject
*arg
= Py_None
;
419 if (!PyArg_ParseTuple(args
, "|O:truncate", &arg
))
422 if (PyInt_Check(arg
)) {
423 size
= PyInt_AsSsize_t(arg
);
424 if (size
== -1 && PyErr_Occurred())
427 else if (arg
== Py_None
) {
428 /* Truncate to current position if no argument is passed. */
432 PyErr_Format(PyExc_TypeError
, "integer argument expected, got '%s'",
433 Py_TYPE(arg
)->tp_name
);
438 PyErr_Format(PyExc_ValueError
,
439 "negative size value %zd", size
);
443 if (size
< self
->string_size
) {
444 self
->string_size
= size
;
445 if (resize_buffer(self
, size
) < 0)
450 return PyInt_FromSsize_t(size
);
454 bytesio_iternext(BytesIOObject
*self
)
461 n
= get_line(self
, &next
);
466 return PyString_FromStringAndSize(next
, n
);
469 PyDoc_STRVAR(seek_doc
,
470 "seek(pos, whence=0) -> int. Change stream position.\n"
472 "Seek to byte offset pos relative to position indicated by whence:\n"
473 " 0 Start of stream (the default). pos should be >= 0;\n"
474 " 1 Current position - pos may be negative;\n"
475 " 2 End of stream - pos usually negative.\n"
476 "Returns the new absolute position.");
479 bytesio_seek(BytesIOObject
*self
, PyObject
*args
)
481 PyObject
*pos_obj
, *mode_obj
;
487 /* Special-case for 2.x to prevent floats from passing through.
488 This only needed to make a test in test_io succeed. */
489 if (!PyArg_UnpackTuple(args
, "seek", 1, 2, &pos_obj
, &mode_obj
))
491 if (PyFloat_Check(pos_obj
)) {
492 PyErr_SetString(PyExc_TypeError
,
493 "position argument must be an integer");
497 if (!PyArg_ParseTuple(args
, "n|i:seek", &pos
, &mode
))
500 if (pos
< 0 && mode
== 0) {
501 PyErr_Format(PyExc_ValueError
,
502 "negative seek value %zd", pos
);
506 /* mode 0: offset relative to beginning of the string.
507 mode 1: offset relative to current position.
508 mode 2: offset relative the end of the string. */
510 if (pos
> PY_SSIZE_T_MAX
- self
->pos
) {
511 PyErr_SetString(PyExc_OverflowError
,
512 "new position too large");
517 else if (mode
== 2) {
518 if (pos
> PY_SSIZE_T_MAX
- self
->string_size
) {
519 PyErr_SetString(PyExc_OverflowError
,
520 "new position too large");
523 pos
+= self
->string_size
;
525 else if (mode
!= 0) {
526 PyErr_Format(PyExc_ValueError
,
527 "invalid whence (%i, should be 0, 1 or 2)", mode
);
535 return PyInt_FromSsize_t(self
->pos
);
538 PyDoc_STRVAR(write_doc
,
539 "write(bytes) -> int. Write bytes to file.\n"
541 "Return the number of bytes written.");
544 bytesio_write(BytesIOObject
*self
, PyObject
*obj
)
552 /* Special-case in 2.x to prevent unicode objects to pass through. */
553 if (PyUnicode_Check(obj
)) {
554 PyErr_SetString(PyExc_TypeError
,
555 "expecting a bytes object, got unicode");
559 if (PyObject_AsReadBuffer(obj
, (void *)&bytes
, &size
) < 0)
563 n
= write_bytes(self
, bytes
, size
);
568 return PyInt_FromSsize_t(n
);
571 PyDoc_STRVAR(writelines_doc
,
572 "writelines(sequence_of_strings) -> None. Write strings to the file.\n"
574 "Note that newlines are not added. The sequence can be any iterable\n"
575 "object producing strings. This is equivalent to calling write() for\n"
579 bytesio_writelines(BytesIOObject
*self
, PyObject
*v
)
586 it
= PyObject_GetIter(v
);
590 while ((item
= PyIter_Next(it
)) != NULL
) {
591 ret
= bytesio_write(self
, item
);
601 /* See if PyIter_Next failed */
602 if (PyErr_Occurred())
608 PyDoc_STRVAR(close_doc
,
609 "close() -> None. Disable all I/O operations.");
612 bytesio_close(BytesIOObject
*self
)
614 if (self
->buf
!= NULL
) {
615 PyMem_Free(self
->buf
);
622 bytesio_dealloc(BytesIOObject
*self
)
624 if (self
->buf
!= NULL
) {
625 PyMem_Free(self
->buf
);
628 Py_TYPE(self
)->tp_free(self
);
632 bytesio_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
)
636 assert(type
!= NULL
&& type
->tp_alloc
!= NULL
);
637 self
= (BytesIOObject
*)type
->tp_alloc(type
, 0);
641 self
->string_size
= 0;
644 self
->buf
= (char *)PyMem_Malloc(0);
645 if (self
->buf
== NULL
) {
647 return PyErr_NoMemory();
650 return (PyObject
*)self
;
654 bytesio_init(BytesIOObject
*self
, PyObject
*args
, PyObject
*kwds
)
656 PyObject
*initvalue
= NULL
;
658 if (!PyArg_ParseTuple(args
, "|O:BytesIO", &initvalue
))
661 /* In case, __init__ is called multiple times. */
662 self
->string_size
= 0;
665 if (initvalue
&& initvalue
!= Py_None
) {
667 res
= bytesio_write(self
, initvalue
);
677 static PyGetSetDef bytesio_getsetlist
[] = {
678 {"closed", (getter
)bytesio_get_closed
, NULL
,
679 "True if the file is closed."},
683 static struct PyMethodDef bytesio_methods
[] = {
684 {"readable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
685 {"seekable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
686 {"writable", (PyCFunction
)return_true
, METH_NOARGS
, NULL
},
687 {"close", (PyCFunction
)bytesio_close
, METH_NOARGS
, close_doc
},
688 {"flush", (PyCFunction
)bytesio_flush
, METH_NOARGS
, flush_doc
},
689 {"isatty", (PyCFunction
)bytesio_isatty
, METH_NOARGS
, isatty_doc
},
690 {"tell", (PyCFunction
)bytesio_tell
, METH_NOARGS
, tell_doc
},
691 {"write", (PyCFunction
)bytesio_write
, METH_O
, write_doc
},
692 {"writelines", (PyCFunction
)bytesio_writelines
, METH_O
, writelines_doc
},
693 {"read1", (PyCFunction
)bytesio_read1
, METH_O
, read1_doc
},
694 {"readinto", (PyCFunction
)bytesio_readinto
, METH_O
, readinto_doc
},
695 {"readline", (PyCFunction
)bytesio_readline
, METH_VARARGS
, readline_doc
},
696 {"readlines", (PyCFunction
)bytesio_readlines
, METH_VARARGS
, readlines_doc
},
697 {"read", (PyCFunction
)bytesio_read
, METH_VARARGS
, read_doc
},
698 {"getvalue", (PyCFunction
)bytesio_getvalue
, METH_VARARGS
, getval_doc
},
699 {"seek", (PyCFunction
)bytesio_seek
, METH_VARARGS
, seek_doc
},
700 {"truncate", (PyCFunction
)bytesio_truncate
, METH_VARARGS
, truncate_doc
},
701 {NULL
, NULL
} /* sentinel */
704 PyDoc_STRVAR(bytesio_doc
,
705 "BytesIO([buffer]) -> object\n"
707 "Create a buffered I/O implementation using an in-memory bytes\n"
708 "buffer, ready for reading and writing.");
710 static PyTypeObject BytesIO_Type
= {
711 PyVarObject_HEAD_INIT(NULL
, 0)
712 "_bytesio._BytesIO", /*tp_name*/
713 sizeof(BytesIOObject
), /*tp_basicsize*/
715 (destructor
)bytesio_dealloc
, /*tp_dealloc*/
722 0, /*tp_as_sequence*/
730 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /*tp_flags*/
731 bytesio_doc
, /*tp_doc*/
734 0, /*tp_richcompare*/
735 0, /*tp_weaklistoffset*/
736 PyObject_SelfIter
, /*tp_iter*/
737 (iternextfunc
)bytesio_iternext
, /*tp_iternext*/
738 bytesio_methods
, /*tp_methods*/
740 bytesio_getsetlist
, /*tp_getset*/
746 (initproc
)bytesio_init
, /*tp_init*/
748 bytesio_new
, /*tp_new*/
756 if (PyType_Ready(&BytesIO_Type
) < 0)
758 m
= Py_InitModule("_bytesio", NULL
);
761 Py_INCREF(&BytesIO_Type
);
762 PyModule_AddObject(m
, "_BytesIO", (PyObject
*)&BytesIO_Type
);