我的系统上安装了Python模块,我希望能够看到其中可用的函数/类/方法。
我想在每个函数上调用help函数。在Ruby中,我可以执行ClassName.methods之类的操作来获取该类上所有可用方法的列表。 Python中有类似的东西吗?
例如。类似的东西:
from somemodule import foo
print(foo.methods)  # or whatever is the correct method to call


#1 楼

使用inspect模块:
from inspect import getmembers, isfunction

from somemodule import foo
print(getmembers(foo, isfunction))

另请参阅pydoc模块,交互式解释器中的help()函数和pydoc命令行工具,该工具生成您需要的文档。您可以给他们想要查看其文档的课程。他们还可以生成例如HTML输出并将其写入磁盘。

评论


我已经在某些情况下提出了在某些情况下使用ast模块的理由。

–csl
2015年6月23日14:57在

TL; DR的答案如下:使用dir返回函数和变量;仅使用检查来过滤功能;并使用ast进行解析而无需导入。

–乔纳森·H
18-3-20在9:55



值得测试一下Sheljohn总结的每种方法,因为所产生的输出与一个解决方案的结果截然不同。

– clozach
18年3月31日在22:45

@ Hack-R这是列出mymodule中所有功能的代码:[f [0] for inspect.getmembers(mymodule,inspect.isfunction)中的f]

– SurpriseDog
19年5月24日在2:05

#2 楼

您可以使用dir(module)查看所有可用的方法/属性。同时查看PyDocs。

评论


严格来说,这不是真的。 dir()函数“试图产生最相关的信息,而不是完整的信息”。资料来源:docs.python.org/library/functions.html#dir。

–泽林
2012年4月17日14:08



@jAckOdE引用了吗?然后,您将获得字符串模块的可用方法和属性。

– OrangeTux
2014年5月6日7:44

@OrangeTux:糟糕,这应该是个问题。是的,你回答了。

– jAckOdE
2014年5月8日7:34



OP明确要求功能而不是变量。 cf使用检查回答。

–乔纳森·H
18-3-15在16:13



#3 楼

import模块一旦完成,您就可以执行以下操作:或者,您可以使用:
help(modulename)


评论


@sheljohn ...这种批评的意义是什么?我的解决方案还列出了函数,并且检查模块也可以列出变量,即使此处未明确要求。此解决方案仅需要内置对象,这在将Python安装在受限/锁定/损坏的环境中的某些情况下非常有用。

–丹·伦斯基
18年3月18日在20:16

谢谢,这几乎可以用,但是我认为dir将打印结果,但是看起来您需要执行print(dir(modulename))。

–艾略特
19年9月12日在5:31

#4 楼

使用inspect.getmembers获取模块中的所有变量/类/函数等,并将inspect.isfunction作为谓词传递以仅获取函数: 。
可以用getmembers模块中的任何其他(object_name, object)功能替换isfunction

评论


getmembers可以使用谓词,因此您的示例也可以写成:functions_list = [getmembers(my_module,isfunction)中o的o

–克里斯托弗·柯里(Christopher Currie)
2012年12月4日23:01



@ChristopherCurrie,您还可以通过functions_list = getmembers(my_module,predicate)避免不必要的列表理解,因为它已经返回了列表;)

–无
2014年2月19日在21:43

要查找该函数是否在该模块中定义(而不是导入),请在“ if isfunction(o [1])和o [1] .__ module__ == my_module .__ name__”上添加:-注意,如果导入的功能来自与该模块同名的模块。

–Michael Scott Cuthbert
18年1月11日,9:01

#5 楼

import types
import yourmodule

print([getattr(yourmodule, a) for a in dir(yourmodule)
  if isinstance(getattr(yourmodule, a), types.FunctionType)])


评论


对于此路由,请使用getattr(yourmodule,a,None)代替yourmodule .__ dict __。get(a)

–托马斯·沃特斯
08-09-26 at 12:53

your_module .__ dict__是我的选择,因为您实际上获得了一个包含functionName:的字典,并且您现在能够动态调用该函数。美好时光!

– jsh
11年1月28日在21:31

Python 3友好并带有一些糖色:导入类型def print_module_functions(module):print('\ n'.join([str(module .__ dict __。get(a).__ name__)for indir(module)for isinstance(module)。 __dict __。get(a),types.FunctionType)]))

– y.selivonchyk
17年7月10日在17:48



这还将列出该模块导入的所有功能。那可能是您想要的,也可能不是。

– scubbo
6月10日20:27

#6 楼

为了完整起见,我想指出,有时您可能想解析代码而不是导入代码。 import将执行顶级表达式,这可能是个问题。例如,我让用户为zipapp制作的软件包选择入口点函数。使用importinspect可能会运行错误代码,从而导致崩溃,崩溃,打印帮助消息,弹出GUI对话框等。

import ast
import sys

def top_level_functions(body):
    return (f for f in body if isinstance(f, ast.FunctionDef))

def parse_ast(filename):
    with open(filename, "rt") as file:
        return ast.parse(file.read(), filename=filename)

if __name__ == "__main__":
    for filename in sys.argv[1:]:
        print(filename)
        tree = parse_ast(filename)
        for func in top_level_functions(tree.body):
            print("  %s" % func.name)


将这段代码放入list.py中并将其自身用作输入,我得到:

,即使对于像Python这样的相对简单的语言,导航AST有时也会很棘手,因为AST的级别很低。但是,如果您有一个简单明了的用例,那么它既可行又安全。

评论


我喜欢这个;我目前正在尝试确定是否有人已经编写了一个执行类似pydoc的工具,但未导入该模块。到目前为止,这是我找到的最好的例子:)

–詹姆斯·米尔斯(James Mills)
15年12月14日在19:23

同意这个答案。无论目标文件可能导入什么或为哪个版本的python编写,我都需要此函数正常工作。这不会遇到imp和importlib的导入问题。

–埃里克·埃文斯(Eric Evans)
19年5月5日在18:57

模块变量(__version__等)如何?有办法吗?

–frakman1
4月13日18:06

#7 楼

对于您不希望解析的代码,我建议使用@csl的基于AST的方法。

对于其他所有内容,inspect模块都是正确的: br />
这给出了以[(<name:str>, <value:function>), ...]形式的2元组的列表。 >

评论


感谢您的解释;如果可以在要检查的模块上运行导入,我认为这是正确的答案。

–乔纳森·H
18年3月15日在16:19

#8 楼

这将达到目的:

dir(module) 


但是,如果发现读取返回的列表很烦人,只需使用以下循环就可以每行取一个名字。

for i in dir(module): print i


评论


OP明确要求功能而不是变量。 cf使用检查回答。此外,这与@DanLenski的答案有何不同?

–乔纳森·H
18-3-15在16:15



#9 楼

如大多数答案中所述,dir(module)是使用脚本或标准解释器的标准方式。在模块中。
这比使用脚本和print来查看模块中定义的内容要方便得多。模块(函数,类等)

module.<tab>将向您显示类的方法和属性

module.ClassX.<tab>module.function_xy?将向您显示该函数/方法的文档字符串

module.ClassX.method_xy?module.function_x??将为您显示函数/方法的源代码。


#10 楼

对于全局函数,dir()是要使用的命令(如大多数答案中所述),但这将公共函数和非公共函数一起列出。

例如运行:

>>> import re
>>> dir(re)


返回函数/类,如:

'__all__', '_MAXCACHE', '_alphanum_bytes', '_alphanum_str', '_pattern_type', '_pickle', '_subx'


其中一些通常不适合一般编程使用(但模块本身除外,对于__doc____file__等DunderAliases除外)。因此,将它们与公共对象一起列出可能没有用(这是Python知道使用from module import *时会得到什么的方式)。

__all__可用于解决此问题,它返回一个列表模块中所有公共功能和类的名称(不以下划线开头的-_)。参见
有人可以用Python解释__all__吗?供使用__all__的示例。这里是一个示例:

>>> import re
>>> re.__all__
['match', 'fullmatch', 'search', 'sub', 'subn', 'split', 'findall', 'finditer', 'compile', 'purge', 'template', 'escape', 'error', 'A', 'I', 'L', 'M', 'S', 'X', 'U', 'ASCII', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL', 'VERBOSE', 'UNICODE']
>>>


所有带下划线的函数和类均已删除,仅保留定义为公共的,因此可以通过import *使用。

请注意,并非总是定义__all__。如果未包括在内,则会引发AttributeError

ast模块就是这种情况:

>>> import ast
>>> ast.__all__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'ast' has no attribute '__all__'
>>>


#11 楼

如果您无法在没有导入错误的情况下导入所述Python文件,则这些答案均无效。当我检查文件时,我的情况就是这样,该文件来自具有很多依赖关系的大型代码库。下面将以文本形式处理文件,并搜索以“ def”开头的所有方法名称,并打印它们及其行号。

import re
pattern = re.compile("def (.*)\(")
for i, line in enumerate(open('Example.py')):
  for match in re.finditer(pattern, line):
    print '%s: %s' % (i+1, match.groups()[0])


评论


在这种情况下,最好使用ast模块。请参阅我的答案作为示例。

–csl
2015年6月23日14:56在

我认为这是一种有效的方法。为什么当它一downvote?

– m3nda
2015年10月20日,3:30

#12 楼

除了先前答案中提到的dir(模块)或help(模块),您还可以尝试:
-打开ipython
-导入module_name
-键入module_name,然后按tab。它将打开一个小窗口,其中列出了python模块中的所有功能。
看起来很整洁。

以下代码段列出了hashlib模块的所有功能

(C:\Program Files\Anaconda2) C:\Users\lenovo>ipython
Python 2.7.12 |Anaconda 4.2.0 (64-bit)| (default, Jun 29 2016, 11:07:13) [MSC v.1500 64 bit (AMD64)]
Type "copyright", "credits" or "license" for more information.

IPython 5.1.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.

In [1]: import hashlib

In [2]: hashlib.
             hashlib.algorithms            hashlib.new                   hashlib.sha256
             hashlib.algorithms_available  hashlib.pbkdf2_hmac           hashlib.sha384
             hashlib.algorithms_guaranteed hashlib.sha1                  hashlib.sha512
             hashlib.md5                   hashlib.sha224


#13 楼

import sys
from inspect import getmembers, isfunction
fcn_list = [o[0] for o in getmembers(sys.modules[__name__], isfunction)]


#14 楼

Python文档为此使用了内置函数dir提供了完美的解决方案。
您可以只使用dir(module_name),然后它将返回该模块中的函数列表。
例如,dir(time)将返回
['_STRUCT_TM_ITEMS', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'altzone', 'asctime', 'ctime', 'daylight', 'get_clock_info', 'gmtime', 'localtime', 'mktime', 'monotonic', 'monotonic_ns', 'perf_counter', 'perf_counter_ns', 'process_time', 'process_time_ns', 'sleep', 'strftime', 'strptime', 'struct_time', 'time', 'time_ns', 'timezone', 'tzname', 'tzset']
,这是“时间”模块包含的功能列表。

#15 楼

您可以使用以下方法从shell列出模块中的所有功能:


评论


@GabrielFair您在什么版本/平台上运行python?我在Py3.7 / Win10上收到语法错误。

–卡通军长
19年1月20日,下午2:21

+1使用ipython在Python 2.7 Ubuntu 16.04LTS上为我工作;并且不需要额外的模块。

–古努迪夫
7月23日9:57



#16 楼

这将在列表中添加your_module中定义的所有功能。

result=[]
for i in dir(your_module):
    if type(getattr(your_module, i)).__name__ == "function":
        result.append(getattr(your_module, i))


评论


这是什么unit8_conversion_methods?这仅仅是模块名称的示例吗?

– nocibambi
19年7月23日在16:51

@nocibambi是的,这只是一个模块名称。

– Manish Kumar
19年7月27日在7:48

谢谢Manish。我提议以下单行替代方法:[如果类型(getattr(your_module,func)).__ name__ ==“ function”,则dir(your_module)中func的getattr(your_module,func)]

–胺
2月19日在17:02



#17 楼

r = globals()
sep = '\n'+100*'*'+'\n' # To make it clean to read.
for k in list(r.keys()):
    try:
        if str(type(r[k])).count('function'):
            print(sep+k + ' : \n' + str(r[k].__doc__))
    except Exception as e:
        print(e)



输出:

******************************************************************************************
GetNumberOfWordsInTextFile : 

    Calcule et retourne le nombre de mots d'un fichier texte
    :param path_: le chemin du fichier à analyser
    :return: le nombre de mots du fichier

******************************************************************************************

    write_in : 

        Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode a,
        :param path_: le path du fichier texte
        :param data_: la liste des données à écrire ou un bloc texte directement
        :return: None


 ******************************************************************************************
    write_in_as_w : 

            Ecrit les donnees (2nd arg) dans un fichier txt (path en 1st arg) en mode w,
            :param path_: le path du fichier texte
            :param data_: la liste des données à écrire ou un bloc texte directement
            :return: None


#18 楼

使用vars(module),然后使用inspect.isfunction过滤掉所有不是函数的内容: br />此外,这将包括vars导入的函数,如果要过滤掉这些函数以仅获取dir定义的函数,请参阅我的问题获取Python模块中的所有已定义函数。