1 /* Author: Daniel Stutzbach */
3 #define PY_SSIZE_T_CLEAN
8 #include <stddef.h> /* For offsetof */
11 * Known likely problems:
13 * - Files larger then 2**32-1
14 * - Files with unicode filenames
15 * - Passing numbers greater than 2**32-1 when an integer is expected
16 * - Making it work on Windows and other oddball platforms
20 * - autoconfify header file inclusion
24 /* can simulate truncate with Win32 API functions; see file_truncate */
25 #define HAVE_FTRUNCATE
26 #define WIN32_LEAN_AND_MEAN
33 unsigned readable
: 1;
34 unsigned writable
: 1;
35 int seekable
: 2; /* -1 means unknown */
37 PyObject
*weakreflist
;
40 PyTypeObject PyFileIO_Type
;
42 #define PyFileIO_Check(op) (PyObject_TypeCheck((op), &PyFileIO_Type))
44 /* Returns 0 on success, errno (which is < 0) on failure. */
46 internal_close(PyFileIOObject
*self
)
52 Py_BEGIN_ALLOW_THREADS
61 fileio_close(PyFileIOObject
*self
)
64 if (PyErr_WarnEx(PyExc_RuntimeWarning
,
65 "Trying to close unclosable fd!", 3) < 0) {
70 errno
= internal_close(self
);
72 PyErr_SetFromErrno(PyExc_IOError
);
80 fileio_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kews
)
84 assert(type
!= NULL
&& type
->tp_alloc
!= NULL
);
86 self
= (PyFileIOObject
*) type
->tp_alloc(type
, 0);
89 self
->weakreflist
= NULL
;
92 return (PyObject
*) self
;
95 /* On Unix, open will succeed for directories.
96 In Python, there should be no file objects referring to
97 directories, so we need a check. */
100 dircheck(PyFileIOObject
* self
)
102 #if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
106 if (fstat(self
->fd
, &buf
) == 0 && S_ISDIR(buf
.st_mode
)) {
107 char *msg
= strerror(EISDIR
);
109 internal_close(self
);
111 exc
= PyObject_CallFunction(PyExc_IOError
, "(is)",
113 PyErr_SetObject(PyExc_IOError
, exc
);
123 fileio_init(PyObject
*oself
, PyObject
*args
, PyObject
*kwds
)
125 PyFileIOObject
*self
= (PyFileIOObject
*) oself
;
126 static char *kwlist
[] = {"file", "mode", "closefd", NULL
};
131 Py_UNICODE
*widename
= NULL
;
134 int rwa
= 0, plus
= 0, append
= 0;
139 assert(PyFileIO_Check(oself
));
141 /* Have to close the existing file first. */
142 if (internal_close(self
) < 0)
146 if (PyArg_ParseTupleAndKeywords(args
, kwds
, "i|si:fileio",
147 kwlist
, &fd
, &mode
, &closefd
)) {
149 PyErr_SetString(PyExc_ValueError
,
150 "Negative filedescriptor");
157 #ifdef Py_WIN_WIDE_FILENAMES
158 if (GetVersion() < 0x80000000) {
159 /* On NT, so wide API available */
161 if (PyArg_ParseTupleAndKeywords(args
, kwds
, "U|si:fileio",
162 kwlist
, &po
, &mode
, &closefd
)
164 widename
= PyUnicode_AS_UNICODE(po
);
166 /* Drop the argument parsing error as narrow
167 strings are also valid. */
171 if (widename
== NULL
)
174 if (!PyArg_ParseTupleAndKeywords(args
, kwds
, "et|si:fileio",
176 Py_FileSystemDefaultEncoding
,
177 &name
, &mode
, &closefd
))
182 self
->readable
= self
->writable
= 0;
190 PyErr_SetString(PyExc_ValueError
,
191 "Must have exactly one of read/write/append mode");
202 flags
|= O_CREAT
| O_TRUNC
;
215 self
->readable
= self
->writable
= 1;
219 PyErr_Format(PyExc_ValueError
,
220 "invalid mode: %.200s", mode
);
228 if (self
->readable
&& self
->writable
)
230 else if (self
->readable
)
246 self
->closefd
= closefd
;
251 PyErr_SetString(PyExc_ValueError
,
252 "Cannot use closefd=True with file name");
256 Py_BEGIN_ALLOW_THREADS
259 if (widename
!= NULL
)
260 self
->fd
= _wopen(widename
, flags
, 0666);
263 self
->fd
= open(name
, flags
, 0666);
265 if (self
->fd
< 0 || dircheck(self
) < 0) {
267 PyErr_SetFromErrnoWithUnicodeFilename(PyExc_IOError
, widename
);
269 PyErr_SetFromErrnoWithFilename(PyExc_IOError
, name
);
285 fileio_dealloc(PyFileIOObject
*self
)
287 if (self
->weakreflist
!= NULL
)
288 PyObject_ClearWeakRefs((PyObject
*) self
);
290 if (self
->fd
>= 0 && self
->closefd
) {
291 errno
= internal_close(self
);
293 PySys_WriteStderr("close failed: [Errno %d] %s\n",
294 errno
, strerror(errno
));
298 Py_TYPE(self
)->tp_free((PyObject
*)self
);
304 PyErr_SetString(PyExc_ValueError
, "I/O operation on closed file");
309 err_mode(char *action
)
311 PyErr_Format(PyExc_ValueError
, "File not open for %s", action
);
316 fileio_fileno(PyFileIOObject
*self
)
320 return PyInt_FromLong((long) self
->fd
);
324 fileio_readable(PyFileIOObject
*self
)
328 return PyBool_FromLong((long) self
->readable
);
332 fileio_writable(PyFileIOObject
*self
)
336 return PyBool_FromLong((long) self
->writable
);
340 fileio_seekable(PyFileIOObject
*self
)
344 if (self
->seekable
< 0) {
346 Py_BEGIN_ALLOW_THREADS
347 ret
= lseek(self
->fd
, 0, SEEK_CUR
);
354 return PyBool_FromLong((long) self
->seekable
);
358 fileio_readinto(PyFileIOObject
*self
, PyObject
*args
)
366 return err_mode("reading");
368 if (!PyArg_ParseTuple(args
, "w#", &ptr
, &n
))
371 Py_BEGIN_ALLOW_THREADS
373 n
= read(self
->fd
, ptr
, n
);
378 PyErr_SetFromErrno(PyExc_IOError
);
382 return PyLong_FromSsize_t(n
);
385 #define DEFAULT_BUFFER_SIZE (8*1024)
388 fileio_readall(PyFileIOObject
*self
)
391 Py_ssize_t total
= 0;
394 result
= PyString_FromStringAndSize(NULL
, DEFAULT_BUFFER_SIZE
);
399 Py_ssize_t newsize
= total
+ DEFAULT_BUFFER_SIZE
;
400 if (PyString_GET_SIZE(result
) < newsize
) {
401 if (_PyString_Resize(&result
, newsize
) < 0) {
410 Py_BEGIN_ALLOW_THREADS
413 PyString_AS_STRING(result
) + total
,
421 if (errno
== EAGAIN
) {
426 PyErr_SetFromErrno(PyExc_IOError
);
432 if (PyString_GET_SIZE(result
) > total
) {
433 if (_PyString_Resize(&result
, total
) < 0) {
434 /* This should never happen, but just in case */
443 fileio_read(PyFileIOObject
*self
, PyObject
*args
)
447 Py_ssize_t size
= -1;
453 return err_mode("reading");
455 if (!PyArg_ParseTuple(args
, "|n", &size
))
459 return fileio_readall(self
);
462 bytes
= PyString_FromStringAndSize(NULL
, size
);
465 ptr
= PyString_AS_STRING(bytes
);
467 Py_BEGIN_ALLOW_THREADS
469 n
= read(self
->fd
, ptr
, size
);
475 PyErr_SetFromErrno(PyExc_IOError
);
480 if (_PyString_Resize(&bytes
, n
) < 0) {
486 return (PyObject
*) bytes
;
490 fileio_write(PyFileIOObject
*self
, PyObject
*args
)
498 return err_mode("writing");
500 if (!PyArg_ParseTuple(args
, "s#", &ptr
, &n
))
503 Py_BEGIN_ALLOW_THREADS
505 n
= write(self
->fd
, ptr
, n
);
511 PyErr_SetFromErrno(PyExc_IOError
);
515 return PyLong_FromSsize_t(n
);
518 /* XXX Windows support below is likely incomplete */
520 #if defined(MS_WIN64) || defined(MS_WINDOWS)
521 typedef PY_LONG_LONG Py_off_t
;
523 typedef off_t Py_off_t
;
526 /* Cribbed from posix_lseek() */
528 portable_lseek(int fd
, PyObject
*posobj
, int whence
)
533 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
536 case 0: whence
= SEEK_SET
; break;
539 case 1: whence
= SEEK_CUR
; break;
542 case 2: whence
= SEEK_END
; break;
545 #endif /* SEEK_SET */
550 if(PyFloat_Check(posobj
)) {
551 PyErr_SetString(PyExc_TypeError
, "an integer is required");
554 #if defined(HAVE_LARGEFILE_SUPPORT)
555 pos
= PyLong_AsLongLong(posobj
);
557 pos
= PyLong_AsLong(posobj
);
559 if (PyErr_Occurred())
563 Py_BEGIN_ALLOW_THREADS
564 #if defined(MS_WIN64) || defined(MS_WINDOWS)
565 res
= _lseeki64(fd
, pos
, whence
);
567 res
= lseek(fd
, pos
, whence
);
571 return PyErr_SetFromErrno(PyExc_IOError
);
573 #if defined(HAVE_LARGEFILE_SUPPORT)
574 return PyLong_FromLongLong(res
);
576 return PyLong_FromLong(res
);
581 fileio_seek(PyFileIOObject
*self
, PyObject
*args
)
589 if (!PyArg_ParseTuple(args
, "O|i", &posobj
, &whence
))
592 return portable_lseek(self
->fd
, posobj
, whence
);
596 fileio_tell(PyFileIOObject
*self
, PyObject
*args
)
601 return portable_lseek(self
->fd
, NULL
, 1);
604 #ifdef HAVE_FTRUNCATE
606 fileio_truncate(PyFileIOObject
*self
, PyObject
*args
)
608 PyObject
*posobj
= NULL
;
617 return err_mode("writing");
619 if (!PyArg_ParseTuple(args
, "|O", &posobj
))
622 if (posobj
== Py_None
|| posobj
== NULL
) {
623 /* Get the current position. */
624 posobj
= portable_lseek(fd
, NULL
, 1);
629 /* Move to the position to be truncated. */
630 posobj
= portable_lseek(fd
, posobj
, 0);
633 #if defined(HAVE_LARGEFILE_SUPPORT)
634 pos
= PyLong_AsLongLong(posobj
);
636 pos
= PyLong_AsLong(posobj
);
638 if (PyErr_Occurred())
642 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
643 so don't even try using it. */
647 /* Truncate. Note that this may grow the file! */
648 Py_BEGIN_ALLOW_THREADS
650 hFile
= (HANDLE
)_get_osfhandle(fd
);
651 ret
= hFile
== (HANDLE
)-1;
653 ret
= SetEndOfFile(hFile
) == 0;
660 Py_BEGIN_ALLOW_THREADS
662 ret
= ftruncate(fd
, pos
);
664 #endif /* !MS_WINDOWS */
667 PyErr_SetFromErrno(PyExc_IOError
);
676 mode_string(PyFileIOObject
*self
)
678 if (self
->readable
) {
689 fileio_repr(PyFileIOObject
*self
)
692 return PyString_FromFormat("_fileio._FileIO(-1)");
694 return PyString_FromFormat("_fileio._FileIO(%d, '%s')",
695 self
->fd
, mode_string(self
));
699 fileio_isatty(PyFileIOObject
*self
)
705 Py_BEGIN_ALLOW_THREADS
706 res
= isatty(self
->fd
);
708 return PyBool_FromLong(res
);
712 PyDoc_STRVAR(fileio_doc
,
713 "file(name: str[, mode: str]) -> file IO object\n"
715 "Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
716 "writing or appending. The file will be created if it doesn't exist\n"
717 "when opened for writing or appending; it will be truncated when\n"
718 "opened for writing. Add a '+' to the mode to allow simultaneous\n"
719 "reading and writing.");
721 PyDoc_STRVAR(read_doc
,
722 "read(size: int) -> bytes. read at most size bytes, returned as bytes.\n"
724 "Only makes one system call, so less data may be returned than requested\n"
725 "In non-blocking mode, returns None if no data is available.\n"
726 "On end-of-file, returns ''.");
728 PyDoc_STRVAR(readall_doc
,
729 "readall() -> bytes. read all data from the file, returned as bytes.\n"
731 "In non-blocking mode, returns as much as is immediately available,\n"
732 "or None if no data is available. On end-of-file, returns ''.");
734 PyDoc_STRVAR(write_doc
,
735 "write(b: bytes) -> int. Write bytes b to file, return number written.\n"
737 "Only makes one system call, so not all of the data may be written.\n"
738 "The number of bytes actually written is returned.");
740 PyDoc_STRVAR(fileno_doc
,
741 "fileno() -> int. \"file descriptor\".\n"
743 "This is needed for lower-level file interfaces, such the fcntl module.");
745 PyDoc_STRVAR(seek_doc
,
746 "seek(offset: int[, whence: int]) -> None. Move to new file position.\n"
748 "Argument offset is a byte count. Optional argument whence defaults to\n"
749 "0 (offset from start of file, offset should be >= 0); other values are 1\n"
750 "(move relative to current position, positive or negative), and 2 (move\n"
751 "relative to end of file, usually negative, although many platforms allow\n"
752 "seeking beyond the end of a file)."
754 "Note that not all file objects are seekable.");
756 #ifdef HAVE_FTRUNCATE
757 PyDoc_STRVAR(truncate_doc
,
758 "truncate([size: int]) -> None. Truncate the file to at most size bytes.\n"
760 "Size defaults to the current file position, as returned by tell()."
761 "The current file position is changed to the value of size.");
764 PyDoc_STRVAR(tell_doc
,
765 "tell() -> int. Current file position");
767 PyDoc_STRVAR(readinto_doc
,
768 "readinto() -> Undocumented. Don't use this; it may go away.");
770 PyDoc_STRVAR(close_doc
,
771 "close() -> None. Close the file.\n"
773 "A closed file cannot be used for further I/O operations. close() may be\n"
774 "called more than once without error. Changes the fileno to -1.");
776 PyDoc_STRVAR(isatty_doc
,
777 "isatty() -> bool. True if the file is connected to a tty device.");
779 PyDoc_STRVAR(seekable_doc
,
780 "seekable() -> bool. True if file supports random-access.");
782 PyDoc_STRVAR(readable_doc
,
783 "readable() -> bool. True if file was opened in a read mode.");
785 PyDoc_STRVAR(writable_doc
,
786 "writable() -> bool. True if file was opened in a write mode.");
788 static PyMethodDef fileio_methods
[] = {
789 {"read", (PyCFunction
)fileio_read
, METH_VARARGS
, read_doc
},
790 {"readall", (PyCFunction
)fileio_readall
, METH_NOARGS
, readall_doc
},
791 {"readinto", (PyCFunction
)fileio_readinto
, METH_VARARGS
, readinto_doc
},
792 {"write", (PyCFunction
)fileio_write
, METH_VARARGS
, write_doc
},
793 {"seek", (PyCFunction
)fileio_seek
, METH_VARARGS
, seek_doc
},
794 {"tell", (PyCFunction
)fileio_tell
, METH_VARARGS
, tell_doc
},
795 #ifdef HAVE_FTRUNCATE
796 {"truncate", (PyCFunction
)fileio_truncate
, METH_VARARGS
, truncate_doc
},
798 {"close", (PyCFunction
)fileio_close
, METH_NOARGS
, close_doc
},
799 {"seekable", (PyCFunction
)fileio_seekable
, METH_NOARGS
, seekable_doc
},
800 {"readable", (PyCFunction
)fileio_readable
, METH_NOARGS
, readable_doc
},
801 {"writable", (PyCFunction
)fileio_writable
, METH_NOARGS
, writable_doc
},
802 {"fileno", (PyCFunction
)fileio_fileno
, METH_NOARGS
, fileno_doc
},
803 {"isatty", (PyCFunction
)fileio_isatty
, METH_NOARGS
, isatty_doc
},
804 {NULL
, NULL
} /* sentinel */
807 /* 'closed' and 'mode' are attributes for backwards compatibility reasons. */
810 get_closed(PyFileIOObject
*self
, void *closure
)
812 return PyBool_FromLong((long)(self
->fd
< 0));
816 get_mode(PyFileIOObject
*self
, void *closure
)
818 return PyString_FromString(mode_string(self
));
821 static PyGetSetDef fileio_getsetlist
[] = {
822 {"closed", (getter
)get_closed
, NULL
, "True if the file is closed"},
823 {"mode", (getter
)get_mode
, NULL
, "String giving the file mode"},
827 PyTypeObject PyFileIO_Type
= {
828 PyVarObject_HEAD_INIT(&PyType_Type
, 0)
830 sizeof(PyFileIOObject
),
832 (destructor
)fileio_dealloc
, /* tp_dealloc */
837 (reprfunc
)fileio_repr
, /* tp_repr */
838 0, /* tp_as_number */
839 0, /* tp_as_sequence */
840 0, /* tp_as_mapping */
844 PyObject_GenericGetAttr
, /* tp_getattro */
846 0, /* tp_as_buffer */
847 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
, /* tp_flags */
848 fileio_doc
, /* tp_doc */
851 0, /* tp_richcompare */
852 offsetof(PyFileIOObject
, weakreflist
), /* tp_weaklistoffset */
855 fileio_methods
, /* tp_methods */
857 fileio_getsetlist
, /* tp_getset */
860 0, /* tp_descr_get */
861 0, /* tp_descr_set */
862 0, /* tp_dictoffset */
863 fileio_init
, /* tp_init */
864 PyType_GenericAlloc
, /* tp_alloc */
865 fileio_new
, /* tp_new */
866 PyObject_Del
, /* tp_free */
869 static PyMethodDef module_methods
[] = {
876 PyObject
*m
; /* a module object */
878 m
= Py_InitModule3("_fileio", module_methods
,
879 "Fast implementation of io.FileIO.");
882 if (PyType_Ready(&PyFileIO_Type
) < 0)
884 Py_INCREF(&PyFileIO_Type
);
885 PyModule_AddObject(m
, "_FileIO", (PyObject
*) &PyFileIO_Type
);