Python ctypes: Python file object <-> C FILE *

Question

I am using ctypes to wrap a C-library (which I have control over) with Python. I want to wrap a C-function with declaration:

int fread_int( FILE * stream );
         


        

Answer 1

Tried this:

#if PY_MAJOR_VERSION >= 3
    if (PyObject_HasAttrString(pyfile, "fileno")) {
        int fd = (int)PyLong_AsLong(PyObject_CallMethod(pyfile, "fileno", NULL));
        if (PyObject_HasAttrString(pyfile, "mode")) {
            char *mode = PyUnicode_AsUTF8AndSize(
                    PyObject_CallMethod(pyfile, "mode", NULL), NULL);
            fp = fdopen(fd, mode);
        }
        else {
            return PyErr_Format(PyExc_ValueError,
                    "File doesn’t have mode attribute!");
        }
    }
    else {
        return PyErr_Format(PyExc_ValueError,
                "File doesn’t have fileno method!");
    }
#else
    fp = PyFile_AsFile(pyfile);
#endif

It looks like it might be working.

Answer 2

Well;

I tried the fileno based solution, but was quite uncomfortable with opening the file twice; It was also not clear to me how to avoid the return value from fdopen() to leak.

In the end I wrote a microscopic C-extension:

static PyObject cfile(PyObject * self, PyObject * args) {
    PyObject * pyfile;
    if (PyArg_ParseTuple( 'O' , &pyfile)) {
       FILE * cfile = PyFile_AsFile( pyfile );
       return Py_BuildValue( "l" , cfile );
    else
        return Py_BuildValue( "" );
}

which uses PyFile_AsFile and subsequently returns the FILE * pointer as a pure pointer value to Python which passes this back to C function expecting FILE * input. It works at least.

Joakim

Answer 3

If you want to use stdout/stdin/stderr, you can import those variables from the standard C library.

libc = ctypes.cdll.LoadLibrary('libc.so.6')
cstdout = ctypes.c_void_p.in_dll(libc, 'stdout')

Or, if you want to avoid using void* for some reason:

class FILE(ctypes.Structure):
    pass

FILE_p = ctypes.POINTER(FILE)

libc = ctypes.cdll.LoadLibrary('libc.so.6')
cstdout = FILE_p.in_dll(libc, 'stdout')

Answer 4

Adapted from svplayer

import sys

from ctypes import POINTER, Structure, py_object, pythonapi


class File(Structure):
    pass

if sys.version_info[0] > 2:
    convert_file = pythonapi.PyObject_AsFileDescriptor
    convert_file.restype = c_int
else:
    convert_file = pythonapi.PyFile_AsFile
    convert_file.restype = POINTER(File)

convert_file.argtypes = [py_object]

fp = open('path').fp
c_file = convert_file(fp)

Answer 5

A Python file object does not necessarily have an underlying C-level FILE * -- at least, not unless you're willing to tie your code to extremely specific Python versions and platforms.

What I would recommend instead is using the Python file object's fileno to get a file descriptor, then use ctypes to call the C runtime library's fdopen to make a FILE * out of that. This is a very portable approach (and you can go the other way, too). The big issue is that buffering will be separate for the two objects opened on the same file descriptor (the Python file object, and the C FILE *), so be sure to flush said objects as often as needed (or, open both as unbuffered, if that's more convenient and compatible with your intended use).

Answer 6

I've encountered the same problem.

Take a look at this file:

http://svn.python.org/projects/ctypes/trunk/ctypeslib/ctypeslib/contrib/pythonhdr.py

You can use PyFile_AsFile from it.