如何防止C共享库在python中的stdout上打印?

时间:2011-02-22 17:32:35

标签: python ctypes python-2.x

我使用python lib导入一个在stdout上打印的C共享库。我想要一个干净的输出,以便与管道一起使用或重定向文件。打印是在python之外的共享库中完成的。

一开始,我的方法是:

# file: test.py
import os
from ctypes import *
from tempfile import mktemp

libc = CDLL("libc.so.6")

print # That's here on purpose, otherwise hello word is always printed

tempfile = open(mktemp(),'w')
savestdout = os.dup(1)
os.close(1)
if os.dup(tempfile.fileno()) != 1:
    assert False, "couldn't redirect stdout - dup() error"

# let's pretend this is a call to my library
libc.printf("hello world\n")

os.close(1)
os.dup(savestdout)
os.close(savestdout)

第一种方法是半工作:
- 由于某种原因,它在移动stdout之前需要一个“print”语句,否则总是会打印hello word。因此,它将打印一个空行而不是库通常输出的所有模糊 - 更令人讨厌,重定向到文件时失败:

$python test.py > foo && cat foo

hello world

我的第二次python尝试受到了评论中给出的另一个类似线程的启发:

import os
import sys
from ctypes import *
libc = CDLL("libc.so.6")

devnull = open('/dev/null', 'w')
oldstdout = os.dup(sys.stdout.fileno())
os.dup2(devnull.fileno(), 1)

# We still pretend this is a call to my library
libc.printf("hello\n")

os.dup2(oldstdout, 1)

这也无法阻止打印“你好”。

由于我觉得这个级别有点低,所以我决定完全使用ctypes。我从这个C程序中获取灵感,该程序不打印任何内容:

#include <stdio.h>

int main(int argc, const char *argv[]) {
    char buf[20];
    int saved_stdout = dup(1);
    freopen("/dev/null", "w", stdout);

    printf("hello\n"); // not printed

    sprintf(buf, "/dev/fd/%d", saved_stdout);
    freopen(buf, "w", stdout);

    return 0;
}

我构建了以下示例:

from ctypes import *
libc = CDLL("libc.so.6")

saved_stdout = libc.dup(1)
stdout = libc.fdopen(1, "w")
libc.freopen("/dev/null", "w", stdout);

libc.printf("hello\n")

libc.freopen("/dev/fd/" + str(saved_stdout), "w", stdout)

这打印“hello”,即使我在printf之后的libc.fflush(stdout)。我开始认为可能无法在python中做我想做的事情。或者我获取stdout文件指针的方式可能不对。

您怎么看?

5 个答案:

答案 0 :(得分:20)

基于@Yinon Ehrlich's answer。此变体试图避免泄漏文件描述符:

import os
import sys
from contextlib import contextmanager

@contextmanager
def stdout_redirected(to=os.devnull):
    '''
    import os

    with stdout_redirected(to=filename):
        print("from Python")
        os.system("echo non-Python applications are also supported")
    '''
    fd = sys.stdout.fileno()

    ##### assert that Python and C stdio write using the same file descriptor
    ####assert libc.fileno(ctypes.c_void_p.in_dll(libc, "stdout")) == fd == 1

    def _redirect_stdout(to):
        sys.stdout.close() # + implicit flush()
        os.dup2(to.fileno(), fd) # fd writes to 'to' file
        sys.stdout = os.fdopen(fd, 'w') # Python writes to fd

    with os.fdopen(os.dup(fd), 'w') as old_stdout:
        with open(to, 'w') as file:
            _redirect_stdout(to=file)
        try:
            yield # allow code to be run with the redirected stdout
        finally:
            _redirect_stdout(to=old_stdout) # restore stdout.
                                            # buffering and flags such as
                                            # CLOEXEC may be different

答案 1 :(得分:15)

是的,你真的想用os.dup2代替os.dup,就像你的第二个想法一样。你的代码看起来有点迂回。除了/dev之外,不要使用/dev/null个条目,这是不必要的。这里也没必要用C语言写任何东西。

诀窍是使用stdout保存dup fdes,然后将其传递给fdopen以生成新的sys.stdout Python对象。同时,打开f /dev/null并使用dup2覆盖现有的stdout fdes。然后关闭旧的fdes到/dev/null。调用dup2是必要的,因为我们无法告诉open我们希望它返回哪些,dup2实际上是唯一的方法。

编辑:如果您要重定向到文件,那么stdout不是行缓冲的,因此您必须将其刷新。你可以从Python那里做到这一点,它将正确地与C互操作。当然,如果你在向stdout写任何东西之前调用这个函数,那就无所谓了。

以下是我刚测试过的可在我的系统上运行的示例。

import zook
import os
import sys

def redirect_stdout():
    print "Redirecting stdout"
    sys.stdout.flush() # <--- important when redirecting to files
    newstdout = os.dup(1)
    devnull = os.open(os.devnull, os.O_WRONLY)
    os.dup2(devnull, 1)
    os.close(devnull)
    sys.stdout = os.fdopen(newstdout, 'w')

zook.myfunc()
redirect_stdout()
zook.myfunc()
print "But python can still print to stdout..."

“zook”模块是C中非常简单的库。

#include <Python.h>
#include <stdio.h>

static PyObject *
myfunc(PyObject *self, PyObject *args)
{
    puts("myfunc called");
    Py_INCREF(Py_None);
    return Py_None;
}

static PyMethodDef zookMethods[] = {
    {"myfunc",  myfunc, METH_VARARGS, "Print a string."},
    {NULL, NULL, 0, NULL}
};

PyMODINIT_FUNC
initzook(void)
{
    (void)Py_InitModule("zook", zookMethods);
}

输出?

$ python2.5 test.py
myfunc called
Redirecting stdout
But python can still print to stdout...

并重定向到文件?

$ python2.5 test.py > test.txt
$ cat test.txt
myfunc called
Redirecting stdout
But python can still print to stdout...

答案 2 :(得分:11)

结合两个答案 - https://stackoverflow.com/a/5103455/1820106&amp; https://stackoverflow.com/a/4178672/1820106到上下文管理器,只为其作用域阻止打印到stdout(第一个答案中的代码阻止了任何外部输出,后一个答案在结束时错过了sys.stdout.flush()):

class HideOutput(object):
    '''
    A context manager that block stdout for its scope, usage:

    with HideOutput():
        os.system('ls -l')
    '''

    def __init__(self, *args, **kw):
        sys.stdout.flush()
        self._origstdout = sys.stdout
        self._oldstdout_fno = os.dup(sys.stdout.fileno())
        self._devnull = os.open(os.devnull, os.O_WRONLY)

    def __enter__(self):
        self._newstdout = os.dup(1)
        os.dup2(self._devnull, 1)
        os.close(self._devnull)
        sys.stdout = os.fdopen(self._newstdout, 'w')

    def __exit__(self, exc_type, exc_val, exc_tb):
        sys.stdout = self._origstdout
        sys.stdout.flush()
        os.dup2(self._oldstdout_fno, 1)

答案 3 :(得分:4)

这是我最终的表现。我希望这对其他人有用(这适用于我的linux工作站)。

我自豪地提出了libshutup,旨在使外部库闭嘴。

1)复制以下文件

// file: shutup.c
#include <stdio.h>
#include <unistd.h>

static char buf[20];
static int saved_stdout;

void stdout_off() {
    saved_stdout = dup(1);
    freopen("/dev/null", "w", stdout);
}

void stdout_on() {
    sprintf(buf, "/dev/fd/%d", saved_stdout);
    freopen(buf, "w", stdout);
}

2)将其编译为共享库

gcc -Wall -shared shutup.c -fPIC -o libshutup.so

3)在你的代码中使用它

from ctypes import *
shutup = CDLL("libshutup.so")

shutup.stdout_off()

# Let's pretend this printf comes from the external lib
libc = CDLL("libc.so.6")
libc.printf("hello\n")

shutup.stdout_on()

答案 4 :(得分:-2)

你不能像在Python中那样做吗?你导入sys并将sys.stdout和sys.stderr指向不是默认的sys.stdout和sys.stderr的东西?我一直在一些应用程序中这样做,我必须从库中汲取输出。