python - 查找 Python 对象具有哪些方法

Question

给定任何类型的 Python 对象，是否有一种简单的方法可以获取该对象具有的所有方法的列表？

或者，

如果这是不可能的，是否至少有一种简单的方法可以检查它是否具有特定方法，而不是简单地检查调用该方法时是否发生错误？

Answer 1

对于许多对象，您可以使用此代码，将“对象”替换为您感兴趣的对象：

object_methods = [method_name for method_name in dir(object)
                  if callable(getattr(object, method_name))]

我在diveintopython.net上发现了它（现已存档）。希望这应该提供一些进一步的细节！

如果你得到一个AttributeError，你可以使用它来代替：

getattr(不能容忍 pandas 风格的 python3.6 抽象虚拟子类。此代码与上面的代码相同，并忽略异常。

import pandas as pd
df = pd.DataFrame([[10, 20, 30], [100, 200, 300]],
                  columns=['foo', 'bar', 'baz'])
def get_methods(object, spacing=20):
  methodList = []
  for method_name in dir(object):
    try:
        if callable(getattr(object, method_name)):
            methodList.append(str(method_name))
    except Exception:
        methodList.append(str(method_name))
  processFunc = (lambda s: ' '.join(s.split())) or (lambda s: s)
  for method in methodList:
    try:
        print(str(method.ljust(spacing)) + ' ' +
              processFunc(str(getattr(object, method).__doc__)[0:90]))
    except Exception:
        print(method.ljust(spacing) + ' ' + ' getattr() failed')

get_methods(df['foo'])

Answer 2

您可以使用内置dir()函数来获取模块具有的所有属性的列表。在命令行试试这个，看看它是如何工作的。

>>> import moduleName
>>> dir(moduleName)

此外，您可以使用该hasattr(module_name, "attr_name")函数来确定模块是否具有特定属性。

有关更多信息，请参阅Python 自省指南。

Answer 3

最简单的方法是使用dir(objectname). 它将显示该对象可用的所有方法。很酷的把戏。

Answer 4

我相信你想要这样的东西：

对象的属性列表

内置函数dir()可以完成这项工作。

取自help(dir)Python shell 的输出：

目录（...）

dir([object]) -> list of strings

如果在没有参数的情况下调用，则返回当前范围内的名称。

否则，返回一个按字母顺序排列的名称列表，其中包括（部分）给定对象的属性，以及可从该对象访问的属性。

如果对象提供了一个名为 的方法__dir__，它将被使用；否则使用默认的 dir() 逻辑并返回：

• 对于模块对象：模块的属性。
• 对于一个类对象：它的属性，以及递归它的基类的属性。
• 对于任何其他对象：其属性、其类的属性以及递归其类的基类的属性。

例如：

$ python
Python 2.7.6 (default, Jun 22 2015, 17:58:13)
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.

>>> a = "I am a string"
>>>
>>> type(a)
<class 'str'>
>>>
>>> dir(a)
['__add__', '__class__', '__contains__', '__delattr__', '__doc__',
'__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__',
'__getnewargs__', '__getslice__', '__gt__', '__hash__', '__init__',
'__le__', '__len__', '__lt__', '__mod__', '__mul__', '__ne__', '__new__',
'__reduce__', '__reduce_ex__', '__repr__', '__rmod__', '__rmul__',
'__setattr__', '__sizeof__', '__str__', '__subclasshook__',
'_formatter_field_name_split', '_formatter_parser', 'capitalize',
'center', 'count', 'decode', 'encode', 'endswith', 'expandtabs', 'find',
'format', 'index', 'isalnum', 'isalpha', 'isdigit', 'islower', 'isspace',
'istitle', 'isupper', 'join', 'ljust', 'lower', 'lstrip', 'partition',
'replace', 'rfind', 'rindex', 'rjust', 'rpartition', 'rsplit', 'rstrip',
'split', 'splitlines', 'startswith', 'strip', 'swapcase', 'title',
'translate', 'upper', 'zfill']

Answer 5

要检查它是否有特定的方法：

hasattr(object,"method")

Answer 6

除了更直接的答案之外，如果我没有提到IPython ，我会失职。

点击Tab查看可用的方法，自动完成。

找到方法后，请尝试：

help(object.method)

查看 pydocs、方法签名等。

啊... REPL。

Answer 7

获取任何对象的方法列表的最简单方法是使用help()命令。

help(object)

它将列出与该对象关联的所有可用/重要方法。

例如：

help(str)

Answer 8

如果您特别需要方法，则应使用inspect.ismmethod。

对于方法名称：

import inspect
method_names = [attr for attr in dir(self) if inspect.ismethod(getattr(self, attr))]

对于方法本身：

import inspect
methods = [member for member in [getattr(self, attr) for attr in dir(self)] if inspect.ismethod(member)]

有时inspect.isroutine也很有用（对于内置、C 扩展、没有“绑定”编译器指令的 Cython）。

Answer 9

假设我们有一个 Python obj。然后查看它拥有的所有方法，包括那些被__(魔法方法) 包围的方法：

print(dir(obj))

要排除魔术内置，可以这样做：

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

Answer 10

打开一个 Bash shell（在 Ubuntu 上是Ctrl++ Alt） 。T在其中启动一个 Python 3 shell。创建一个对象来观察方法。只需在其后添加一个点并按Tab两次，您将看到如下内容：

user@note:~$ python3
Python 3.4.3 (default, Nov 17 2016, 01:08:31)
[GCC 4.8.4] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import readline
>>> readline.parse_and_bind("tab: complete")
>>> s = "Any object. Now it's a string"
>>> s. # here tab should be pressed twice
s.__add__(           s.__rmod__(          s.istitle(
s.__class__(         s.__rmul__(          s.isupper(
s.__contains__(      s.__setattr__(       s.join(
s.__delattr__(       s.__sizeof__(        s.ljust(
s.__dir__(           s.__str__(           s.lower(
s.__doc__            s.__subclasshook__(  s.lstrip(
s.__eq__(            s.capitalize(        s.maketrans(
s.__format__(        s.casefold(          s.partition(
s.__ge__(            s.center(            s.replace(
s.__getattribute__(  s.count(             s.rfind(
s.__getitem__(       s.encode(            s.rindex(
s.__getnewargs__(    s.endswith(          s.rjust(
s.__gt__(            s.expandtabs(        s.rpartition(
s.__hash__(          s.find(              s.rsplit(
s.__init__(          s.format(            s.rstrip(
s.__iter__(          s.format_map(        s.split(
s.__le__(            s.index(             s.splitlines(
s.__len__(           s.isalnum(           s.startswith(
s.__lt__(            s.isalpha(           s.strip(
s.__mod__(           s.isdecimal(         s.swapcase(
s.__mul__(           s.isdigit(           s.title(
s.__ne__(            s.isidentifier(      s.translate(
s.__new__(           s.islower(           s.upper(
s.__reduce__(        s.isnumeric(         s.zfill(
s.__reduce_ex__(     s.isprintable(
s.__repr__(          s.isspace(

Answer 11

此处指出的所有方法的问题是您无法确定某个方法不存在。

__getattr__在 Python 中，您可以通过and拦截点调用__getattribute__，从而可以“在运行时”创建方法

例子：

class MoreMethod(object):
    def some_method(self, x):
        return x
    def __getattr__(self, *args):
        return lambda x: x*2

如果你执行它，你可以调用对象字典中不存在的方法......

>>> o = MoreMethod()
>>> o.some_method(5)
5
>>> dir(o)
['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattr__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'some_method']
>>> o.i_dont_care_of_the_name(5)
10

这就是为什么你在 Python 中使用比权限范式更容易请求宽恕的原因。

Answer 12

没有可靠的方法来列出所有对象的方法。dir(object)通常很有用，但在某些情况下，它可能不会列出所有方法。根据dir()文档：“使用参数，尝试返回该对象的有效属性列表。”

可以通过callable(getattr(object, method))那里已经提到的方法检查该方法是否存在。

Answer 13

import moduleName
for x in dir(moduleName):
    print(x)

这应该工作:)

Answer 14

...是否至少有一种简单的方法可以检查它是否具有特定方法，而不是简单地检查调用该方法时是否发生错误

虽然“请求宽恕比请求许可更容易”当然是 Python 式的方式，但您可能正在寻找：

d={'foo':'bar', 'spam':'eggs'}
if 'get' in dir(d):
    d.get('foo')
# OUT: 'bar'

Answer 15

可以创建一个getAttrs函数，该函数将返回对象的可调用属性名称

def getAttrs(object):
  return filter(lambda m: callable(getattr(object, m)), dir(object))

print getAttrs('Foo bar'.split(' '))

那会回来的

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__',
 '__delslice__', '__eq__', '__format__', '__ge__', '__getattribute__', 
 '__getitem__', '__getslice__', '__gt__', '__iadd__', '__imul__', '__init__', 
 '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', 
 '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', 
 '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', 
 '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 
 'remove', 'reverse', 'sort']

Answer 16

以列表为对象

obj = []

list(filter(lambda x:callable(getattr(obj,x)),obj.__dir__()))

你得到：

['__add__',
 '__class__',
 '__contains__',
 '__delattr__',
 '__delitem__',
 '__dir__',
 '__eq__',
 '__format__',
 '__ge__',
 '__getattribute__',
 '__getitem__',
 '__gt__',
 '__iadd__',
 '__imul__',
 '__init__',
 '__init_subclass__',
 '__iter__',
 '__le__',
 '__len__',
 '__lt__',
 '__mul__',
 '__ne__',
 '__new__',
 '__reduce__',
 '__reduce_ex__',
 '__repr__',
 '__reversed__',
 '__rmul__',
 '__setattr__',
 '__setitem__',
 '__sizeof__',
 '__str__',
 '__subclasshook__',
 'append',
 'clear',
 'copy',
 'count',
 'extend',
 'index',
 'insert',
 'pop',
 'remove',
 'reverse',
 'sort']

Answer 17

我已经完成了以下函数 ( get_object_functions)，它接收一个对象 ( object_) 作为其参数，并返回一个列表 ( functions)，其中包含对象类中定义的所有方法（包括静态和类方法）：

def get_object_functions(object_):
    functions = [attr_name
                 for attr_name in dir(object_)
                 if str(type(getattr(object_,
                                     attr_name))) in ("<class 'function'>",
                                                      "<class 'method'>")]
    return functions

好吧，它只是检查类属性类型的字符串表示是否等于"<class 'function'>"或"<class 'method'>"，然后在functions列表中包含该属性，如果是True.

---

演示

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def introduce(self):
        print(f'My name is {self.name}')

    @staticmethod
    def say_hi():
        print('hi')

    @classmethod
    def reproduce(cls, name):
        return cls(name, 0)


person = Person('Rafael', 27)
print(get_object_functions(person))

输出

['__init__', 'introduce', 'reproduce', 'say_hi']

如需更简洁的代码版本： https ://github.com/revliscano/utilities/blob/master/get_object_functions/object_functions_getter.py

Answer 18

为了在整个模块中搜索特定的方法

for method in dir(module) :
  if "keyword_of_methode" in method :
   print(method, end="\n")

Answer 19

例如，如果您正在使用 shell plus，则可以改用它：

>> MyObject??

那样，用'??' 就在您的对象之后，它会向您显示该类具有的所有属性/方法。

Answer 20

您可以使用 Python 中预定义的 dir() 。

import module_name
dir(module_name)

您还可以将对象传递给 dir() 作为

dir(object_name)

如果对象是预定义类的对象，例如 int、str 等，它会显示其中的方法（您可能知道这些方法是内置函数）。如果该对象是为用户定义的类创建的，它会显示该类中给出的所有方法。

Answer 21

这是一个很好的衬线（但也会获得属性）：

print(*dir(obj), sep='\n')

Answer 22

大多数时候，我想看到用户定义的方法，不想看到以'__'开头的内置属性，如果你愿意，可以使用以下代码：

object_methods = [method_name for method_name in dir(object) if callable(getattr(object, method_name)) and '__' not in method_name] 

例如，对于这个类：

class Person: 
    def __init__(self, name): 
        self.name = name 
    def print_name(self):
        print(self.name)

上面的代码将打印：['print_name']