Pythonの現在のモジュール内のすべてのクラスのリストを取得するにはどうすればよいですか?


301

モジュールからすべてのクラスを抽出する多くの例を見てきました。通常は次のようなものです。

# foo.py
class Foo:
    pass

# test.py
import inspect
import foo

for name, obj in inspect.getmembers(foo):
    if inspect.isclass(obj):
        print obj

驚くばかり。

しかし、現在のモジュールからすべてのクラスを取得する方法を見つけることができません。

# foo.py
import inspect

class Foo:
    pass

def print_classes():
    for name, obj in inspect.getmembers(???): # what do I do here?
        if inspect.isclass(obj):
            print obj

# test.py
import foo

foo.print_classes()

これはおそらく明白なことでしょうが、私は何も見つけることができませんでした。誰かが私を助けてくれますか?


2
このような機能のPEPがありましたが、拒否されました。
Gary van der Merwe、

ソースを読むことの何が問題になってい"class"ますか?なぜうまくいかないのですか?
S.Lott、2009年

66
問題は、いくつかのタスクを自動化したいということだと思います。そのため、プログラムで実行することが重要です。おそらく質問者は、ソースコードを目で読んで手動で行うと、繰り返しが多く、エラーが発生しやすく、時間がかかる可能性があると考えています。
ジョナサンハートレイ

回答:


386

これを試して:

import sys
current_module = sys.modules[__name__]

あなたの文脈では:

import sys, inspect
def print_classes():
    for name, obj in inspect.getmembers(sys.modules[__name__]):
        if inspect.isclass(obj):
            print(obj)

そしてさらに良い:

clsmembers = inspect.getmembers(sys.modules[__name__], inspect.isclass)

inspect.getmembers()述語を取るからです。


9
このモジュールのクラスをモジュールレベル(つまりfrom optparse import OptionParser)でインポートすると、それらのモジュールは印刷リストに含まれます。どうすればそれを回避できますか?
Chris

5
@phasetwenty、代わりにあなたのようなものを持つことができますinspect.isclass:inspect.getmembers(sys.modules[__name__], lambda member: member.__module__ == __name__ and isnpect.isclass)
ナディアAlramli

1
しかしdict(inspect.getmembers(sys.modules[__name__])) == globals()、常にTrueであるので、なぜ輸入ですか?
kojiro 2012

16
ナディアの答えはほぼ正しいです。より良い: inspect.getmembers(sys.modules[__name__], lambda member: inspect.isclass(member) and member.__module__ == __name__
ウィリアムバディントン2013

1
@JohnM。ナディアに電話するのを忘れたのでisclass
Alex Hall

20

どうですか

g = globals().copy()
for name, obj in g.iteritems():


これは私が通常行うことです。他の答えははるかに「きれい」に見えますが、それらについては知りませんでした。
Mizipzor 2009年

1
あなたは上のフィルタ場合は特に、私にはたくさんのきれいなようですisinstance(obj, types.ClassType)
小次郎

4
Iから例えば、より良い現在のモジュールはsys.modulesに置かれていない場合でも、それが動作しますので、この答えのようなdocs.python.org/2/library/functions.html#execfile
クリス・スミス

@ChrisSmith特に、私は本日pudb、プログラムをこのように実行するようなデバッガーがあり、その結果、sys.modulesデバッグ中にコードがランダムに破損することを発見しました。globals()少し見苦しいようですが、信頼性ははるかに高いようです。
Soren Bjornstad

15

それを行うための「適切な」方法があるかどうかはわかりませんが、あなたのスニペットは正しい軌道にあります:import foofoo.pyに追加しinspect.getmembers(foo)てください。そうすれば、うまく機能するはずです。


おっと、これは循環依存関係などを作成するだろうと思っていましたが、うまくいきます!
mcccclean 2009年

循環依存やインポートループが発生しないのは、モジュールをインポートすると、グローバルネームスペースに追加されるためです。インポートされたモジュールが実行され、 'import foo'に到達すると、モジュールはすでにグローバルで使用可能であるため、インポートはスキップされます。fooをメインとして(スクリプトとして)実行すると、モジュールは実際に2回実行されます。これは、 'fooのインポート'に到達すると、メインはグローバルネームスペースにあり、fooではないためです。「fooのインポート」の後、「main」と「foo」の両方がグローバル名前空間に置かれます。
galinden

11

dirビルトインプラスから必要なものすべてを手に入れることができましたgetattr

# Works on pretty much everything, but be mindful that 
# you get lists of strings back

print dir(myproject)
print dir(myproject.mymodule)
print dir(myproject.mymodule.myfile)
print dir(myproject.mymodule.myfile.myclass)

# But, the string names can be resolved with getattr, (as seen below)

しかし、それは毛玉のように見えます:

def list_supported_platforms():
    """
        List supported platforms (to match sys.platform)

        @Retirms:
            list str: platform names
    """
    return list(itertools.chain(
        *list(
            # Get the class's constant
            getattr(
                # Get the module's first class, which we wrote
                getattr(
                    # Get the module
                    getattr(platforms, item),
                    dir(
                        getattr(platforms, item)
                    )[0]
                ),
                'SYS_PLATFORMS'
            )
            # For each include in platforms/__init__.py 
            for item in dir(platforms)
            # Ignore magic, ourselves (index.py) and a base class.
            if not item.startswith('__') and item not in ['index', 'base']
        )
    ))

6
import pyclbr
print(pyclbr.readmodule(__name__).keys())

stdlibのPythonクラスブラウザーモジュールは静的なソース分析を使用するため、実際の.pyファイルに基づくモジュールでのみ機能することに注意してください。


4

現在のモジュールに属するすべてのクラスが必要な場合は、これを使用できます。

import sys, inspect
def print_classes():
    is_class_member = lambda member: inspect.isclass(member) and member.__module__ == __name__
    clsmembers = inspect.getmembers(sys.modules[__name__], is_class_member)

Nadiaの回答を使用し、モジュールに他のクラスをインポートしていた場合、そのクラスもインポートされます。

そのmember.__module__ == __name__ため、で使用される述語にが追加されていis_class_memberます。このステートメントは、クラスが実際にモジュールに属していることを確認します。

述語は、ブール値を返す関数(呼び出し可能)です。


3

Python 2および3で機能する別のソリューション:

#foo.py
import sys

class Foo(object):
    pass

def print_classes():
    current_module = sys.modules[__name__]
    for key in dir(current_module):
        if isinstance( getattr(current_module, key), type ):
            print(key)

# test.py
import foo
foo.print_classes()

これは3.6.8では機能しません。モジュールエラーは発生しません。
Aviral Srivastava

3

これは、現在のモジュールで定義されている(つまり、インポートされていない)すべてのクラスを取得するために使用する行です。PEP-8によると少し長いですが、必要に応じて変更できます。

import sys
import inspect

classes = [name for name, obj in inspect.getmembers(sys.modules[__name__], inspect.isclass) 
          if obj.__module__ is __name__]

これにより、クラス名のリストが表示されます。クラスオブジェクト自体が必要な場合は、代わりにobjを保持してください。

classes = [obj for name, obj in inspect.getmembers(sys.modules[__name__], inspect.isclass)
          if obj.__module__ is __name__]

これは私の経験でより便利になりました。



0

こんなことができると思います。

class custom(object):
    __custom__ = True
class Alpha(custom):
    something = 3
def GetClasses():
    return [x for x in globals() if hasattr(globals()[str(x)], '__custom__')]
print(GetClasses())`

独自のクラスが必要な場合


0

コマンドラインユーティリティを作成していることがよくあります。最初の引数は、さまざまなクラスの1つを参照するためのものです。たとえば./something.py feature command —-argumentsFeatureはクラスであり、commandはそのクラスのメソッドです。これを簡単にする基本クラスを次に示します。

この基本クラスは、そのすべてのサブクラスと同じディレクトリにあると想定されています。その後ArgBaseClass(foo = bar).load_subclasses()、辞書を返すを呼び出すことができます。たとえば、ディレクトリが次のようになっているとします。

  • arg_base_class.py
  • feature.py

feature.py実装を想定するとclass Feature(ArgBaseClass)、上記の呼び出しload_subclassesは戻り{ 'feature' : <Feature object> }ます。同じkwargsfoo = bar)がFeatureクラスに渡されます。

#!/usr/bin/env python3
import os, pkgutil, importlib, inspect

class ArgBaseClass():
    # Assign all keyword arguments as properties on self, and keep the kwargs for later.
    def __init__(self, **kwargs):
        self._kwargs = kwargs
        for (k, v) in kwargs.items():
            setattr(self, k, v)
        ms = inspect.getmembers(self, predicate=inspect.ismethod)
        self.methods = dict([(n, m) for (n, m) in ms if not n.startswith('_')])

    # Add the names of the methods to a parser object.
    def _parse_arguments(self, parser):
        parser.add_argument('method', choices=list(self.methods))
        return parser

    # Instantiate one of each of the subclasses of this class.
    def load_subclasses(self):
        module_dir = os.path.dirname(__file__)
        module_name = os.path.basename(os.path.normpath(module_dir))
        parent_class = self.__class__
        modules = {}
        # Load all the modules it the package:
        for (module_loader, name, ispkg) in pkgutil.iter_modules([module_dir]):
            modules[name] = importlib.import_module('.' + name, module_name)

        # Instantiate one of each class, passing the keyword arguments.
        ret = {}
        for cls in parent_class.__subclasses__():
            path = cls.__module__.split('.')
            ret[path[-1]] = cls(**self._kwargs)
        return ret
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.