Skip to main content
 首页 » 编程设计

python之什么决定了 python 的 help() 列出的方法

2024年12月31日8kenshinobiy

我有以下 python 文件,test.py:

from math import floor 
from logging import getLogger 

当我执行以下操作时:

$ python3 
>>> import test 
>>> help(test) 

我看到了这个:

Help on module test: 
 
NAME 
    test 
 
FUNCTIONS 
    floor(...) 
        floor(x) 
 
        Return the floor of x as an Integral. 
        This is the largest integer <= x. 
 
FILE 
    ... 

为什么帮助文本中记录了 floor 方法,而 getLogger 却没有?更广泛地说,是什么决定了哪些方法被列在帮助文本中? python 模块的帮助文本?

请您参考如下方法:

对于模块,你可以看看docmodule生成此帮助文本的方法。

简而言之,列出了内置函数(如 floor)(请参阅条件中的 isbuiltin 调用)而不属于您调用的模块的函数没有被列出(这就是 inspect.getmodule(value) is object 所处理的)。我不确定为什么做出这个决定。

如果您定义一个包含可见的函数/变量/类名称的 __all__ 变量,这可以被您覆盖。

除此之外,您还有一些特殊名称不会被提取(例如以 _ 开头的名称)。您可以通过查看 visiblename 了解这是如何处理的。为模块中的大多数名称调用的函数。