禁用所有打印,但在调用函数中完成的打印除外

时间:2018-10-03 05:25:53

标签: python printing decorator

我有一个函数,可以在同一模块或其他模块中调用某些函数:

from __future__ import print_function

def func():
    print("Inside func")

def my_func():
    print("Starting inside my_func ")
    func()
    print("In my_func")
    func()

执行my_func会输出以下内容:

Starting inside my_func
Inside func
In my_func
Inside func

但是我只想看看

Starting inside my_func
In my_func

所以,我想禁用除已打印的所有打印以外的所有打印 在功能my_func()中。这可能包括对函数的递归调用。因此,在堆栈级别执行某些操作将无效。

我可以考虑这样做

def func():
    print("Inside func")

def my_print(*args):
    print(*args)

def my_func():
    global my_print, print
    my_print("Starting inside my_func ")
    print = functools.partial(print, file=open(os.devnull, 'w'))
    func()
    print = functools.partial(print, file=sys.stdout)
    my_print("In my_func")
    print = functools.partial(print, file=open(os.devnull, 'w'))
    func()
    print = functools.partial(print, file=sys.stdout)

但是,这涉及到修改功能代码,并且似乎有点不客气。理想情况下,我希望使用装饰器来执行此操作,而无需修改功能代码。

最自然的方法是找到未在my_func中调用的打印并将它们输出到包装器中的os.devnull。但是我找不到如何做到这一点。预先感谢。

2 个答案:

答案 0 :(得分:1)

您可以将对print函数的引用保存在变量orig_print中,并使用不执行任何操作的函数覆盖print,然后在要允许的函数上使用修饰符打印以使用print子类将对orig_print的所有调用重命名为ast.NodeTransformer

from __future__ import print_function
import inspect
import ast
from textwrap import dedent

orig_print = print
print = lambda *args, **kwargs: None

class EnablePrint(ast.NodeTransformer):
    # remove the enable_print decorator from the decorator list so the transformed
    # function won't be re-decorated when executed
    def visit_FunctionDef(self, node):
        node.decorator_list = [
            decorator for decorator in node.decorator_list
            if not isinstance(decorator, ast.Name) or decorator.id != 'enable_print'
        ]
        self.generic_visit(node)
        return node

    def visit_Call(self, node):
        if node.func.id == 'print':
            node.func.id = 'orig_print'
        return node

def enable_print(func):
    node = ast.parse(dedent(inspect.getsource(func)))
    EnablePrint().visit(node)
    scope = {}
    exec(compile(node, inspect.getfile(func), 'exec'), func.__globals__, scope)
    return scope[func.__name__]

这样:

def func():
    print("Inside func")

@enable_print
def my_func():
    print("Starting inside my_func ")
    func()
    print("In my_func")
    func()

my_func()

将输出:

Starting inside my_func 
In my_func

答案 1 :(得分:0)

@blhsing提供了一种不错的方法。但是我最终在函数中使用pprint.pprint解决了我的问题,并禁用了print的输出。之所以有效,是因为pprint使用了更底层的stream.write("...")而不是在print上进行引导。代码:

def disable_prints(f):
    @functools.wraps(f)
    def decorated(*args, **kwargs):
        global print
        # Disable all calls made to print(...) by relacing stdout with devnull
        print = functools.partial(print, file=open(os.devnull, 'w'))
        f_returns = f(*args, **kwargs)
        # Restore back
        print = functools.partial(print, file=sys.stdout)
        return f_returns
    return decorated

这样:

def func():
    print("Inside func")

@disable_prints
def my_func():
    pprint("Starting inside my_func")
    func()
    pprint("In my_func")
    func()

my_func()

将输出:

Starting inside my_func 
In my_func