用源代码注释字符串中的 Python 函数调用

Question

我正在尝试注释来自 Python 源代码的函数调用。

我阅读了一个字符串中的源代码，然后我尝试将一些正则表达式应用于注释方法调用。

这是一个简单的工作示例：

s = open(path, 'r').read()
# comment method calls
result = re.sub('(^[.\w]+\(.*\))', r'#\1', s, flags=re.MULTILINE)

如您所见，我在源代码的第一个缩进级别中注释函数（ __name__ == '__main__'之外的代码、方法和类）

但是，如何使这个正则表达式适用于多行调用？

例如，如果我将以下代码转换为字符串：

Builder.load_string('''
    type: 'example'
    callback: my_callback()
''')

我如何评论这个电话的每一行？

Answer 1

这将为您提供您需要评论的行号：

mod = "test1"
mod = importlib.import_module(mod)
p = ast.parse(inspect.getsource(mod))


for n in p.body:
    if isinstance(n, ast.Expr):
        for node in ast.walk(n):
            if isinstance(node, ast.Call):
                print(node.lineno)

对于像这样的文件：

import math

class Foo:
    def __init__(self):
        self.foo = 4
    def bar(self):
        print("hello world")

    def foo(self):
        return self.bar()

def bar():
    return 123

f = Foo()    
f.bar()    
bar()

它会输出16和18这两个调用。

只需忽略这些行并编写新源或对更新内容做任何您想做的事情：

import inspect
import importlib
import ast

def get_call_lines(mod):
    mod = importlib.import_module(mod)
    p = ast.parse(inspect.getsource(mod))
    for n in p.body:
        if isinstance(n, ast.Expr):
            for node in ast.walk(n):
                if isinstance(node, ast.Call):
                    yield(node.lineno)


from StringIO import StringIO
new = StringIO()
with open("test1.py") as f:
    st = set(get_call_lines("test1"))
    for ind, line in enumerate(f, 1):
        if ind not in st:
            new.write(line)

new.seek(0)
print(new.read())

新将包含：

import math
class Foo:
    def __init__(self):
        self.foo = 4
    def bar(self):
        print("hello world")

    def foo(self):
        return self.bar()

def bar():
    return 123

f = Foo()

您可以在运行时使用ast.NodeTransformer更改代码，但删除节点并不是一项微不足道的任务，您想要的最简单的方法是简单地忽略正文中的 Call 行