python - 来自对象字段的 Python 字典

Question

你知道是否有一个内置函数可以从任意对象构建字典吗？我想做这样的事情：

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

注意：它不应该包括方法。只有字段。

Answer 1

请注意，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}

更好的方法（罗伯特在评论中建议）是内置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...

Answer 2

而x.__dict__不是vars(x).

Answer 3

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

Answer 4

我已经解决了两个答案的组合：

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

Answer 5

我想我会花一些时间向您展示如何通过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))

Answer 6

要从任意对象构建字典，使用__dict__.

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

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

hasattr(a, 'x') 为真，但 'x' 没有出现在 a.__dict__ 中

Answer 7

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

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

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

Answer 8

迟到的答案，但提供了完整性和谷歌员工的利益：

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

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

Answer 9

我认为最简单的方法是为类创建一个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将对象属性生成到字典中，字典对象可用于获取您需要的项目。

Answer 10

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

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

def to_dict(self):
    return json.loads(json.dumps(self, default=lambda o: o.__dict__))

Answer 11

在 2021 年，对于嵌套对象/dicts/json，使用 pydantic BaseModel - 将嵌套 dicts 和嵌套 json 对象转换为 python 对象和 JSON，反之亦然：

https://pydantic-docs.helpmanual.io/usage/models/

>>> class Foo(BaseModel):
...     count: int
...     size: float = None
... 
>>> 
>>> class Bar(BaseModel):
...     apple = 'x'
...     banana = 'y'
... 
>>> 
>>> class Spam(BaseModel):
...     foo: Foo
...     bars: List[Bar]
... 
>>> 
>>> m = Spam(foo={'count': 4}, bars=[{'apple': 'x1'}, {'apple': 'x2'}])

对象听写

>>> print(m.dict())
{'foo': {'count': 4, 'size': None}, 'bars': [{'apple': 'x1', 'banana': 'y'}, {'apple': 'x2', 'banana': 'y'}]}

对象转 JSON

>>> print(m.json())
{"foo": {"count": 4, "size": null}, "bars": [{"apple": "x1", "banana": "y"}, {"apple": "x2", "banana": "y"}]}

口述反对

>>> spam = Spam.parse_obj({'foo': {'count': 4, 'size': None}, 'bars': [{'apple': 'x1', 'banana': 'y'}, {'apple': 'x2', 'banana': 'y2'}]})
>>> spam
Spam(foo=Foo(count=4, size=None), bars=[Bar(apple='x1', banana='y'), Bar(apple='x2', banana='y2')])

JSON 到对象

>>> spam = Spam.parse_raw('{"foo": {"count": 4, "size": null}, "bars": [{"apple": "x1", "banana": "y"}, {"apple": "x2", "banana": "y"}]}')
>>> spam
Spam(foo=Foo(count=4, size=None), bars=[Bar(apple='x1', banana='y'), Bar(apple='x2', banana='y')])

Answer 12

Python3.x

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

Answer 13

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

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

# Call __dict__
d = instance.__dict__()

如果你instance得到一些大块数据并且你想像d消息队列一样推送到 Redis，这会很有帮助。

Answer 14

正如上面的评论之一所述，vars目前还不是通用的，因为它不适用于带有__slots__而不是 normal的对象__dict__。此外，一些对象（例如，像stror之类的内置函数int）既没有a__dict__ 也没有 __slots__。

目前，一个更通用的解决方案可能是这样的：

def instance_attributes(obj: Any) -> Dict[str, Any]:
    """Get a name-to-value dictionary of instance attributes of an arbitrary object."""
    try:
        return vars(obj)
    except TypeError:
        pass

    # object doesn't have __dict__, try with __slots__
    try:
        slots = obj.__slots__
    except AttributeError:
        # doesn't have __dict__ nor __slots__, probably a builtin like str or int
        return {}
    # collect all slots attributes (some might not be present)
    attrs = {}
    for name in slots:
        try:
            attrs[name] = getattr(obj, name)
        except AttributeError:
            continue
    return attrs

例子：

class Foo:
    class_var = "spam"


class Bar:
    class_var = "eggs"
    
    __slots__ = ["a", "b"]

>>> foo = Foo()
>>> foo.a = 1
>>> foo.b = 2
>>> instance_attributes(foo)
{'a': 1, 'b': 2}

>>> bar = Bar()
>>> bar.a = 3
>>> instance_attributes(bar)
{'a': 3}

>>> instance_attributes("baz") 
{}

---

咆哮：

很遗憾，这还没有内置vars。Python 中的许多内置函数承诺是解决问题的“最佳”解决方案，但总会有几种特殊情况没有得到处理……而且无论如何最终都不得不手动编写代码。

Answer 15

蟒蛇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() 

Answer 16

尝试：

from pprint import pformat
a_dict = eval(pformat(an_obj))