Skip to main content
 首页 » 编程设计

python之获取 Jupyter Notebook 中定义的对象的源

2024年12月31日9davidwang456

通常,如果你想获取一个对象的来源,你可以通过inspect来获取。模块:

import inspect 
inspect.getsource(MyObject) 

但是,在 Jupyter notebook 中,这不起作用:

import inspect 
 
class Foo: 
    def __init__(self, info): 
        self.info = info 
 
a = Foo("hi") 
 
inspect.getsource(a) 

抛出错误:

--------------------------------------------------------------------------- 
TypeError                                 Traceback (most recent call last) 
<ipython-input-14-048b6f0c2e9b> in <module>() 
      7 a = Foo("hi") 
      8  
----> 9 inspect.getsource(a) 
 
/usr/lib/python3.6/inspect.py in getsource(object) 
    963     or code object.  The source code is returned as a single string.  An 
    964     OSError is raised if the source code cannot be retrieved.""" 
--> 965     lines, lnum = getsourcelines(object) 
    966     return ''.join(lines) 
    967  
 
/usr/lib/python3.6/inspect.py in getsourcelines(object) 
    950     raised if the source code cannot be retrieved.""" 
    951     object = unwrap(object) 
--> 952     lines, lnum = findsource(object) 
    953  
    954     if ismodule(object): 
 
/usr/lib/python3.6/inspect.py in findsource(object) 
    763     is raised if the source code cannot be retrieved.""" 
    764  
--> 765     file = getsourcefile(object) 
    766     if file: 
    767         # Invalidate cache if needed. 
 
/usr/lib/python3.6/inspect.py in getsourcefile(object) 
    679     Return None if no way can be identified to get the source. 
    680     """ 
--> 681     filename = getfile(object) 
    682     all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:] 
    683     all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:] 
 
/usr/lib/python3.6/inspect.py in getfile(object) 
    661         return object.co_filename 
    662     raise TypeError('{!r} is not a module, class, method, ' 
--> 663                     'function, traceback, frame, or code object'.format(object)) 
    664  
    665 def getmodulename(path): 
 
TypeError: <__main__.Foo object at 0x7fb9130ee518> is not a module, class, method, function, traceback, frame, or code object 

如果我试图找到 Foo 的来源(使用 inspect.getsource(Foo) ),我得到:

TypeError: <module '__main__'> is a built-in class

如何获取 Jupyter notebook 中定义的类的源代码?

请您参考如下方法:

我发现了一种获取 Jupyter Notebook 中类源代码的“hacky 方法”。

假设在一个单元格中你有:

class MyClass: 
    test = 2 
     
    def __init__(self): 
        self.L = 5 
     
    def test(self, x): 
        return True 
     
    @classmethod 
    def forward(cls, x): 
        return x 

然后您可以使用以下方法提取代码:

import inspect 
from IPython.core.magics.code import extract_symbols 
 
obj = MyClass 
cell_code = "".join(inspect.linecache.getlines(new_getfile(obj))) 
class_code = extract_symbols(cell_code, obj.__name__)[0][0] 
print(class_code) 

new_getfile 从 here 定义:

import inspect, sys 
 
def new_getfile(object, _old_getfile=inspect.getfile): 
    if not inspect.isclass(object): 
        return _old_getfile(object) 
     
    # Lookup by parent module (as in current inspect) 
    if hasattr(object, '__module__'): 
        object_ = sys.modules.get(object.__module__) 
        if hasattr(object_, '__file__'): 
            return object_.__file__ 
     
    # If parent module is __main__, lookup by methods (NEW) 
    for name, member in inspect.getmembers(object): 
        if inspect.isfunction(member) and object.__qualname__ + '.' + member.__name__ == member.__qualname__: 
            return inspect.getfile(member) 
    else: 
        raise TypeError('Source for {!r} not found'.format(object)) 
inspect.getfile = new_getfile