查找Python对象具有的方法

时间:2008-08-29 15:05:17

标签: python introspection

给定一个任何类型的Python对象,是否有一种简单的方法来获取该对象具有的所有方法的列表?

或者,

如果这是不可能的,除了简单地检查调用方法时是否发生错误之外,是否至少有一种简单的方法来检查它是否有特定的方法?

21 个答案:

答案 0 :(得分:427)

您似乎可以使用此代码,将“对象”替换为您感兴趣的对象:

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

我在this site发现了它。希望这应该提供更多细节!

答案 1 :(得分:185)

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

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

此外,您可以使用hasattr(module_name, "attr_name")函数查明某个模块是否具有特定属性。

有关详细信息,请参阅Guide to Python introspection

答案 2 :(得分:63)

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

答案 3 :(得分:30)

检查是否有特定方法:

hasattr(object,"method")

答案 4 :(得分:27)

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

  

来自对象的属性列表

我谦虚地认为,内置函数dir()可以为您完成这项工作。取自Python Shell上的help(dir)输出:

  

DIR(...)

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("")

希望我有所贡献:)。

答案 5 :(得分:24)

除了更直接的答案之外,如果我没有提及iPython,我会失职。 点击“标签”以查看可用的方法,并使用自动完成功能。

一旦找到方法,请尝试:

help(object.method) 

查看pydocs,方法签名等

啊...... REPL

答案 6 :(得分: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)。

答案 7 :(得分:10)

打开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(           

答案 8 :(得分:7)

此处指出的所有方法的问题是您可以确定方法不存在。

在Python中,你可以拦截通过__getattr____getattribute__调用的点,从而可以在运行时创建方法&#34;

例:

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 to ask for forgiveness than permission范例的原因。

答案 9 :(得分:6)

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

%help(object)

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

例如:

help(str)

答案 10 :(得分:2)

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

答案 11 :(得分:2)

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

检查该方法是否存在可以由callable(getattr(object, method))完成,如前所述。

答案 12 :(得分:1)

  

...至少有一种简单的方法来检查它是否有一个特定的方法,而不仅仅是检查方法被调用时是否发生错误

虽然“Easier to ask for forgiveness than permission”肯定是Pythonic方式,但您所寻找的可能是:

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

答案 13 :(得分:1)

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

>> ls -a | xargs -P4  du -sm

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

import module_name
dir(module_name)

如果对象是int,str等预定义类的对象,它将在其中显示方法(您可能知道这些方法是内置函数)。如果该对象是为用户定义的类创建的,则它将显示该类中给定的所有方法。

答案 14 :(得分:1)

假设我们有一个Python obj。然后查看它拥有的所有方法,包括被__magic methods)包围的方法:

print(dir(obj))

要仅查看可通过infix(点)表示法使用的方法,可以使用以下方法:

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

答案 15 :(得分:0)

将列表作为对象

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

答案 16 :(得分:0)

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

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

答案 17 :(得分:0)

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

这应该可以工作:)

答案 18 :(得分:0)

我已完成以下函数(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列表中,如果它是{{1 }}。


演示

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

有关代码的更干净版本: https://github.com/revliscano/utilities/blob/master/get_object_functions/object_functions_getter.py

答案 19 :(得分:0)

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

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

答案 20 :(得分:-1)

例如,如果您使用的是shell加号,则可以改用以下方式:

>> MyObject??

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