列出对象的属性


329

有没有办法获取类实例上存在的属性列表?

class new_class():
    def __init__(self, number):
        self.multi = int(number) * 2
        self.str = str(number)

a = new_class(2)
print(', '.join(a.SOMETHING))

理想的结果是将输出“ multi,str”。我希望它可以查看脚本各个部分的当前属性。


75
实际上,Python中的每个人都将自己的类命名为NewClass。如果使用诸如的命名约定,则可能会违反人们的期望new_class
Mike Graham

即使它是人机交互的,并且不能以编程方式使用,help()函数也有助于获取有关类,函数,内建函数,模块等的信息
ytpillai


为什么没有一个答案都标记为“已接受”?
pfabri

Answers:


295
>>> class new_class():
...   def __init__(self, number):
...     self.multi = int(number) * 2
...     self.str = str(number)
... 
>>> a = new_class(2)
>>> a.__dict__
{'multi': 4, 'str': '2'}
>>> a.__dict__.keys()
dict_keys(['multi', 'str'])

您可能还会发现pprint有帮助。


29
dict用法的问题刚刚出现在r / python上。有人指出vars(a)等同于a .__ dict__
David

5
如果有人怀疑,它也可以在Python 2.7上运行
Ben Mordecai

8
具体来说,pprint.pprint(a.__dict__)在属性上进行漂亮打印。
smci 2016年

1
绝对pprint不能在Python 2.6上使用。
约翰·格林

3
请注意,这仅适用于用户定义的类,不适用于内置或扩展类型。
ivan_pozdeev

173
dir(instance)
# or (same value)
instance.__dir__()
# or
instance.__dict__

然后,您可以测试的类型type()或的方法callable()


dir在具有重载属性get / set的类上工作得更好
ogurets

dir(instance)列出了许多您可能不感兴趣的东西
jciloa

这是使我获得bostonsklearn数据集上所有可用属性的唯一函数- __dict__为空,而实际上有5个可用属性
Coruscate5


52

先前的所有答案都是正确的,您可以根据自己的需求选择三种方式

  1. dir()

  2. vars()

  3. __dict__

>>> dir(a)
['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'multi', 'str']
>>> vars(a)
{'multi': 4, 'str': '2'}
>>> a.__dict__
{'multi': 4, 'str': '2'}

1
vars(foo)返回foo.__dict__
鲍里斯

32
>>> ', '.join(i for i in dir(a) if not i.startswith('__'))
'multi, str'

当然,这将打印类定义中的所有方法或属性。您可以通过更改i.startwith('__')为排除“私有”方法i.startwith('_')


24

检查模块提供了简便的方法来检查的对象:

检查模块提供了几个有用的功能,以帮助获取有关活动对象的信息,例如模块,类,方法,函数,回溯,框架对象和代码对象。


使用,getmembers()您可以查看类的所有属性及其值。要排除私有或受保护的属性,请使用.startswith('_')。要排除方法或功能,请使用inspect.ismethod()inspect.isfunction()

import inspect


class NewClass(object):
    def __init__(self, number):
        self.multi = int(number) * 2
        self.str = str(number)

    def func_1(self):
        pass


a = NewClass(2)

for i in inspect.getmembers(a):
    # Ignores anything starting with underscore 
    # (that is, private and protected attributes)
    if not i[0].startswith('_'):
        # Ignores methods
        if not inspect.ismethod(i[1]):
            print(i)

请注意,由于第一个ismethod()元素i只是一个字符串(其名称),因此它用于第二个元素。

主题:使用CamelCase作为类名。


13

您可以dir(your_object)用来获取属性和getattr(your_object, your_object_attr)获取值

用法:

for att in dir(your_object):
    print (att, getattr(your_object,att))

如果您的对象没有__dict__,这将特别有用。如果不是这种情况,您也可以尝试var(your_object)


11

人们经常提到要列出完整的属性列表,您应该使用dir()。但是请注意,与普遍看法相反,这dir()并不能体现所有属性。例如,即使您可以从类本身访问它,您也可能会注意到__name__dir()列表中可能缺少该类。从dir()Python 2Python 3)的文档中:

因为dir()的主要提供是为了方便在交互式提示符下使用,所以它尝试提供一组有趣的名称,而不是尝试提供一组严格或一致定义的名称,并且其详细行为可能会因版本而异。例如,当参数是类时,元类属性不在结果列表中。

像下图的功能更趋于完善,虽然有因为返回的列表中没有完整的担保dir()可以由许多因素,包括实施的影响的__dir__()方法,或自定义__getattr__()__getattribute__()对类或它的某个父。有关更多详细信息,请参见提供的链接。

def dirmore(instance):
    visible = dir(instance)
    visible += [a for a in set(dir(type)).difference(visible)
                if hasattr(instance, a)]
    return sorted(visible)

9

你要干嘛 在不知道确切意图的情况下,可能很难获得最佳答案。

  • 如果要以特定的方式显示类的实例,几乎总是最好手动进行此操作。这将完全包括您想要的内容,而不包括您不需要的内容,并且顺序是可以预测的。

    如果您正在寻找一种显示类内容的方法,请手动设置您关心的属性的格式,并将其作为类的__str__or __repr__方法提供。

  • 如果要了解对象存在哪些方法等,以了解其工作原理,请使用helphelp(a)将根据对象的文档字符串显示有关该对象的类的格式化输出。

  • dir存在以编程方式获取对象的所有属性。(访问__dict__将执行与我相同的操作,但不会使用我自己。)但是,这可能不包括您想要的东西,也可能包括您不想要的东西。它是不可靠的,人们认为他们想要的次数比他们想要的要多得多。

  • 有点正交,目前对Python 3的支持很少。如果您对编写真正的软件感兴趣,那么您将需要第三方产品,例如numpy,lxml,Twisted,PIL或任何数量的尚不支持Python 3并且没有计划很快的计划的Web框架。2.6和3.x分支之间的差异很小,但是库支持方面的差异很大。


4
我只想指出,五年后(现在),我相信您提到的所有第三方模块都支持python3。资料来源:python3wos.appspot.com
pzkpfw 2015年

8

有多种方法可以做到这一点:

#! /usr/bin/env python3
#
# This demonstrates how to pick the attiributes of an object

class C(object) :

  def __init__ (self, name="q" ):
    self.q = name
    self.m = "y?"

c = C()

print ( dir(c) )

运行时,此代码将产生:

jeffs@jeff-desktop:~/skyset$ python3 attributes.py 
['__class__', '__delattr__', '__dict__', '__dir__', '__doc__',      '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'm', 'q']

jeffs@jeff-desktop:~/skyset$

2
为什么这个答案被否决了?出于调试目的,dir工作得很好!
Dunatotatos

Pretty可与Python 2.7.x一起使用。正是我想要的。
Davidson Lima

7

请查看按顺序执行的python shell脚本,在这里您将获得以字符串格式(用逗号分隔)的类的属性。

>>> class new_class():
...     def __init__(self, number):
...         self.multi = int(number)*2
...         self.str = str(number)
... 
>>> a = new_class(4)
>>> ",".join(a.__dict__.keys())
'str,multi'<br/>

我正在使用python 3.4


而且,如果您只希望列表可以使用a.__dict__.keys()。但是,如果您想知道某个对象是否具有特定的属性,可以使用hasattr
berna1111

4

除了这些答案之外,我还将包括一个函数(python 3),用于生成几乎所有值的整个结构。它用于dir建立属性名称的完整列表,然后getattr与每个名称一起使用。它显示值的每个成员的类型,并在可能的情况下还显示整个成员:

import json

def get_info(obj):

  type_name = type(obj).__name__
  print('Value is of type {}!'.format(type_name))
  prop_names = dir(obj)

  for prop_name in prop_names:
    prop_val = getattr(obj, prop_name)
    prop_val_type_name = type(prop_val).__name__
    print('{} has property "{}" of type "{}"'.format(type_name, prop_name, prop_val_type_name))

    try:
      val_as_str = json.dumps([ prop_val ], indent=2)[1:-1]
      print('  Here\'s the {} value: {}'.format(prop_name, val_as_str))
    except:
      pass

现在,以下任何一项都应提供洞察力:

get_info(None)
get_info('hello')

import numpy
get_info(numpy)
# ... etc.

哇,那是宝石!
pfabri

是的,这是一个救命稻草。无法弄清楚为什么我不能轻易解压缩这些列表,并确保足够的类型具有类型为“ tuple”的属性“ slot ”。这是slot的值:[“ nsname”,“ hostmaster”,“ serial”,“ refresh”, “重试”,“到期”,“ minttl”,“ ttl”]
Mik R

3

获取对象的属性

class new_class():
    def __init__(self, number):
    self.multi = int(number) * 2
    self.str = str(number)

new_object = new_class(2)                
print(dir(new_object))                   #total list attributes of new_object
attr_value = new_object.__dict__         
print(attr_value)                        #Dictionary of attribute and value for new_class                   

for attr in attr_value:                  #attributes on  new_class
    print(attr)

输出量

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__','__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'multi', 'str']

{'multi': 4, 'str': '2'}

multi
str

1

如前所述,使用obj.__dict__可以处理常见情况,但是某些类没有__dict__属性和使用__slots__(主要是为了提高内存效率)。

更具弹性的方法示例:

class A(object):
    __slots__ = ('x', 'y', )
    def __init__(self, x, y):
        self.x = x
        self.y = y


class B(object):
    def __init__(self, x, y):
        self.x = x
        self.y = y


def get_object_attrs(obj):
    try:
        return obj.__dict__
    except AttributeError:
        return {attr: getattr(obj, attr) for attr in obj.__slots__}


a = A(1,2)
b = B(1,2)
assert not hasattr(a, '__dict__')

print(get_object_attrs(a))
print(get_object_attrs(b))

此代码的输出:

{'x': 1, 'y': 2}
{'x': 1, 'y': 2}

注意1:
Python是一种动态语言,因此最好还是了解试图从中获取属性的类,因为即使这段代码也可能会丢失某些情况。

注意2:
此代码仅输出实例变量,这意味着未提供类变量。例如:

class A(object):
    url = 'http://stackoverflow.com'
    def __init__(self, path):
        self.path = path

print(A('/questions').__dict__)

代码输出:

{'path': '/questions'}

此代码不会显示urlclass属性,并且可能会省略所需的class属性。
有时,我们可能会认为属性是实例成员,但并非如此,因此在本示例中不会显示。


2
一个类可以具有__dict__ __slots__,因此您可能想尝试两者而不是仅尝试dict。
cz

1
  • 使用__dict__vars 不起作用,因为它错过了__slots__
  • 使用__dict____slots__ 不起作用,因为它错过了__slots__基类。
  • 使用dir 不起作用,因为它包括类属性(例如方法或属性)以及对象属性。
  • 使用vars等同于使用__dict__

这是我最好的:

from typing import Dict

def get_attrs( x : object ) -> Dict[str, object]:
    mro      = type( x ).mro()
    attrs    = { }
    has_dict = False
    sentinel = object()

    for klass in mro:
        for slot in getattr( klass, "__slots__", () ):
            v = getattr( x, slot, sentinel )

            if v is sentinel:
                continue

            if slot == "__dict__":
                assert not has_dict, "Multiple __dicts__?"
                attrs.update( v )
                has_dict = True
            else:
                attrs[slot] = v

    if not has_dict:
        attrs.update( getattr( x, "__dict__", { } ) )

    return attrs

让我们将此函数应用于简单的类:类C:def __init __(self):print(“ created”)i = 42为什么您的代码为此类提供空列表?(我的意思是如果o = C()然后get_attrs(O)是空的)还没有为get_attrs( “myStr的”)
GED

0
attributes_list = [attribute for attribute in dir(obj) if attribute[0].islower()]

它不适用于以大写字母或单个下划线开头的类属性名称。
fviktor

0

请按顺序查看以下Python Shell脚本执行,它将提供从创建类到提取实例的字段名称的解决方案。

>>> class Details:
...       def __init__(self,name,age):
...           self.name=name
...           self.age =age
...       def show_details(self):
...           if self.name:
...              print "Name : ",self.name
...           else:
...              print "Name : ","_"
...           if self.age:
...              if self.age>0:
...                 print "Age  : ",self.age
...              else:
...                 print "Age can't be -ve"
...           else:
...              print "Age  : ","_"
... 
>>> my_details = Details("Rishikesh",24)
>>> 
>>> print my_details
<__main__.Details instance at 0x10e2e77e8>
>>> 
>>> print my_details.name
Rishikesh
>>> print my_details.age
24
>>> 
>>> my_details.show_details()
Name :  Rishikesh
Age  :  24
>>> 
>>> person1 = Details("",34)
>>> person1.name
''
>>> person1.age
34
>>> person1.show_details
<bound method Details.show_details of <__main__.Details instance at 0x10e2e7758>>
>>> 
>>> person1.show_details()
Name :  _
Age  :  34
>>>
>>> person2 = Details("Rob Pike",0)
>>> person2.name
'Rob Pike'
>>> 
>>> person2.age
0
>>> 
>>> person2.show_details()
Name :  Rob Pike
Age  :  _
>>> 
>>> person3 = Details("Rob Pike",-45)
>>> 
>>> person3.name
'Rob Pike'
>>> 
>>> person3.age
-45
>>> 
>>> person3.show_details()
Name :  Rob Pike
Age can't be -ve
>>>
>>> person3.__dict__
{'age': -45, 'name': 'Rob Pike'}
>>>
>>> person3.__dict__.keys()
['age', 'name']
>>>
>>> person3.__dict__.values()
[-45, 'Rob Pike']
>>>

我们还可以检查每个属性的可调用性。请访问stackoverflow.com/questions/1398022/…–
hygull

-4

__attr__ 给出实例的属性列表。

>>> import requests
>>> r=requests.get('http://www.google.com')
>>> r.__attrs__
['_content', 'status_code', 'headers', 'url', 'history', 'encoding', 'reason', 'cookies', 'elapsed', 'request']
>>> r.url
'http://www.google.com/'
>>>

并不总是有效。另外,您可以__attr__在说明__attrs__中编写代码,但可以在代码中使用。两者都不适合我(werkzeug.datastructures.FileStorage)
乔纳斯
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.