blob: f9bca1ab73d886ec675f8ed35a8fe50cd6b5a583 [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001/*
2 An implementation of the new I/O lib as defined by PEP 3116 - "New I/O"
3
4 Classes defined here: UnsupportedOperation, BlockingIOError.
5 Functions defined here: open().
6
7 Mostly written by Amaury Forgeot d'Arc
8*/
9
10#define PY_SSIZE_T_CLEAN
11#include "Python.h"
12#include "structmember.h"
13#include "_iomodule.h"
14
15#ifdef HAVE_SYS_TYPES_H
16#include <sys/types.h>
17#endif /* HAVE_SYS_TYPES_H */
18
19#ifdef HAVE_SYS_STAT_H
20#include <sys/stat.h>
21#endif /* HAVE_SYS_STAT_H */
22
23
24/* Various interned strings */
25
26PyObject *_PyIO_str_close;
27PyObject *_PyIO_str_closed;
28PyObject *_PyIO_str_decode;
29PyObject *_PyIO_str_encode;
30PyObject *_PyIO_str_fileno;
31PyObject *_PyIO_str_flush;
32PyObject *_PyIO_str_getstate;
33PyObject *_PyIO_str_isatty;
34PyObject *_PyIO_str_newlines;
35PyObject *_PyIO_str_nl;
36PyObject *_PyIO_str_read;
37PyObject *_PyIO_str_read1;
38PyObject *_PyIO_str_readable;
Victor Stinnerb57f1082011-05-26 00:19:38 +020039PyObject *_PyIO_str_readall;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000040PyObject *_PyIO_str_readinto;
41PyObject *_PyIO_str_readline;
42PyObject *_PyIO_str_reset;
43PyObject *_PyIO_str_seek;
44PyObject *_PyIO_str_seekable;
Antoine Pitroue4501852009-05-14 18:55:55 +000045PyObject *_PyIO_str_setstate;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000046PyObject *_PyIO_str_tell;
47PyObject *_PyIO_str_truncate;
48PyObject *_PyIO_str_writable;
49PyObject *_PyIO_str_write;
50
51PyObject *_PyIO_empty_str;
52PyObject *_PyIO_empty_bytes;
Antoine Pitroue4501852009-05-14 18:55:55 +000053PyObject *_PyIO_zero;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000054
55
56PyDoc_STRVAR(module_doc,
57"The io module provides the Python interfaces to stream handling. The\n"
58"builtin open function is defined in this module.\n"
59"\n"
60"At the top of the I/O hierarchy is the abstract base class IOBase. It\n"
61"defines the basic interface to a stream. Note, however, that there is no\n"
62"seperation between reading and writing to streams; implementations are\n"
63"allowed to throw an IOError if they do not support a given operation.\n"
64"\n"
65"Extending IOBase is RawIOBase which deals simply with the reading and\n"
Benjamin Peterson8f2b6652009-04-05 00:46:27 +000066"writing of raw bytes to a stream. FileIO subclasses RawIOBase to provide\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000067"an interface to OS files.\n"
68"\n"
69"BufferedIOBase deals with buffering on a raw byte stream (RawIOBase). Its\n"
70"subclasses, BufferedWriter, BufferedReader, and BufferedRWPair buffer\n"
71"streams that are readable, writable, and both respectively.\n"
72"BufferedRandom provides a buffered interface to random access\n"
73"streams. BytesIO is a simple stream of in-memory bytes.\n"
74"\n"
75"Another IOBase subclass, TextIOBase, deals with the encoding and decoding\n"
76"of streams into text. TextIOWrapper, which extends it, is a buffered text\n"
77"interface to a buffered raw stream (`BufferedIOBase`). Finally, StringIO\n"
78"is a in-memory stream for text.\n"
79"\n"
80"Argument names are not part of the specification, and only the arguments\n"
81"of open() are intended to be used as keyword arguments.\n"
82"\n"
83"data:\n"
84"\n"
85"DEFAULT_BUFFER_SIZE\n"
86"\n"
87" An int containing the default buffer size used by the module's buffered\n"
88" I/O classes. open() uses the file's blksize (as obtained by os.stat) if\n"
89" possible.\n"
90 );
91
92
93/*
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000094 * The main open() function
95 */
96PyDoc_STRVAR(open_doc,
Georg Brandle40ee502010-07-11 09:33:39 +000097"open(file, mode='r', buffering=-1, encoding=None,\n"
Ross Lagerwall59142db2011-10-31 20:34:46 +020098" errors=None, newline=None, closefd=True, opener=None) -> file object\n"
Georg Brandl5e8f6d12009-12-23 10:30:45 +000099"\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000100"Open file and return a stream. Raise IOError upon failure.\n"
101"\n"
102"file is either a text or byte string giving the name (and the path\n"
103"if the file isn't in the current working directory) of the file to\n"
104"be opened or an integer file descriptor of the file to be\n"
105"wrapped. (If a file descriptor is given, it is closed when the\n"
106"returned I/O object is closed, unless closefd is set to False.)\n"
107"\n"
108"mode is an optional string that specifies the mode in which the file\n"
109"is opened. It defaults to 'r' which means open for reading in text\n"
110"mode. Other common values are 'w' for writing (truncating the file if\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100111"it already exists), 'x' for creating and writing to a new file, and\n"
112"'a' for appending (which on some Unix systems, means that all writes\n"
113"append to the end of the file regardless of the current seek position).\n"
114"In text mode, if encoding is not specified the encoding used is platform\n"
115"dependent. (For reading and writing raw bytes use binary mode and leave\n"
116"encoding unspecified.) The available modes are:\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000117"\n"
118"========= ===============================================================\n"
119"Character Meaning\n"
120"--------- ---------------------------------------------------------------\n"
121"'r' open for reading (default)\n"
122"'w' open for writing, truncating the file first\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100123"'x' create a new file and open it for writing\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000124"'a' open for writing, appending to the end of the file if it exists\n"
125"'b' binary mode\n"
126"'t' text mode (default)\n"
127"'+' open a disk file for updating (reading and writing)\n"
128"'U' universal newline mode (for backwards compatibility; unneeded\n"
129" for new code)\n"
130"========= ===============================================================\n"
131"\n"
132"The default mode is 'rt' (open for reading text). For binary random\n"
133"access, the mode 'w+b' opens and truncates the file to 0 bytes, while\n"
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100134"'r+b' opens the file without truncation. The 'x' mode implies 'w' and\n"
135"raises an `FileExistsError` if the file already exists.\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000136"\n"
137"Python distinguishes between files opened in binary and text modes,\n"
138"even when the underlying operating system doesn't. Files opened in\n"
139"binary mode (appending 'b' to the mode argument) return contents as\n"
140"bytes objects without any decoding. In text mode (the default, or when\n"
141"'t' is appended to the mode argument), the contents of the file are\n"
142"returned as strings, the bytes having been first decoded using a\n"
143"platform-dependent encoding or using the specified encoding if given.\n"
144"\n"
Antoine Pitroud5587bc2009-12-19 21:08:31 +0000145"buffering is an optional integer used to set the buffering policy.\n"
146"Pass 0 to switch buffering off (only allowed in binary mode), 1 to select\n"
147"line buffering (only usable in text mode), and an integer > 1 to indicate\n"
148"the size of a fixed-size chunk buffer. When no buffering argument is\n"
149"given, the default buffering policy works as follows:\n"
150"\n"
151"* Binary files are buffered in fixed-size chunks; the size of the buffer\n"
152" is chosen using a heuristic trying to determine the underlying device's\n"
153" \"block size\" and falling back on `io.DEFAULT_BUFFER_SIZE`.\n"
154" On many systems, the buffer will typically be 4096 or 8192 bytes long.\n"
155"\n"
156"* \"Interactive\" text files (files for which isatty() returns True)\n"
157" use line buffering. Other text files use the policy described above\n"
158" for binary files.\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000159"\n"
160"encoding is the name of the encoding used to decode or encode the\n"
161"file. This should only be used in text mode. The default encoding is\n"
162"platform dependent, but any encoding supported by Python can be\n"
163"passed. See the codecs module for the list of supported encodings.\n"
164"\n"
165"errors is an optional string that specifies how encoding errors are to\n"
166"be handled---this argument should not be used in binary mode. Pass\n"
167"'strict' to raise a ValueError exception if there is an encoding error\n"
168"(the default of None has the same effect), or pass 'ignore' to ignore\n"
169"errors. (Note that ignoring encoding errors can lead to data loss.)\n"
170"See the documentation for codecs.register for a list of the permitted\n"
171"encoding error strings.\n"
172"\n"
173"newline controls how universal newlines works (it only applies to text\n"
174"mode). It can be None, '', '\\n', '\\r', and '\\r\\n'. It works as\n"
175"follows:\n"
176"\n"
177"* On input, if newline is None, universal newlines mode is\n"
178" enabled. Lines in the input can end in '\\n', '\\r', or '\\r\\n', and\n"
179" these are translated into '\\n' before being returned to the\n"
180" caller. If it is '', universal newline mode is enabled, but line\n"
181" endings are returned to the caller untranslated. If it has any of\n"
182" the other legal values, input lines are only terminated by the given\n"
183" string, and the line ending is returned to the caller untranslated.\n"
184"\n"
185"* On output, if newline is None, any '\\n' characters written are\n"
186" translated to the system default line separator, os.linesep. If\n"
187" newline is '', no translation takes place. If newline is any of the\n"
188" other legal values, any '\\n' characters written are translated to\n"
189" the given string.\n"
190"\n"
191"If closefd is False, the underlying file descriptor will be kept open\n"
192"when the file is closed. This does not work when a file name is given\n"
193"and must be True in that case.\n"
194"\n"
Ross Lagerwall59142db2011-10-31 20:34:46 +0200195"A custom opener can be used by passing a callable as *opener*. The\n"
196"underlying file descriptor for the file object is then obtained by\n"
197"calling *opener* with (*file*, *flags*). *opener* must return an open\n"
198"file descriptor (passing os.open as *opener* results in functionality\n"
199"similar to passing None).\n"
200"\n"
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000201"open() returns a file object whose type depends on the mode, and\n"
202"through which the standard file operations such as reading and writing\n"
203"are performed. When open() is used to open a file in a text mode ('w',\n"
204"'r', 'wt', 'rt', etc.), it returns a TextIOWrapper. When used to open\n"
205"a file in a binary mode, the returned class varies: in read binary\n"
206"mode, it returns a BufferedReader; in write binary and append binary\n"
207"modes, it returns a BufferedWriter, and in read/write mode, it returns\n"
208"a BufferedRandom.\n"
209"\n"
210"It is also possible to use a string or bytearray as a file for both\n"
211"reading and writing. For strings StringIO can be used like a file\n"
212"opened in a text mode, and for bytes a BytesIO can be used like a file\n"
213"opened in a binary mode.\n"
214 );
215
216static PyObject *
217io_open(PyObject *self, PyObject *args, PyObject *kwds)
218{
219 char *kwlist[] = {"file", "mode", "buffering",
220 "encoding", "errors", "newline",
Ross Lagerwall59142db2011-10-31 20:34:46 +0200221 "closefd", "opener", NULL};
222 PyObject *file, *opener = Py_None;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000223 char *mode = "r";
224 int buffering = -1, closefd = 1;
225 char *encoding = NULL, *errors = NULL, *newline = NULL;
226 unsigned i;
227
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100228 int creating = 0, reading = 0, writing = 0, appending = 0, updating = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000229 int text = 0, binary = 0, universal = 0;
230
231 char rawmode[5], *m;
232 int line_buffering, isatty;
233
234 PyObject *raw, *modeobj = NULL, *buffer = NULL, *wrapper = NULL;
235
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200236 _Py_IDENTIFIER(isatty);
237 _Py_IDENTIFIER(fileno);
Martin v. Löwis767046a2011-10-14 15:35:36 +0200238 _Py_IDENTIFIER(mode);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200239
Ross Lagerwall59142db2011-10-31 20:34:46 +0200240 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|sizzziO:open", kwlist,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000241 &file, &mode, &buffering,
242 &encoding, &errors, &newline,
Ross Lagerwall59142db2011-10-31 20:34:46 +0200243 &closefd, &opener)) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000244 return NULL;
245 }
246
247 if (!PyUnicode_Check(file) &&
248 !PyBytes_Check(file) &&
249 !PyNumber_Check(file)) {
250 PyErr_Format(PyExc_TypeError, "invalid file: %R", file);
251 return NULL;
252 }
253
254 /* Decode mode */
255 for (i = 0; i < strlen(mode); i++) {
256 char c = mode[i];
257
258 switch (c) {
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100259 case 'x':
260 creating = 1;
261 break;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000262 case 'r':
263 reading = 1;
264 break;
265 case 'w':
266 writing = 1;
267 break;
268 case 'a':
269 appending = 1;
270 break;
271 case '+':
272 updating = 1;
273 break;
274 case 't':
275 text = 1;
276 break;
277 case 'b':
278 binary = 1;
279 break;
280 case 'U':
281 universal = 1;
282 reading = 1;
283 break;
284 default:
285 goto invalid_mode;
286 }
287
288 /* c must not be duplicated */
289 if (strchr(mode+i+1, c)) {
290 invalid_mode:
291 PyErr_Format(PyExc_ValueError, "invalid mode: '%s'", mode);
292 return NULL;
293 }
294
295 }
296
297 m = rawmode;
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100298 if (creating) *(m++) = 'x';
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000299 if (reading) *(m++) = 'r';
300 if (writing) *(m++) = 'w';
301 if (appending) *(m++) = 'a';
302 if (updating) *(m++) = '+';
303 *m = '\0';
304
305 /* Parameters validation */
306 if (universal) {
307 if (writing || appending) {
308 PyErr_SetString(PyExc_ValueError,
309 "can't use U and writing mode at once");
310 return NULL;
311 }
312 reading = 1;
313 }
314
315 if (text && binary) {
316 PyErr_SetString(PyExc_ValueError,
317 "can't have text and binary mode at once");
318 return NULL;
319 }
320
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100321 if (creating + reading + writing + appending > 1) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000322 PyErr_SetString(PyExc_ValueError,
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100323 "must have exactly one of create/read/write/append mode");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000324 return NULL;
325 }
326
327 if (binary && encoding != NULL) {
328 PyErr_SetString(PyExc_ValueError,
329 "binary mode doesn't take an encoding argument");
330 return NULL;
331 }
332
333 if (binary && errors != NULL) {
334 PyErr_SetString(PyExc_ValueError,
335 "binary mode doesn't take an errors argument");
336 return NULL;
337 }
338
339 if (binary && newline != NULL) {
340 PyErr_SetString(PyExc_ValueError,
341 "binary mode doesn't take a newline argument");
342 return NULL;
343 }
344
345 /* Create the Raw file stream */
346 raw = PyObject_CallFunction((PyObject *)&PyFileIO_Type,
Ross Lagerwall59142db2011-10-31 20:34:46 +0200347 "OsiO", file, rawmode, closefd, opener);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000348 if (raw == NULL)
349 return NULL;
350
351 modeobj = PyUnicode_FromString(mode);
352 if (modeobj == NULL)
353 goto error;
354
355 /* buffering */
356 {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200357 PyObject *res = _PyObject_CallMethodId(raw, &PyId_isatty, NULL);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000358 if (res == NULL)
359 goto error;
360 isatty = PyLong_AsLong(res);
361 Py_DECREF(res);
362 if (isatty == -1 && PyErr_Occurred())
363 goto error;
364 }
365
366 if (buffering == 1 || (buffering < 0 && isatty)) {
367 buffering = -1;
368 line_buffering = 1;
369 }
370 else
371 line_buffering = 0;
372
373 if (buffering < 0) {
374 buffering = DEFAULT_BUFFER_SIZE;
375#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
376 {
377 struct stat st;
378 long fileno;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200379 PyObject *res = _PyObject_CallMethodId(raw, &PyId_fileno, NULL);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000380 if (res == NULL)
381 goto error;
382
383 fileno = PyLong_AsLong(res);
384 Py_DECREF(res);
385 if (fileno == -1 && PyErr_Occurred())
386 goto error;
387
Antoine Pitrouea5d17d2010-10-27 19:45:43 +0000388 if (fstat(fileno, &st) >= 0 && st.st_blksize > 1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000389 buffering = st.st_blksize;
390 }
391#endif
392 }
393 if (buffering < 0) {
394 PyErr_SetString(PyExc_ValueError,
395 "invalid buffering size");
396 goto error;
397 }
398
399 /* if not buffering, returns the raw file object */
400 if (buffering == 0) {
401 if (!binary) {
402 PyErr_SetString(PyExc_ValueError,
403 "can't have unbuffered text I/O");
404 goto error;
405 }
406
407 Py_DECREF(modeobj);
408 return raw;
409 }
410
411 /* wraps into a buffered file */
412 {
413 PyObject *Buffered_class;
414
415 if (updating)
416 Buffered_class = (PyObject *)&PyBufferedRandom_Type;
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100417 else if (creating || writing || appending)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000418 Buffered_class = (PyObject *)&PyBufferedWriter_Type;
419 else if (reading)
420 Buffered_class = (PyObject *)&PyBufferedReader_Type;
421 else {
422 PyErr_Format(PyExc_ValueError,
423 "unknown mode: '%s'", mode);
424 goto error;
425 }
426
427 buffer = PyObject_CallFunction(Buffered_class, "Oi", raw, buffering);
428 }
429 Py_CLEAR(raw);
430 if (buffer == NULL)
431 goto error;
432
433
434 /* if binary, returns the buffered file */
435 if (binary) {
436 Py_DECREF(modeobj);
437 return buffer;
438 }
439
440 /* wraps into a TextIOWrapper */
441 wrapper = PyObject_CallFunction((PyObject *)&PyTextIOWrapper_Type,
442 "Osssi",
443 buffer,
444 encoding, errors, newline,
445 line_buffering);
446 Py_CLEAR(buffer);
447 if (wrapper == NULL)
448 goto error;
449
Martin v. Löwis767046a2011-10-14 15:35:36 +0200450 if (_PyObject_SetAttrId(wrapper, &PyId_mode, modeobj) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000451 goto error;
452 Py_DECREF(modeobj);
453 return wrapper;
454
455 error:
456 Py_XDECREF(raw);
457 Py_XDECREF(modeobj);
458 Py_XDECREF(buffer);
459 Py_XDECREF(wrapper);
460 return NULL;
461}
462
463/*
464 * Private helpers for the io module.
465 */
466
467Py_off_t
468PyNumber_AsOff_t(PyObject *item, PyObject *err)
469{
470 Py_off_t result;
471 PyObject *runerr;
472 PyObject *value = PyNumber_Index(item);
473 if (value == NULL)
474 return -1;
475
476 /* We're done if PyLong_AsSsize_t() returns without error. */
477 result = PyLong_AsOff_t(value);
478 if (result != -1 || !(runerr = PyErr_Occurred()))
479 goto finish;
480
481 /* Error handling code -- only manage OverflowError differently */
482 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
483 goto finish;
484
485 PyErr_Clear();
486 /* If no error-handling desired then the default clipping
487 is sufficient.
488 */
489 if (!err) {
490 assert(PyLong_Check(value));
491 /* Whether or not it is less than or equal to
492 zero is determined by the sign of ob_size
493 */
494 if (_PyLong_Sign(value) < 0)
495 result = PY_OFF_T_MIN;
496 else
497 result = PY_OFF_T_MAX;
498 }
499 else {
500 /* Otherwise replace the error with caller's error object. */
501 PyErr_Format(err,
502 "cannot fit '%.200s' into an offset-sized integer",
503 item->ob_type->tp_name);
504 }
505
506 finish:
507 Py_DECREF(value);
508 return result;
509}
510
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000511
512/* Basically the "n" format code with the ability to turn None into -1. */
513int
514_PyIO_ConvertSsize_t(PyObject *obj, void *result) {
515 Py_ssize_t limit;
516 if (obj == Py_None) {
517 limit = -1;
518 }
519 else if (PyNumber_Check(obj)) {
520 limit = PyNumber_AsSsize_t(obj, PyExc_OverflowError);
521 if (limit == -1 && PyErr_Occurred())
522 return 0;
523 }
524 else {
525 PyErr_Format(PyExc_TypeError,
526 "integer argument expected, got '%.200s'",
527 Py_TYPE(obj)->tp_name);
528 return 0;
529 }
530 *((Py_ssize_t *)result) = limit;
531 return 1;
532}
533
534
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000535static int
536iomodule_traverse(PyObject *mod, visitproc visit, void *arg) {
537 _PyIO_State *state = IO_MOD_STATE(mod);
538 if (!state->initialized)
539 return 0;
540 Py_VISIT(state->os_module);
541 if (state->locale_module != NULL) {
542 Py_VISIT(state->locale_module);
543 }
544 Py_VISIT(state->unsupported_operation);
545 return 0;
546}
547
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000548
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000549static int
550iomodule_clear(PyObject *mod) {
551 _PyIO_State *state = IO_MOD_STATE(mod);
552 if (!state->initialized)
553 return 0;
554 Py_CLEAR(state->os_module);
555 if (state->locale_module != NULL)
556 Py_CLEAR(state->locale_module);
557 Py_CLEAR(state->unsupported_operation);
558 return 0;
559}
560
561static void
562iomodule_free(PyObject *mod) {
563 iomodule_clear(mod);
564}
565
Benjamin Petersonbf5ff762009-12-13 19:25:34 +0000566
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000567/*
568 * Module definition
569 */
570
571static PyMethodDef module_methods[] = {
572 {"open", (PyCFunction)io_open, METH_VARARGS|METH_KEYWORDS, open_doc},
573 {NULL, NULL}
574};
575
576struct PyModuleDef _PyIO_Module = {
577 PyModuleDef_HEAD_INIT,
578 "io",
579 module_doc,
580 sizeof(_PyIO_State),
581 module_methods,
582 NULL,
583 iomodule_traverse,
584 iomodule_clear,
585 (freefunc)iomodule_free,
586};
587
588PyMODINIT_FUNC
589PyInit__io(void)
590{
591 PyObject *m = PyModule_Create(&_PyIO_Module);
592 _PyIO_State *state = NULL;
593 if (m == NULL)
594 return NULL;
595 state = IO_MOD_STATE(m);
596 state->initialized = 0;
597
598 /* put os in the module state */
599 state->os_module = PyImport_ImportModule("os");
600 if (state->os_module == NULL)
601 goto fail;
602
603#define ADD_TYPE(type, name) \
604 if (PyType_Ready(type) < 0) \
605 goto fail; \
606 Py_INCREF(type); \
607 if (PyModule_AddObject(m, name, (PyObject *)type) < 0) { \
608 Py_DECREF(type); \
609 goto fail; \
610 }
611
612 /* DEFAULT_BUFFER_SIZE */
613 if (PyModule_AddIntMacro(m, DEFAULT_BUFFER_SIZE) < 0)
614 goto fail;
615
616 /* UnsupportedOperation inherits from ValueError and IOError */
617 state->unsupported_operation = PyObject_CallFunction(
618 (PyObject *)&PyType_Type, "s(OO){}",
619 "UnsupportedOperation", PyExc_ValueError, PyExc_IOError);
620 if (state->unsupported_operation == NULL)
621 goto fail;
622 Py_INCREF(state->unsupported_operation);
623 if (PyModule_AddObject(m, "UnsupportedOperation",
624 state->unsupported_operation) < 0)
625 goto fail;
626
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200627 /* BlockingIOError, for compatibility */
628 Py_INCREF(PyExc_BlockingIOError);
629 if (PyModule_AddObject(m, "BlockingIOError",
630 (PyObject *) PyExc_BlockingIOError) < 0)
631 goto fail;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000632
633 /* Concrete base types of the IO ABCs.
634 (the ABCs themselves are declared through inheritance in io.py)
635 */
636 ADD_TYPE(&PyIOBase_Type, "_IOBase");
637 ADD_TYPE(&PyRawIOBase_Type, "_RawIOBase");
638 ADD_TYPE(&PyBufferedIOBase_Type, "_BufferedIOBase");
639 ADD_TYPE(&PyTextIOBase_Type, "_TextIOBase");
640
641 /* Implementation of concrete IO objects. */
642 /* FileIO */
643 PyFileIO_Type.tp_base = &PyRawIOBase_Type;
644 ADD_TYPE(&PyFileIO_Type, "FileIO");
645
646 /* BytesIO */
647 PyBytesIO_Type.tp_base = &PyBufferedIOBase_Type;
648 ADD_TYPE(&PyBytesIO_Type, "BytesIO");
Antoine Pitrou972ee132010-09-06 18:48:21 +0000649 if (PyType_Ready(&_PyBytesIOBuffer_Type) < 0)
650 goto fail;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000651
652 /* StringIO */
653 PyStringIO_Type.tp_base = &PyTextIOBase_Type;
654 ADD_TYPE(&PyStringIO_Type, "StringIO");
655
656 /* BufferedReader */
657 PyBufferedReader_Type.tp_base = &PyBufferedIOBase_Type;
658 ADD_TYPE(&PyBufferedReader_Type, "BufferedReader");
659
660 /* BufferedWriter */
661 PyBufferedWriter_Type.tp_base = &PyBufferedIOBase_Type;
662 ADD_TYPE(&PyBufferedWriter_Type, "BufferedWriter");
663
664 /* BufferedRWPair */
665 PyBufferedRWPair_Type.tp_base = &PyBufferedIOBase_Type;
666 ADD_TYPE(&PyBufferedRWPair_Type, "BufferedRWPair");
667
668 /* BufferedRandom */
669 PyBufferedRandom_Type.tp_base = &PyBufferedIOBase_Type;
670 ADD_TYPE(&PyBufferedRandom_Type, "BufferedRandom");
671
672 /* TextIOWrapper */
673 PyTextIOWrapper_Type.tp_base = &PyTextIOBase_Type;
674 ADD_TYPE(&PyTextIOWrapper_Type, "TextIOWrapper");
675
676 /* IncrementalNewlineDecoder */
677 ADD_TYPE(&PyIncrementalNewlineDecoder_Type, "IncrementalNewlineDecoder");
678
679 /* Interned strings */
680 if (!(_PyIO_str_close = PyUnicode_InternFromString("close")))
681 goto fail;
682 if (!(_PyIO_str_closed = PyUnicode_InternFromString("closed")))
683 goto fail;
684 if (!(_PyIO_str_decode = PyUnicode_InternFromString("decode")))
685 goto fail;
686 if (!(_PyIO_str_encode = PyUnicode_InternFromString("encode")))
687 goto fail;
688 if (!(_PyIO_str_fileno = PyUnicode_InternFromString("fileno")))
689 goto fail;
690 if (!(_PyIO_str_flush = PyUnicode_InternFromString("flush")))
691 goto fail;
692 if (!(_PyIO_str_getstate = PyUnicode_InternFromString("getstate")))
693 goto fail;
694 if (!(_PyIO_str_isatty = PyUnicode_InternFromString("isatty")))
695 goto fail;
696 if (!(_PyIO_str_newlines = PyUnicode_InternFromString("newlines")))
697 goto fail;
698 if (!(_PyIO_str_nl = PyUnicode_InternFromString("\n")))
699 goto fail;
700 if (!(_PyIO_str_read = PyUnicode_InternFromString("read")))
701 goto fail;
702 if (!(_PyIO_str_read1 = PyUnicode_InternFromString("read1")))
703 goto fail;
704 if (!(_PyIO_str_readable = PyUnicode_InternFromString("readable")))
705 goto fail;
Victor Stinnerb57f1082011-05-26 00:19:38 +0200706 if (!(_PyIO_str_readall = PyUnicode_InternFromString("readall")))
707 goto fail;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000708 if (!(_PyIO_str_readinto = PyUnicode_InternFromString("readinto")))
709 goto fail;
710 if (!(_PyIO_str_readline = PyUnicode_InternFromString("readline")))
711 goto fail;
712 if (!(_PyIO_str_reset = PyUnicode_InternFromString("reset")))
713 goto fail;
714 if (!(_PyIO_str_seek = PyUnicode_InternFromString("seek")))
715 goto fail;
716 if (!(_PyIO_str_seekable = PyUnicode_InternFromString("seekable")))
717 goto fail;
Antoine Pitroue4501852009-05-14 18:55:55 +0000718 if (!(_PyIO_str_setstate = PyUnicode_InternFromString("setstate")))
719 goto fail;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000720 if (!(_PyIO_str_tell = PyUnicode_InternFromString("tell")))
721 goto fail;
722 if (!(_PyIO_str_truncate = PyUnicode_InternFromString("truncate")))
723 goto fail;
724 if (!(_PyIO_str_write = PyUnicode_InternFromString("write")))
725 goto fail;
726 if (!(_PyIO_str_writable = PyUnicode_InternFromString("writable")))
727 goto fail;
728
729 if (!(_PyIO_empty_str = PyUnicode_FromStringAndSize(NULL, 0)))
730 goto fail;
731 if (!(_PyIO_empty_bytes = PyBytes_FromStringAndSize(NULL, 0)))
732 goto fail;
Antoine Pitroue4501852009-05-14 18:55:55 +0000733 if (!(_PyIO_zero = PyLong_FromLong(0L)))
734 goto fail;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000735
736 state->initialized = 1;
737
738 return m;
739
740 fail:
741 Py_XDECREF(state->os_module);
742 Py_XDECREF(state->unsupported_operation);
743 Py_DECREF(m);
744 return NULL;
745}