查找Python对象具有的方法


Answers:


521

对于许多对象,您可以使用以下代码,将“ object”替换为您感兴趣的对象:

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

我在diveintopython.net上发现了它(现已存档)。希望可以提供更多详细信息!

如果得到AttributeError,则可以改用

getattr(不能容忍熊猫风格的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: 
        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: 
        print(method.ljust(spacing) + ' ' + ' getattr() failed') 


get_methods(df['foo']) 

3
这是一个列表推导,返回一个方法列表,其中method是dir(object)返回的列表中的一项,并且仅当getattr(object,method)返回可调用时,每个方法才添加到列表中。
Mnebuerquo 2014年

1
您究竟如何使用它?要说打印方法列表。
2015年

12
@marsh要打印方法:print [method for method in dir(object) if callable(getattr(object, method))]
Orienteerix

1
我在AttributeError: module 'pandas.core.common' has no attribute 'AbstractMethodError'尝试运行此程序时遇到问题。请参阅stackoverflow.com/q/54713287/9677043上的详细信息。
卡尔·贝克

1
在python 3.6中不适用于pandas dataframe对象。
Stefan Karlsson,

226

您可以使用内置dir()函数来获取模块具有的所有属性的列表。在命令行上尝试此操作以查看其工作原理。

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

另外,您可以使用 hasattr(module_name, "attr_name")函数来查找模块是否具有特定属性。

有关更多信息,请参见Python自省指南


hasattr帮助我的用例查找python对象是否具有特定的成员变量或方法。
阿克瑟伊,

我不确定为什么这个解决方案没有得到足够的支持。这是简洁而准确的。
Prasad Raghavendra

93

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


2
它还显示对象的属性,因此,如果要专门查找方法,将无法使用。
eric

是。同意 但是,我不知道有什么其他技术可以仅获取方法列表。也许最好的主意是获取属性和方法的列表,然后使用<hasattr(object,“ method_name”>“进行进一步过滤?
Pawan Kumar

1
@neuronet,我正在尝试运行接受的答案,但得到一个AttributeError: module 'pandas.core.common' has no attribute 'AbstractMethodError'。有任何想法吗?请参阅 stackoverflow.com/q/54713287/9677043上的说明。+1对@Pawan Kumar b / c的答案有效,对@ljs则是对方法的过滤列表的保证。
卡尔·贝克

30

要检查它是否具有特定方法:

hasattr(object,"method")

14
由于OP正在寻找一种方法,而不仅仅是一种方法和属性,我想您想更进一步:if hasattr(obj,method) and callable(getattr(obj,method)):
Bruno Bronosky 2013年

28

我相信您想要的是这样的:

来自对象的属性列表

以我的拙见,内置功能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']

在检查您的问题时,我决定展示我的思路,并以更好的格式输出 dir()

dir_attributes.py(Python 2.7.6)

#!/usr/bin/python
""" Demonstrates the usage of dir(), with better output. """

__author__ = "ivanleoncz"

obj = "I am a string."
count = 0

print "\nObject Data: %s" % obj
print "Object Type: %s\n" % type(obj)

for method in dir(obj):
    # the comma at the end of the print, makes it printing 
    # in the same line, 4 times (count)
    print "| {0: <20}".format(method),
    count += 1
    if count == 4:
        count = 0
        print

dir_attributes.py(Python 3.4.3)

#!/usr/bin/python3
""" Demonstrates the usage of dir(), with better output. """

__author__ = "ivanleoncz"

obj = "I am a string."
count = 0

print("\nObject Data: ", obj)
print("Object Type: ", type(obj),"\n")

for method in dir(obj):
    # the end=" " at the end of the print statement, 
    # makes it printing in the same line, 4 times (count)
    print("|    {:20}".format(method), end=" ")
    count += 1
    if count == 4:
        count = 0
        print("")

希望我有所贡献:)。


1
有贡献吗?您的答案在Python 2.7.12中对我有用,所以,是的!
gsamaras

23

除了更直接的答案外,如果我不提及iPython,我也会不知所措。点击“选项卡”以查看具有自动补全功能的可用方法。

找到方法后,请尝试:

help(object.method) 

查看pydocs,方法签名等。

啊... REPL


12

如果您特别想要方法,则应使用inspect.ismethod

对于方法名称:

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)。


您不应该使用inspect.getmembers而不是dir在列表理解中使用吗?
鲍里斯

是的,那看起来更好!
paulmelnikow,

11

打开bash shell(在Ubuntu上为ctrl + alt + T)。在其中启动python3 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(           

1
当我们谈论这样的变通办法时,我将添加您还可以运行ipython,开始键入对象并按tab,它也将正常工作。没有readline的设置需要
最大科普兰

1
@MaxCoplan对于默认情况下未启用制表符补全的情况,我已在代码中添加了变通办法
Valery Ramusik

8

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

在Python可以拦截点主叫通__getattr____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中使用Easier而不是权限范式来请求宽恕


6

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

%help(object)

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

例如:

help(str)

什么是%第一个例子吗?在我的Python 2.7中不起作用。
Scorchio

@Scorchio我已经使用“%”作为提示符,而不是python >>>。您可以在运行命令之前删除%。
Paritosh Vyas

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

这应该工作:)


1

可以创建一个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']

1

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

callable(getattr(object, method))如此处已经提到的,可以检查该方法是否存在。


1

以清单为对象

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']

0

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

虽然“ 比请求更容易获得宽恕 ”无疑是Python方式,但您正在寻找的可能是:

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

0

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

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

-1

例如,如果您使用的是shell plus,则可以改用以下命令:

>> MyObject??

这样,用“ ??” 在对象之后,它将向您显示该类具有的所有属性/方法。

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.