如何从Python对象中获取源代码？

使用inspect模块，您可以获取Python函数、方法、类或模块的源代码。以下示例演示了如何检索函数的源代码：

示例

import inspect
def my_function(x, y):
   return x + y
source_code = inspect.getsource(my_function)
print(source_code)

输出

def my_function(x, y):
   return x + y

这段代码定义了一个简单的函数my_function，它接受两个参数并返回这两个参数的和。然后，我们使用inspect.getsource()函数获取my_function函数的源代码，并将其存储在源代码变量中。最后，将源代码输出到控制台。

inspect.getsource()函数通过从定义函数的文件中读取函数的源代码来操作。它将函数的整个源代码作为字符串返回，包括源代码中的任何注释或空行。

inspect.getsourcefile()函数还可以用于检索包含函数或模块源代码的文件名。如果您需要找到包含特定函数或模块的文件，这将很有帮助。

以下示例演示了如何检索包含函数源代码的文件名：

示例

import inspect
def my_function(x, y):
   return x + y
source_file = inspect.getsourcefile(my_function)
print(source_file)

输出

/home/cg/root/79120/main.py

这段代码定义了与之前相同的my function函数，并使用inspect.getsourcefile()函数检索包含函数源代码的文件名。此函数返回的是文件名的字符串，而不是实际的源代码。

inspect模块提供了几个函数，用于检索有关Python对象的信息，包括它们的源代码。以下是一些额外的示例−

要检索类方法的源代码，请在方法本身上调用inspect.getsource()−

示例

import inspect
class MyClass:
   def my_method(self, x, y):
      return x + y
source_code = inspect.getsource(MyClass.my_method)
print(source_code)

输出

def my_method(self, x, y):
   return x + y

在这个例子中，类 MyClass 有一个叫做 “my method” 的方法，它接受两个参数并返回它们的和。使用 inspect.getsource() 函数可以获取 MyClass.my method 方法的源代码。

要获取整个模块的源代码，请在模块本身使用 inspect.getsource() 函数 –

例子

import inspect
import my_module
source_code = inspect.getsource(my_module)
print(source_code)

在这个例子中，我们导入了 my module 模块并使用 inspect.getsource 来检索其源代码。

您还可以使用 inspect.getfile 函数来获取包含模块、类或函数源代码的文件的名称。类似于 inspect.getsourcefile，这个函数以字符串形式返回文件名。这个例子演示了如何使用 inspect.getfile 来检索模块的文件名 −

示例

import inspect
import my_module
source_file = inspect.getfile(my_module)
print(source_file)

这段代码导入了 my_module 模块，并使用 inspect.getfile() 来获取源代码文件的名称。请注意，该函数返回文件的绝对路径。

** dis** 模块是另一种获取 Python 函数源代码的方法。dis 模块为 Python 字节码提供了一个反汇编器，您可以使用它来查看函数的字节码指令。通过反编译字节码，可以更全面地了解函数的操作方式，包括操作的确切顺序。

以下是使用 dis 模块检索函数的字节码指令的示例：

示例

import dis
def my_function(x, y):
   return x + y
bytecode = dis.Bytecode(my_function)
for instruction in bytecode:
   print(instruction)

输出

Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='x', argrepr='x', offset=0, starts_line=3, is_jump_target=False)
Instruction(opname='LOAD_FAST', opcode=124, arg=1, argval='y', argrepr='y', offset=2, starts_line=None, is_jump_target=False)
Instruction(opname='BINARY_ADD', opcode=23, arg=None, argval=None, argrepr='', offset=4, starts_line=None, is_jump_target=False)
Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=6, starts_line=None, is_jump_target=False)

在这个例子中，定义了一个简单的函数叫做 my_function，它接受两个参数并返回它们的和。然后，通过将 my_function 函数作为参数传递给 dis.Bytecode 函数，创建了一个 dis.Bytecode 对象。这样我们就可以看到函数在被拆解后的字节码指令。接着，我们可以使用一个 for 循环来遍历这些指令并将它们打印到控制台。 这段代码将返回一系列的 dis.Instruction 对象，它们代表了函数的字节码指令。每个 dis.Instruction 对象都包括如 opname（字节码指令的名称）、argval（指令的参数）和 offset（指令在函数字节码中的字节偏移量）等属性。通过查看这些属性，你可以了解函数的工作原理的一切。 请注意，dis 模块可能是相当低级的，可能不适用于所有的用例。然而，如果您需要对一个函数的运行方式有全面的了解，它可以是一个有用的工具。我们使用 inspect 模块的 getsource() 方法来获取函数的源代码。 示例：

inspect.getsource(object)

此函数返回对象源代码的文本。参数可以是模块、类、方法、函数、回溯、帧或代码对象。将源代码作为单个字符串返回。如果无法检索源代码，则会生成 IOError。

如果函数是从字符串、流编译的，或者是从先前编译的文件导入的，那么其源代码将无法检索。

以下是导入 inspect 模块并检索给定脚本的源代码的示例。

示例

#baz.py
import inspect
class foo:
   def bar():
      print ('Hello')
print(inspect.getsource(foo))

输出

class foo:
   def bar():
      print ('Hello')