Słownik Python z pól obiektu

344

Czy wiesz, czy istnieje wbudowana funkcja do budowania słownika z dowolnego obiektu? Chciałbym zrobić coś takiego:

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

UWAGA: Nie powinno zawierać metod. Tylko pola.

Juliusz Cezar
źródło

Odpowiedzi:

422

Zauważ, że najlepszą praktyką w Pythonie 2.7 jest używanie klas w nowym stylu (niepotrzebnych w Pythonie 3), tj

class Foo(object):
   ...

Ponadto istnieje różnica między „przedmiotem” a „klasą”. Aby zbudować słownik z dowolnego obiektu , wystarczy użyć __dict__. Zazwyczaj deklarujesz swoje metody na poziomie klasy, a atrybuty na poziomie instancji, więc __dict__powinno być dobrze. Na przykład:

>>> 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}

Lepszym podejściem (sugerowanym przez Roberta w komentarzach) jest wbudowana varsfunkcja:

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

Alternatywnie, w zależności od tego, co chcesz zrobić, warto odziedziczyć po nim dict. Zatem twoja klasa jest już słownikiem i jeśli chcesz, możesz zastąpić getattri / lub setattrzadzwonić i ustawić dyktando. Na przykład:

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

    # etc...
użytkownik6868
źródło
3
Co się stanie, jeśli jeden z atrybutów A ma niestandardowy moduł pobierający? (funkcja z dekoratorem @property)? Czy nadal pojawia się w ____dict____? Jaka będzie jego wartość?
zakdances
11
__dict__nie będzie działać, jeśli obiekt korzysta ze szczelin (lub zdefiniowanych w module C.)
Antymon
1
Czy istnieje odpowiednik tej metody dla obiektów klasy? IE Zamiast używać f = Foo (), a następnie wykonać f .__ dict__, wykonaj bezpośrednio Foo .__ dict__?
chiffa
49
Przepraszam, przychodzę tak późno, ale nie powinienem tego vars(a)robić? Dla mnie lepiej jest wywoływać __dict__bezpośrednio.
Robert
2
dla drugiego przykładu byłoby lepiej zrobić __getattr__ = dict.__getitem__dokładnie odtworzyć zachowanie, wtedy też chciałbyś __setattr__ = dict.__setitem__i __delattr__ = dict.__delitem__dla kompletności.
Tadhg McDonald-Jensen
141

Zamiast tego x.__dict__jest w rzeczywistości bardziej pythonowy w użyciu vars(x).

Berislav Lopac
źródło
3
Zgoda. Zauważ, że możesz także konwertować w drugą stronę (dict-> class), wpisując MyClass(**my_dict), zakładając, że zdefiniowałeś konstruktor z parametrami, które odzwierciedlają atrybuty klasy. Nie trzeba uzyskiwać dostępu do prywatnych atrybutów ani zastępować dyktanda.
tvt173,
2
Czy możesz wyjaśnić, dlaczego jest bardziej Pythonic?
Hugh W
1
Po pierwsze, Python generalnie unika wywołań wysyłanych bezpośrednio przez przedmioty i prawie zawsze istnieje metoda lub funkcja (lub operator), aby uzyskać do nich pośredni dostęp. Zasadniczo atrybuty i metody dundera są szczegółami implementacji, a użycie funkcji „otoki” pozwala rozdzielić je. Po drugie, w ten sposób możesz zastąpić varsfunkcję i wprowadzić dodatkową funkcjonalność bez zmiany samego obiektu.
Berislav Lopac
1
Nadal kończy się niepowodzeniem, jeśli twoja klasa używa __slots__.
cz
Zgadza się i zawsze uważałem, że dobrym kierunkiem byłoby rozszerzenie varssię, tj. Zwrócenie ekwiwalentu __dict__dla klas „szczelinowych”. Na razie można go emulować, dodając __dict__właściwość, która zwraca {x: getattr(self, x) for x in self.__slots__}(nie wiadomo jednak, czy wpływa to w jakiś sposób na wydajność lub zachowanie).
Berislav Lopac
59

dirWbudowane daje wszystkie atrybuty obiektu, w tym specjalnych metod, takich jak __str__, __dict__i cała masa innych, które prawdopodobnie nie chcą. Ale możesz zrobić coś takiego:

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

Można więc rozszerzyć tę propsfunkcję, aby zwracała tylko atrybuty danych, a nie metody, definiując swoją funkcję w następujący sposób:

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
dF.
źródło
1
Ten kod obejmuje metody. Czy istnieje sposób na wykluczenie metod? Potrzebuję tylko pól obiektu. Dzięki
Julio César,
ismethodnie łapie funkcji. Przykład: inspect.ismethod(str.upper). inspect.isfunctionnie jest jednak o wiele bardziej pomocny. Nie jestem pewien, jak podejść do tego od razu.
Ehtesh Choudhury,
Zrobiłem kilka drobnych poprawek, aby brutalnie się powtarzały i zignorowałem tutaj wszystkie błędy dogłębnie, dzięki! gist.github.com/thorsummoner/bf0142fd24974a0ced778768a33a3069
ThorSummoner
26

Rozwiązałem kombinację obu odpowiedzi:

dict((key, value) for key, value in f.__dict__.iteritems() 
    if not callable(value) and not key.startswith('__'))
Juliusz Cezar
źródło
Działa to również, ale pamiętaj, że da ci tylko atrybuty ustawione na instancji, a nie na klasie (jak w przykładzie klasa Foo) ...
dF.
Tak więc, jcarrascal, lepiej jest zawinąć powyższy kod w funkcję taką jak rekwizyty (), wtedy możesz wywołać rekwizyty (f) lub rekwizyty (Foo). Zauważ, że prawie zawsze lepiej jest pisać funkcję niż pisać kod „wbudowany”.
quamrana
Fajnie, uwaga: to dotyczy python2.7, dla iteritems () python3 zastępuje je po prostu items ().
Morten
A co staticmethod? To nie jest callable.
Alex
17

Pomyślałem, że poświęcę trochę czasu, aby pokazać, jak można przetłumaczyć obiekt, za pomocą którego można dyktować 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'}"

Kluczową sekcją tego kodu jest __iter__funkcja.

Jak wyjaśniają komentarze, pierwszą rzeczą, którą robimy, jest chwytanie przedmiotów klasy i zapobieganie czegokolwiek, co zaczyna się od „__”.

Po utworzeniu dictmożesz użyć updatefunkcji dict i przekazać instancję __dict__.

To da ci pełny słownik klasy + instancji członków. Teraz pozostaje tylko iterować nad nimi i przynosić zyski.

Ponadto, jeśli planujesz dużo tego używać, możesz stworzyć @iterabledekorator zajęć.

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))
Seaux
źródło
Spowoduje to również pobranie wszystkich metod, ale potrzebujemy tylko pól instancji klasy +. Może dict((x, y) for x, y in KpiRow.__dict__.items() if x[:2] != '__' and not callable(y))to rozwiąże? Ale wciąż mogą istnieć staticmetody :(
Alex
15

Aby zbudować słownik z dowolnego obiektu , wystarczy użyć __dict__.

Pomija to atrybuty, które obiekt dziedziczy po swojej klasie. Na przykład,

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

hasattr (a, „x”) jest prawdą, ale „x” nie pojawia się w .__ dict__

wcięcie
źródło
W takim przypadku jakie jest rozwiązanie? Ponieważ vars()nie działa
powinno być
@should_be_working dirjest rozwiązaniem w tym przypadku. Zobacz drugą odpowiedź na ten temat.
Albert
8

Późna odpowiedź, ale pod warunkiem kompletności i korzyści pracowników Google:

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

Nie wyświetli to metod zdefiniowanych w klasie, ale nadal pokaże pola, w tym te przypisane do lambdas lub te, które zaczynają się od podwójnego podkreślenia.

Score_Under
źródło
6

Myślę, że najprostszym sposobem jest utworzenie atrybutu getitem dla klasy. Jeśli chcesz pisać do obiektu, możesz utworzyć niestandardowy setattr . Oto przykład 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 generuje atrybuty obiektów do słownika, a obiektu słownika można użyć do uzyskania potrzebnego elementu.

radtek
źródło
Po tej odpowiedzi wciąż nie jest jasne, jak uzyskać słownik z obiektu. Nie właściwości, ale cały słownik;)
maxkoryukov
6

Minusem używania __dict__jest to, że jest płytka; nie przekształci żadnych podklas w słowniki.

Jeśli używasz języka Python 3.5 lub nowszego, możesz użyć jsons:

>>> import jsons
>>> jsons.dump(f)
{'bar': 'hello', 'baz': 'world'}
RH
źródło
3

Jeśli chcesz wyświetlić część swoich atrybutów, zastąp __dict__:

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

# Call __dict__
d = instance.__dict__()

To bardzo pomaga, jeśli instancedostajesz duże dane bloków i chcesz dprzesłać do Redis jak kolejka wiadomości.

coanor
źródło
__dict__jest atrybutem, a nie metodą, więc ten przykład zmienia interfejs (tzn. musisz wywołać go jako wywołanie), więc nie zastępuje go.
Berislav Lopac
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

Teraz możesz użyć powyższego kodu we własnej klasie:

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() 
spattanaik75
źródło
0

vars() jest świetny, ale nie działa dla zagnieżdżonych obiektów obiektów

Konwertuj zagnieżdżony obiekt obiektów na dyktowanie:

def to_dict(self):
    return json.loads(json.dumps(self, default=lambda o: o.__dict__))
Ricky Levi
źródło