Pythonモジュールのすべての関数をリストする方法は？

私のシステムにPythonモジュールがインストールされていますが、その中で使用できる関数/クラス/メソッドを確認できます。

それぞれについてdoc関数を呼び出したいのですが。Rubyでは、ClassName.methodsのようにして、そのクラスで使用できるすべてのメソッドのリストを取得できます。Pythonにも同様のものはありますか？

例えば。何かのようなもの：

from somemodule import foo
print foo.methods # or whatever is the correct method to call

inspectモジュール。また、pydocモジュール、help()インタラクティブインタープリターの関数、およびpydoc必要なドキュメントを生成するコマンドラインツールもご覧ください。ドキュメントを表示したいクラスをそれらに与えることができます。たとえば、HTML出力を生成してディスクに書き込むこともできます。

を使用dir(module)して、使用可能なすべてのメソッド/属性を表示できます。PyDocsも確認してください。

importモジュールを編集したら、次の操作を実行できます。

 help(modulename)

...すべての機能に関するドキュメントをインタラクティブに一度に取得します。または、以下を使用できます。

 dir(modulename)

...モジュールで定義されているすべての関数と変数の名前をリストするだけです。

検査の例：

from inspect import getmembers, isfunction
from my_project import my_module

functions_list = [o for o in getmembers(my_module) if isfunction(o[1])]

getmembersは、（object_name、object_type）タプルのリストを返します。

isfunctionは、inspectモジュール内の他のisXXX関数で置き換えることができます。

import types
import yourmodule

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

完全を期すために、コードをインポートする代わりに解析したい場合があることを指摘しておきます。importう実行トップレベルの表現を、そしてそれが問題である可能性があります。

たとえば、ユーザーがzipappで作成されるパッケージのエントリポイント関数を選択できるようにします。誤ったコードを使用するimportとinspect、クラッシュしたり、ヘルプメッセージが出力されたり、GUIダイアログがポップアップしたりするなど、リスクを伴います。

代わりに、astモジュールを使用してすべてのトップレベル関数をリストします。

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 list.py list.py
list.py
  top_level_functions
  parse_ast

もちろん、ASTは非常に低レベルなので、Pythonのような比較的単純な言語であっても、ASTをナビゲートするのは難しい場合があります。しかし、シンプルで明確なユースケースがあれば、それは実行可能かつ安全です。

ただし、欠点は、のように実行時に生成される関数を検出できないことですfoo = lambda x,y: x*y。

解析したくないコードについては、上記の@cslのASTベースのアプローチをお勧めします。

それ以外の場合は、inspectモジュールが正しいです。

import inspect

import <module_to_inspect> as module

functions = inspect.getmembers(module, inspect.isfunction)

これにより、フォームに2タプルのリストが表示され[(<name:str>, <value:function>), ...]ます。

上記の簡単な答えは、さまざまな応答やコメントで示唆されていますが、明示的に呼び出されていません。

これはトリックを行います：

dir(module) 

ただし、返されたリストを読むのが面倒な場合は、次のループを使用して、1行につき1つの名前を取得します。

for i in dir(module): print i

dir(module) ほとんどの回答で述べられているように、スクリプトまたは標準インタープリターを使用するときの標準的な方法です。

ただし、IPythonのようなインタラクティブなPythonシェルでは、タブ補完を使用して、モジュールで定義されているすべてのオブジェクトの概要を取得できます。これは、スクリプトを使用printしてモジュールで何が定義されているかを確認するよりもはるかに便利です。

• module.<tab> モジュールで定義されたすべてのオブジェクト（関数、クラスなど）を表示します
• module.ClassX.<tab> クラスのメソッドと属性を表示します
• module.function_xy?またはmodule.ClassX.method_xy?その関数/メソッドのドキュメント文字列を表示します
• module.function_x??またはmodule.SomeClass.method_xy??関数/メソッドのソースコードを表示します。

dir()（これらの回答のほとんどで述べられているように）グローバル関数は使用するコマンドですが、これはパブリック関数と非パブリック関数の両方を一緒にリストします。

たとえば、次のように実行します。

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

次のような関数/クラスを返します：

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

そのうちのいくつかは、一般に、一般的なプログラミングの使用のためのもの（ただし、モジュール自体によって、等DunderAliasesの場合を除いていない__doc__、__file__ECT）。このため、それらを公開のものと一緒にリストすることは役に立たない場合があります（これは、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__'
>>>

インポートエラーなしで上記の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])

以前の回答で言及されたdir（module）またはhelp（module）を除いて、次のことも試すことができ ます。-
ipythonを開きます-module_nameを
インポートします-module_nameと
入力し、タブを押します。小さなウィンドウが開き、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

これにより、your_moduleで定義されているすべての関数がリストに追加されます。

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

次のメソッドを使用して、シェルからモジュール内のすべての関数のリストを取得できます。

import module

module.*?

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

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