如何获取Python类中的方法列表?


329

1
消息来源.....消息来源
RickyA

4
@JonCrowell力量不是这样运作的。
肯·威廉姆斯

对于Cython,使用编译器指令的binding工作原理是:stackoverflow.com/a/46041480/1959808
Ioannis Filippidis

4
在python3上:[f for f in dir(ClassName) if not f.startswith('_')]或仅dir(ClassName)用于一切
Seraf

@Seraf请不要在评论中发布答案。而是发布答案。
wjandrea

Answers:


331

一个示例(列出了 optparse.OptionParser类):

>>> from optparse import OptionParser
>>> import inspect
#python2
>>> inspect.getmembers(OptionParser, predicate=inspect.ismethod)
[([('__init__', <unbound method OptionParser.__init__>),
...
 ('add_option', <unbound method OptionParser.add_option>),
 ('add_option_group', <unbound method OptionParser.add_option_group>),
 ('add_options', <unbound method OptionParser.add_options>),
 ('check_values', <unbound method OptionParser.check_values>),
 ('destroy', <unbound method OptionParser.destroy>),
 ('disable_interspersed_args',
  <unbound method OptionParser.disable_interspersed_args>),
 ('enable_interspersed_args',
  <unbound method OptionParser.enable_interspersed_args>),
 ('error', <unbound method OptionParser.error>),
 ('exit', <unbound method OptionParser.exit>),
 ('expand_prog_name', <unbound method OptionParser.expand_prog_name>),
 ...
 ]
# python3
>>> inspect.getmembers(OptionParser, predicate=inspect.isfunction)
...

请注意,它getmembers返回2元组的列表。第一项是成员的名称,第二项是值。

您还可以将实例传递给getmembers

>>> parser = OptionParser()
>>> inspect.getmembers(parser, predicate=inspect.ismethod)
...

4
完美,谓词部分是关键,否则您将获得与dict相同的东西以及额外的元信息。谢谢。
Purrell

2
这会产生该类中所有方法的列表(包括从其他类继承的方法),还是仅列出该类中显式定义的方法?
Anderson Green

10
inspect.isroutine可能是一个更合适的谓词;inspect.ismethod不适用于所有对象的方法。
加文·扬西

1
这仅在使用类的实例时才有效(示例也是如此)。这是预期的行为吗?
Christian Reall-Fluharty,

2
在python 3.7上至少这是行不通的,您必须实例化该类
kederrac

222

dir(theobject)方法可以列出对象的所有字段和方法(以元组的形式),而检查模块(以codeape编写方式)可以列出带有其文档的字段和方法(在““”中)。

因为所有内容(甚至字段)都可能在Python中调用,所以我不确定是否有内置函数仅列出方法。您可能想尝试一下该对象你打通dir调用与否。


3
dir(object)是我使用过的最简单的解决方案。
lstodd

@skjerns需输入5个符号。:)
Dr_Zaszuś

117

没有外部库的Python 3.x答案

method_list = [func for func in dir(Foo) if callable(getattr(Foo, func))]

dunder排除的结果:

method_list = [func for func in dir(Foo) if callable(getattr(Foo, func)) and not func.startswith("__")]

38

假设您想知道与列表类关联的所有方法Just Type下面

 print (dir(list))

以上将为您提供列表类的所有方法


2
这是最好的解决方案
Zeeshan Ahmad

3
print([ m for m in dir(my_class) if not m.startswith('__')])
Evhz

32

尝试属性__dict__


16
我认为你的意思是字典。但这列出了实例的属性,而不是方法。
me_and

1
……那对我也不起作用。查阅了Markdown语法后,我想我的意思是__dict__。
me_and

3
@me_,您可能正在执行“ self .__ dict__”,或更一般地说,是调用的实例版本__dict__。但是类也有__dict__,应该显示类方法:)
Seaux

21

您还可以从类型中导入FunctionType并使用进行测试class.__dict__

from types import FunctionType

class Foo:
    def bar(self): pass
    def baz(self): pass

def methods(cls):
    return [x for x, y in cls.__dict__.items() if type(y) == FunctionType]

methods(Foo)  # ['bar', 'baz']

这对我来说很好。我确实and not x.startswith('_')在列表理解的末尾添加了用于忽略__init__和私有方法的信息。
克里斯托弗·皮尔森

2
你可以摆脱importFunctionType使用一次性拉姆达与type()type(lambda:0)
Tersosauros

isinstance会比type(y) == FunctionType这里更好。
Gloweye

13

请注意,您需要考虑是否要从基类中继承(但不重写)的方法包含在结果中。在dir()inspect.getmembers()操作做包括基类的方法,但使用的__dict__属性没有。


3

这也适用:

mymodule.py

def foo(x)
   return 'foo'
def bar()
   return 'bar'

在另一个文件中

import inspect
import mymodule
method_list = [ func[0] for func in inspect.getmembers(mymodule, predicate=inspect.isroutine) if callable(getattr(mymodule, func[0])) ]

输出:

['foo', 'bar']

从python文档中:

inspect.isroutine(对象)

Return true if the object is a user-defined or built-in function or method.


2

有这种方法:

[getattr(obj, m) for m in dir(obj) if not m.startswith('__')]

当处理一个类实例时,最好返回一个带有方法引用的列表,而不仅仅是名称¹。如果那是您的目标,以及

  1. 不使用 import
  2. __init__从列表中排除私有方法(例如)

它可能有用。简而言之,对于像

class Ghost:
    def boo(self, who):
        return f'Who you gonna call? {who}'

我们可以检查实例检索

>>> g = Ghost()
>>> methods = [getattr(g, m) for m in dir(g) if not m.startswith('__')]
>>> print(methods)
[<bound method Ghost.boo of <__main__.Ghost object at ...>>]

因此,您可以立即调用它:

>>> for method in methods:
...     print(method('GHOSTBUSTERS'))
...
Who you gonna call? GHOSTBUSTERS

¹一个用例:

我用它来进行单元测试。有一堂课,其中所有方法都执行同一过程的变体-这导致了冗长的测试,每种方法之间只有一个小小的调整。DRY是一个遥不可及的梦想。

认为我应该对所有方法进行一次测试,因此我进行了上述迭代。

尽管我意识到我反而应该将代码本身重构为符合DRY规范……这在将来仍然可能会成为一个挑剔的灵魂。


2

我将其保留在那里,因为评分最高的答案尚不清楚

这是一个简单的测试,不是基于Enum的常规类。

# -*- coding: utf-8 -*-
import sys, inspect
from enum import Enum

class my_enum(Enum):
    """Enum base class my_enum"""
    M_ONE = -1
    ZERO = 0
    ONE = 1
    TWO = 2
    THREE = 3

    def is_natural(self):
            return (self.value > 0)
    def is_negative(self):
            return (self.value < 0)

def is_clean_name(name):
    return not name.startswith('_') and not name.endswith('_')
def clean_names(lst):
    return [ n for n in lst if is_clean_name(n) ]
def get_items(cls,lst):
    try:
            res = [ getattr(cls,n) for n in lst ]
    except Exception as e:
            res = (Exception, type(e), e)
            pass
    return res


print( sys.version )

dir_res = clean_names( dir(my_enum) )
inspect_res = clean_names( [ x[0] for x in inspect.getmembers(my_enum) ] )
dict_res = clean_names( my_enum.__dict__.keys() )

print( '## names ##' )
print( dir_res )
print( inspect_res )
print( dict_res )

print( '## items ##' )
print( get_items(my_enum,dir_res) )
print( get_items(my_enum,inspect_res) )
print( get_items(my_enum,dict_res) )

这就是输出结果。

3.7.7 (default, Mar 10 2020, 13:18:53) 
[GCC 9.2.1 20200306]
## names ##
['M_ONE', 'ONE', 'THREE', 'TWO', 'ZERO']
['M_ONE', 'ONE', 'THREE', 'TWO', 'ZERO', 'name', 'value']
['is_natural', 'is_negative', 'M_ONE', 'ZERO', 'ONE', 'TWO', 'THREE']
## items ##
[<my_enum.M_ONE: -1>, <my_enum.ONE: 1>, <my_enum.THREE: 3>, <my_enum.TWO: 2>, <my_enum.ZERO: 0>]
(<class 'Exception'>, <class 'AttributeError'>, AttributeError('name'))
[<function my_enum.is_natural at 0xb78a1fa4>, <function my_enum.is_negative at 0xb78ae854>, <my_enum.M_ONE: -1>, <my_enum.ZERO: 0>, <my_enum.ONE: 1>, <my_enum.TWO: 2>, <my_enum.THREE: 3>]

所以我们有:

  • dir 提供不完整的数据
  • inspect.getmembers 提供不完整的数据,并提供无法使用的内部密钥 getattr()
  • __dict__.keys()提供完整可靠的结果

为什么选票如此错误?而我错了?还有哪些人的答案这么低呢?


1
methods = [(func, getattr(o, func)) for func in dir(o) if callable(getattr(o, func))]

给出与

methods = inspect.getmembers(o, predicate=inspect.ismethod)

做。


0

如果您的方法是“常规”方法,而不是statimethodclassmethod等等。
我想出了一点技巧-

for k, v in your_class.__dict__.items():
    if "function" in str(v):
        print(k)

通过相应地改变if条件中的“功能”,可以将其扩展到其他类型的方法。
在python 2.7上测试。


1
不知道为什么不赞成这样做……实际上确实解决了我遇到的问题。
redspidermkv


-1

我知道这是一篇旧文章,但是只是编写了此函数,如果有人偶然发现答案,它将留在这里:

def classMethods(the_class,class_only=False,instance_only=False,exclude_internal=True):

    def acceptMethod(tup):
        #internal function that analyzes the tuples returned by getmembers tup[1] is the 
        #actual member object
        is_method = inspect.ismethod(tup[1])
        if is_method:
            bound_to = tup[1].im_self
            internal = tup[1].im_func.func_name[:2] == '__' and tup[1].im_func.func_name[-2:] == '__'
            if internal and exclude_internal:
                include = False
            else:
                include = (bound_to == the_class and not instance_only) or (bound_to == None and not class_only)
        else:
            include = False
        return include
    #uses filter to return results according to internal function and arguments
    return filter(acceptMethod,inspect.getmembers(the_class))

此代码不执行预期的发布。提供class_only或instance_only将导致列表为空。
Oz123 '16

-2

这只是一个观察。“编码”似乎是字符串对象的一种方法

str_1 = 'a'
str_1.encode('utf-8')
>>> b'a'

但是,如果检查str1中的方法,则返回一个空列表

inspect.getmember(str_1, predicate=inspect.ismethod)
>>> []

因此,也许我错了,但是问题似乎并不简单。


1
'a'是一个对象,其类型为str。您可以通过运行看到这一点type('a')inspect.getmember()具有类型参数,因此您需要调用inspect.getmember(str)以查看期望的内容。
lhasson

-3
class CPerson:
    def __init__(self, age):
        self._age = age

    def run(self):
        pass

    @property
    def age(self): return self._age

    @staticmethod
    def my_static_method(): print("Life is short, you need Python")

    @classmethod
    def say(cls, msg): return msg


test_class = CPerson
# print(dir(test_class))  # list all the fields and methods of your object
print([(name, t) for name, t in test_class.__dict__.items() if type(t).__name__ == 'function' and not name.startswith('__')])
print([(name, t) for name, t in test_class.__dict__.items() if type(t).__name__ != 'function' and not name.startswith('__')])

输出

[('run', <function CPerson.run at 0x0000000002AD3268>)]
[('age', <property object at 0x0000000002368688>), ('my_static_method', <staticmethod object at 0x0000000002ACBD68>), ('say', <classmethod object at 0x0000000002ACF0B8>)]

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.