如何获取 Python 函数的源代码？

Question

假设我有一个如下定义的 Python 函数：

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

我可以使用foo.func_name 获取函数的名称。如上所示，如何以编程方式获取其源代码？

Answer 1

inspect module 具有从 python 对象中检索源代码的方法。似乎它仅在源位于文件中时才有效。如果你有，我猜你不需要从对象中获取源代码。

---

以下测试inspect.getsource(foo) 使用 Python 3.6：

import inspect

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

source_foo = inspect.getsource(foo)  # foo is normal function
print(source_foo)

source_max = inspect.getsource(max)  # max is a built-in function
print(source_max)

这首先打印：

def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

然后在inspect.getsource(max) 上失败并出现以下错误：

TypeError: <built-in function max> is not a module, class, method, function, traceback, frame, or code object

Answer 2

我相信变量名称不存储在 pyc/pyd/pyo 文件中，因此如果您没有源文件，则无法检索确切的代码行。

Answer 3

如果函数来自文件系统上可用的源文件，那么inspect.getsource(foo) 可能会有所帮助：

如果foo 定义为：

def foo(arg1,arg2):         
    #do something with args 
    a = arg1 + arg2         
    return a  

然后：

import inspect
lines = inspect.getsource(foo)
print(lines)

返回：

def foo(arg1,arg2):         
    #do something with args 
    a = arg1 + arg2         
    return a                

但我相信，如果函数是从字符串、流编译或从编译文件导入的，那么你无法检索它的源代码。

Answer 4

如果您自己严格定义函数并且它是一个相对较短的定义，那么没有依赖关系的解决方案是在字符串中定义函数并将表达式的 eval() 分配给您的函数。

例如

funcstring = 'lambda x: x> 5'
func = eval(funcstring)

然后可以选择将原始代码附加到函数中：

func.source = funcstring

Answer 5

如果源代码不可用，dis 是你的朋友：

>>> import dis
>>> def foo(arg1,arg2):
...     #do something with args
...     a = arg1 + arg2
...     return a
...
>>> dis.dis(foo)
  3           0 LOAD_FAST                0 (arg1)
              3 LOAD_FAST                1 (arg2)
              6 BINARY_ADD
              7 STORE_FAST               2 (a)

  4          10 LOAD_FAST                2 (a)
             13 RETURN_VALUE

Answer 6

虽然我通常同意inspect 是一个很好的答案，但我不同意您无法获得解释器中定义的对象的源代码。如果您使用dill 中的dill.source.getsource，您可以获得函数和lambda 的来源，即使它们是交互定义的。 它还可以从 curries 中定义的绑定或未绑定的类方法和函数中获取代码......但是，如果没有封闭对象的代码，您可能无法编译该代码。

>>> from dill.source import getsource
>>> 
>>> def add(x,y):
...   return x+y
... 
>>> squared = lambda x:x**2
>>> 
>>> print getsource(add)
def add(x,y):
  return x+y

>>> print getsource(squared)
squared = lambda x:x**2

>>> 
>>> class Foo(object):
...   def bar(self, x):
...     return x*x+x
... 
>>> f = Foo()
>>> 
>>> print getsource(f.bar)
def bar(self, x):
    return x*x+x

>>> 

Answer 7

扩展 runeh 的答案：

>>> def foo(a):
...    x = 2
...    return x + a

>>> import inspect

>>> inspect.getsource(foo)
u'def foo(a):\n    x = 2\n    return x + a\n'

print inspect.getsource(foo)
def foo(a):
   x = 2
   return x + a

编辑：正如@0sh 所指出的，这个例子使用ipython，但不是普通的python。但是，从源文件导入代码时，两者都应该没问题。

Answer 8

如果你使用的是 IPython，那么你需要输入“foo??”

In [19]: foo??
Signature: foo(arg1, arg2)
Source:
def foo(arg1,arg2):
    #do something with args
    a = arg1 + arg2
    return a

File:      ~/Desktop/<ipython-input-18-3174e3126506>
Type:      function

Answer 9

总结：

import inspect
print( "".join(inspect.getsourcelines(foo)[0]))

Answer 10

您可以使用inspect 模块获取完整的源代码。您必须使用 getsource() 模块中的 inspect 方法。例如：

import inspect

def get_my_code():
    x = "abcd"
    return x

print(inspect.getsource(get_my_code))

您可以在以下链接中查看更多选项。 retrieve your python code

Answer 11

请注意，仅当 lambda 在单独的行中给出时，接受的答案才有效。如果您将它作为参数传递给函数并希望将 lambda 的代码作为对象检索，那么问题会变得有点棘手，因为inspect 会为您提供整行。

例如，考虑一个文件test.py：

import inspect

def main():
    x, f = 3, lambda a: a + 1
    print(inspect.getsource(f))

if __name__ == "__main__":
    main()

执行它会给你（注意缩进！）：

    x, f = 3, lambda a: a + 1

在我看来，要检索 lambda 的源代码，最好的办法是重新解析整个源文件（使用 f.__code__.co_filename）并通过行号及其上下文匹配 lambda AST 节点。

我们必须在我们的按合同设计库icontract 中精确地做到这一点，因为我们必须解析作为参数传递给装饰器的 lambda 函数。代码太多，贴在这里，看the implementation of this function。

Answer 12

由于这篇文章被标记为this other post 的重复，我在这里回答“lambda”的情况，虽然 OP 不是关于 lambdas。

因此，对于未在自己的行中定义的 lambda 函数：除了marko.ristin 的答案，您可能希望使用mini-lambda 或使用SymPy，如this answer 中所建议的那样。

• mini-lambda 更轻巧，支持任何类型的操作，但仅适用于单个变量
• SymPy 更重，但更配备了数学/微积分运算。特别是它可以简化你的表达。它还支持在同一个表达式中使用多个变量。

这是使用mini-lambda 的方法：

from mini_lambda import x, is_mini_lambda_expr
import inspect

def get_source_code_str(f):
    if is_mini_lambda_expr(f):
        return f.to_string()
    else:
        return inspect.getsource(f)

# test it

def foo(arg1, arg2):
    # do something with args
    a = arg1 + arg2
    return a

print(get_source_code_str(foo))
print(get_source_code_str(x ** 2))

它正确产生

def foo(arg1, arg2):
    # do something with args
    a = arg1 + arg2
    return a

x ** 2

详情请见mini-lambdadocumentation。顺便说一句，我是作者；）

Answer 13

Rafał Dowgird's answer 状态：

我相信如果函数是从字符串、流编译或从编译文件导入的，那么你无法检索它的源代码。

但是，是可以检索从字符串编译的函数的源代码，前提是编译代码还向linecache.cache dict添加了一个条目：

import linecache
import inspect

script = '''
def add_nums(a, b):
    return a + b
'''

bytecode = compile(script, 'unique_filename', 'exec')
tmp = {}
eval(bytecode, {}, tmp)
add_nums = tmp["add_nums"]

linecache.cache['unique_filename'] = (
    len(script),
    None,
    script.splitlines(True),
    'unique_filename',
)

print(inspect.getsource(add_nums))

# prints:
# """
# def add_nums(a, b):
#    return a + b
# """

这就是attrs library 自动为类创建各种方法的方式，给定类期望初始化的一组属性。见他们的source code here。正如消息来源所解释的那样，这是一个主要旨在使 PDB 等调试器能够单步执行代码的功能。