Словник Python з полів об’єкта


344

Чи знаєте ви, чи є вбудована функція побудови словника з довільного об’єкта? Я хотів би зробити щось подібне:

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

ПРИМІТКА. Він не повинен включати методи. Тільки поля.

Відповіді:


422

Зауважте, що найкращою практикою в 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...

3
Що станеться, якщо в одному з атрибутів A є власний користувач? (функція з декоратором @property)? Чи все ще відображається в ____dict____? Якою буде його цінність?
zakdances

11
__dict__не працюватиме, якщо об’єкт використовує слоти (або визначені в модулі C).
Сурма

1
Чи існує еквівалент цього методу для об’єктів класу? IE Замість використання f = Foo (), а потім робити f .__ dict__, зробіть безпосередньо Foo .__ dict__?
chiffa

49
Вибачте, я приходжу до цього пізно, але не варто vars(a)цього робити? Для мене краще звернутися __dict__безпосередньо.
Роберт

2
для другого прикладу було б краще зробити, __getattr__ = dict.__getitem__щоб точно повторити поведінку, тоді ви також хотіли б __setattr__ = dict.__setitem__і __delattr__ = dict.__delitem__для повноти.
Tadhg McDonald-Jensen

141

Замість x.__dict__цього насправді використовувати більше пітонічно vars(x).


3
Домовились. Зауважте, що ви також можете конвертувати інший спосіб (клас dict->), ввівши MyClass(**my_dict), припустивши, що ви визначили конструктор з параметрами, які відображають атрибути класу. Не потрібно отримувати доступ до приватних атрибутів або переосмислювати дікт.
tvt173

2
Чи можете ви пояснити, чому це більше піфонічне?
Х'ю Ш

1
По-перше, Python, як правило, прямо уникає виклику даних, що надходять із документа, і майже завжди існує метод або функція (або оператор), щоб отримати доступ до них побічно. Загалом, атрибути і методи атрибутів є деталізацією реалізації, а використання функції "обгортки" дозволяє розділити два. По-друге, таким чином ви можете змінити varsфункцію та ввести додаткову функціональність, не змінюючи сам об’єкт.
Берислав

1
Він все ще не працює, якщо ваш клас використовує, __slots__хоча.
cz

Це правильно, і я завжди вважав, що було б вдалим напрямком поширитись vars, тобто повернути еквівалент __dict__для "щілинних" класів. Наразі це можна імітувати, додавши __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
Цей код включає методи. Чи є спосіб виключити методи? Мені потрібні лише поля об’єкта. Дякую
Хуліо Сесар

ismethodне вловлює функції. Приклад: inspect.ismethod(str.upper). inspect.isfunctionХоча це не набагато корисніше. Не впевнений, як відразу підійти до цього.
Ehtesh Choudhury

Я зробив кілька перетворень, щоб грубо повторюватися і ігнорувати всі помилки на глибину тут, дякую! 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, вам краще вписати вищезазначений код у функцію, як реквізит (), тоді ви можете викликати або реквізит (f), або реквізит (Foo). Зауважте, що вам майже завжди краще писати функцію, а не писати "вбудований" код.
quamrana

Приємно, до уваги, це для python2.7, для python3 relpace iteritems () з просто елементами ().
Morten

А про що staticmethod? Це не так callable.
Олексій

17

Я подумав, що мені знадобиться трохи часу, щоб показати вам, як ви можете перевести об'єкт на диктування через 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__функція.

Як пояснюється в коментарях, перше, що ми робимо - це захопити елементи класу і запобігти тому, що починається з '__'.

Після того, як ви створили це 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 +. Може, dict((x, y) for x, y in KpiRow.__dict__.items() if x[:2] != '__' and not callable(y))це вирішить? Але ще можуть бути staticметоди :(
Олексій

15

Для побудови словника з довільного об’єкта достатньо використовувати __dict__.

При цьому пропускаються атрибути, які об'єкт успадковує від свого класу. Наприклад,

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

hasattr (a, 'x') вірно, але "x" не відображається у .__ dict__


У цьому випадку яке рішення? Оскільки vars()не працює
слід_be_working

@should_be_working dir- це рішення в цьому випадку. Дивіться іншу відповідь про це.
Альберт

8

Пізня відповідь, але передбачала повноту та користь Google:

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

Це не відображатиме методи, визначені в класі, але все одно відображатиме поля, включаючи ті, які призначені лямбдам або ті, які починаються з подвійним підкресленням.


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

ПІТОН 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() чудово, але не працює для вкладених об'єктів об'єктів

Перетворити вкладений об'єкт для диктування:

def to_dict(self):
    return json.loads(json.dumps(self, default=lambda o: o.__dict__))
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.