查找Python对象的方法

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

或者,

如果这是不可能的,是否至少有一个简单的方法来检查它是否有一个特定的方法,而不是简单地检查当方法被调用时是否发生错误?

613824 次浏览

对于许多对象,你可以使用这段代码,用你感兴趣的对象替换'object':

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

我发现它在diveintopython.net(现在存档),应该提供一些进一步的细节!

# EYZ1:

getattr()不允许pandas风格的Python 3.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'])

您可以使用内置的dir()函数来获得模块的所有属性的列表。在命令行上尝试一下,看看它是如何工作的。

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

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

有关更多信息,请参阅Python自省

检查它是否有特定的方法:

hasattr(object,"method")

在更直接的答案之上,如果我没有提到IPython,那就是我的疏忽。

点击选项卡查看可用的方法,自动补全。

一旦你找到了一个方法,试试:

help(object.method)

查看pydocs、方法签名等。

啊…# EYZ0。

...除了简单地检查调用方法时是否发生错误之外,是否至少有一种简单的方法来检查它是否具有特定的方法

而“# EYZ0"当然是python的方式,你可能会寻找:

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

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

这里指出的所有方法的问题是,您不能确定一个方法不存在。

在Python中,您可以通过__getattr____getattribute__拦截点调用,从而可以创建方法"at runtime"

例子:

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中使用请求原谅比请求允许容易范式。

如果你特别想要方法,你应该使用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)。

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

没有可靠的方法可以列出所有对象的方法。dir(object)通常是有用的,但在某些情况下,它可能没有列出所有方法。根据# EYZ1文档: 带一个参数,尝试返回该对象的有效属性列表。

正如前面提到的,可以使用callable(getattr(object, method))检查该方法是否存在。

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

一个对象的属性列表

内置函数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']

打开Bash shell (Ubuntu上是Ctrl + Alt + T)。在其中启动Python 3 shell。创建一个对象来观察的方法。只需要在它后面加一个点,然后按选项卡两次,你就会看到如下内容:

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(

以列表为对象

obj = []

# EYZ0

你会得到:

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

以便在整个模块中搜索特定的方法

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

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

help(object)

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

例如:

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

这应该工作:)

例如,如果你正在使用shell plus,你可以用这个代替:

>> MyObject??

这样,带'??’就在你的对象后面,它会显示类的所有属性/方法。

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

import module_name
dir(module_name)

你也可以把一个对象传递给dir() as

dir(object_name)

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

我已经做了下面的函数(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']

# EYZ0 # EYZ1

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

print(dir(obj))

要排除魔法内置,可以这样做:

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

这里有一个很好的一行代码(但也会得到属性):

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

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

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