来自对象字段的Python字典


339

您是否知道是否有内置函数可以从任意对象构建字典?我想做这样的事情:

>>> class Foo:
...     bar = 'hello'
...     baz = 'world'
...
>>> f = Foo()
>>> props(f)
{ 'bar' : 'hello', 'baz' : 'world' }

注意:它不应包含方法。仅字段。

Answers:


419

请注意,Python 2.7中的最佳实践是使用新型类(Python 3不需要),即

class Foo(object):
   ...

同样,“对象”和“类”之间也存在差异。要从任意对象构建字典,只需使用即可__dict__。通常,您将在类级别声明您的方法,并在实例级别声明您的属性,因此__dict__应该没问题。例如:

>>> class A(object):
...   def __init__(self):
...     self.b = 1
...     self.c = 2
...   def do_nothing(self):
...     pass
...
>>> a = A()
>>> a.__dict__
{'c': 2, 'b': 1}

更好的方法(由robert建议在注释中使用)是内置vars函数:

>>> vars(a)
{'c': 2, 'b': 1}

另外,根据您要执行的操作,最好继承自dict。然后,您的班级已经是字典,并且如果您愿意,可以覆盖getattr和/或setattr调用并设置字典。例如:

class Foo(dict):
    def __init__(self):
        pass
    def __getattr__(self, attr):
        return self[attr]

    # etc...

3
如果A的一个属性具有自定义吸气剂会发生什么?(带有@property装饰器的函数)?它仍然显示在____dict____吗?它的价值是什么?
zakdances

11
__dict__如果对象使用插槽(或在C模块中定义),将无法正常工作。

1
类对象有与该方法等效的方法吗?IE而不是直接使用f = Foo()然后执行f .__ dict__,而是直接执行Foo .__ dict__?
chiffa

49
抱歉,我来晚了,但是不应该这样vars(a)做吗?对我来说,最好__dict__直接调用Direct 。
罗伯特

2
对于第二个例子会更好做__getattr__ = dict.__getitem__精确复制行为,那么你也想__setattr__ = dict.__setitem____delattr__ = dict.__delitem__完整的烦躁。
塔德格·麦克唐纳·詹森

140

取而代之的是x.__dict__,它实际上更具有Pythonic的用法vars(x)


3
同意 注意,也可以通过键入来转换另一种方式(dict-> class),前提是MyClass(**my_dict)您定义了一个构造函数,该构造函数的参数反映了类属性。无需访问私有属性或覆盖dict。
tvt173

2
您能解释一下为什么它更Pythonic吗?
休W

1
首先,Python通常避免直接调用dunder项目,几乎总是有一种方法或函数(或运算符)来间接访问它。通常,dunder属性和方法是实现细节,使用“包装器”功能可以将两者分开。其次,通过这种方式,您可以覆盖vars功能并引入其他功能,而无需更改对象本身。
Berislav Lopac '19

1
如果您的班级仍然使用它,它仍然会失败__slots__
cz

没错,我一直认为这是一个很好的方向vars,即扩展到__dict__“ slotted”类的等效项。目前,可以通过添加__dict__返回的属性来模拟它{x: getattr(self, x) for x in self.__slots__}(不确定是否会以任何方式影响性能或行为)。
贝里斯拉夫·洛帕克

59

dir内置会给你对象的所有属性,包括特殊的方法,如__str____dict__和一大堆人,你可能不希望的。但是您可以执行以下操作:

>>> class Foo(object):
...     bar = 'hello'
...     baz = 'world'
...
>>> f = Foo()
>>> [name for name in dir(f) if not name.startswith('__')]
[ 'bar', 'baz' ]
>>> dict((name, getattr(f, name)) for name in dir(f) if not name.startswith('__')) 
{ 'bar': 'hello', 'baz': 'world' }

因此可以通过定义如下props函数将其扩展为仅返回数据属性而不是方法:

import inspect

def props(obj):
    pr = {}
    for name in dir(obj):
        value = getattr(obj, name)
        if not name.startswith('__') and not inspect.ismethod(value):
            pr[name] = value
    return pr

1
此代码包括方法。有没有办法排除方法?我只需要对象的字段。谢谢
JulioCésar08年

ismethod无法捕获功能。范例:inspect.ismethod(str.upper)inspect.isfunction并没有多大帮助。不确定如何立即解决此问题。
Ehtesh Choudhury 2013年

我做了一些调整以粗略地重复出现,并在这里忽略了所有错误,谢谢!gist.github.com/thorsummoner/bf0142fd24974a0ced778768a33a3069
ThorSummoner

26

我已经结合了两个答案:

dict((key, value) for key, value in f.__dict__.iteritems() 
    if not callable(value) and not key.startswith('__'))

这也可行,但要注意,它只会为您提供在实例上设置的属性,而不是在类(例如您的示例中的Foo类)上设置的属性...
dF。

因此,jcarrascal最好将以上代码包装在像props()这样的函数中,然后可以调用props(f)或props(Foo)。请注意,与编写“内联”代码相比,编写函数几乎总是更好。
quamrana

不错,顺便说一句,注意这是针对python2.7的,适用于仅带有items()的python3 relpace iteritems()。
莫滕

那又如何staticmethod呢?不是callable
亚历克斯

16

我以为我会花些时间向您展示如何通过转换对象来决定字典dict(obj)

class A(object):
    d = '4'
    e = '5'
    f = '6'

    def __init__(self):
        self.a = '1'
        self.b = '2'
        self.c = '3'

    def __iter__(self):
        # first start by grabbing the Class items
        iters = dict((x,y) for x,y in A.__dict__.items() if x[:2] != '__')

        # then update the class items with the instance items
        iters.update(self.__dict__)

        # now 'yield' through the items
        for x,y in iters.items():
            yield x,y

a = A()
print(dict(a)) 
# prints "{'a': '1', 'c': '3', 'b': '2', 'e': '5', 'd': '4', 'f': '6'}"

此代码的关键部分是 __iter__功能。

正如评论所解释的,我们要做的第一件事是获取Class项,并防止以'__'开头的任何东西。

一旦创建了它dict,就可以使用updatedict函数并传入实例__dict__

这些将为您提供完整的成员类+实例字典。现在剩下的就是迭代它们并产生回报。

另外,如果您打算大量使用它,则可以创建一个@iterable类装饰器。

def iterable(cls):
    def iterfn(self):
        iters = dict((x,y) for x,y in cls.__dict__.items() if x[:2] != '__')
        iters.update(self.__dict__)

        for x,y in iters.items():
            yield x,y

    cls.__iter__ = iterfn
    return cls

@iterable
class B(object):
    d = 'd'
    e = 'e'
    f = 'f'

    def __init__(self):
        self.a = 'a'
        self.b = 'b'
        self.c = 'c'

b = B()
print(dict(b))

这也将获取所有方法,但是我们只需要class + instance字段。也许dict((x, y) for x, y in KpiRow.__dict__.items() if x[:2] != '__' and not callable(y))会解决吗?但是仍然可能有static方法:(
Alex

15

要从任意对象构建字典,只需使用即可__dict__

这会错过对象从其类继承的属性。例如,

class c(object):
    x = 3
a = c()

hasattr(a,'x')是true,但是'x'不会出现在a .__ dict__


在这种情况下,解决方案是什么?既然vars()行不通
should_be_working

dir在这种情况下,@ should_be_working 是解决方案。有关此问题,请参阅其他答案。
艾伯特

8

答案较晚,但提供了完整性和对Google员工的好处:

def props(x):
    return dict((key, getattr(x, key)) for key in dir(x) if key not in dir(x.__class__))

这不会显示在类中定义的方法,但仍会显示字段,包括分配给lambda的字段或以双下划线开头的字段。


6

我认为最简单的方法是为该类创建一个getitem属性。如果需要写入对象,则可以创建一个自定义setattr。这是getitem的示例:

class A(object):
    def __init__(self):
        self.b = 1
        self.c = 2
    def __getitem__(self, item):
        return self.__dict__[item]

# Usage: 
a = A()
a.__getitem__('b')  # Outputs 1
a.__dict__  # Outputs {'c': 2, 'b': 1}
vars(a)  # Outputs {'c': 2, 'b': 1}

dict将对象属性生成到字典中,并且字典对象可用于获取所需的项目。


在此答案之后,仍不清楚如何从对象获取字典。不是属性,而是整个字典;)
maxkoryukov

6

使用的缺点 __dict__是它很浅。它不会将任何子类转换为字典。

如果您使用的是Python3.5或更高版本,则可以使用jsons

>>> import jsons
>>> jsons.dump(f)
{'bar': 'hello', 'baz': 'world'}

3

如果要列出部分属性,请覆盖__dict__

def __dict__(self):
    d = {
    'attr_1' : self.attr_1,
    ...
    }
    return d

# Call __dict__
d = instance.__dict__()

如果您instance获得了一些大块数据,并且想要d像消息队列一样推送到Redis ,这将很有帮助。


__dict__是一个属性,而不是一个方法,因此此示例更改了接口(即,您需要将其称为可调用对象),因此不会覆盖它。
贝里斯拉夫

0

PYTHON 3:

class DateTimeDecoder(json.JSONDecoder):

   def __init__(self, *args, **kargs):
        JSONDecoder.__init__(self, object_hook=self.dict_to_object,
                         *args, **kargs)

   def dict_to_object(self, d):
       if '__type__' not in d:
          return d

       type = d.pop('__type__')
       try:
          dateobj = datetime(**d)
          return dateobj
       except:
          d['__type__'] = type
          return d

def json_default_format(value):
    try:
        if isinstance(value, datetime):
            return {
                '__type__': 'datetime',
                'year': value.year,
                'month': value.month,
                'day': value.day,
                'hour': value.hour,
                'minute': value.minute,
                'second': value.second,
                'microsecond': value.microsecond,
            }
        if isinstance(value, decimal.Decimal):
            return float(value)
        if isinstance(value, Enum):
            return value.name
        else:
            return vars(value)
    except Exception as e:
        raise ValueError

现在,您可以在自己的类中使用上述代码:

class Foo():
  def toJSON(self):
        return json.loads(
            json.dumps(self, sort_keys=True, indent=4, separators=(',', ': '), default=json_default_format), cls=DateTimeDecoder)


Foo().toJSON() 

0

vars() 很棒,但是不适用于对象的嵌套对象

将对象的嵌套对象转换为dict:

def to_dict(self):
    return json.loads(json.dumps(self, default=lambda o: o.__dict__))
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.