Dizionario Python dai campi di un oggetto


344

Sai se esiste una funzione integrata per creare un dizionario da un oggetto arbitrario? Mi piacerebbe fare qualcosa del genere:

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

NOTA: non dovrebbe includere metodi. Solo campi.

Risposte:


423

Nota che la migliore pratica in Python 2.7 è usare classi di nuovo stile (non necessarie con Python 3), cioè

class Foo(object):
   ...

Inoltre, c'è una differenza tra un 'oggetto' e una 'classe'. Per costruire un dizionario da un oggetto arbitrario , è sufficiente usarlo __dict__. Di solito, dichiarerai i tuoi metodi a livello di classe e i tuoi attributi a livello di istanza, quindi __dict__dovrebbe andare bene. Per esempio:

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

Un approccio migliore (suggerito da Robert nei commenti) è la varsfunzione integrata:

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

In alternativa, a seconda di ciò che vuoi fare, potrebbe essere bello ereditare dict. Quindi la tua classe è già un dizionario e, se lo desideri, puoi sovrascrivere getattre / o setattrchiamare e impostare il dict. Per esempio:

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

    # etc...

3
Cosa succede se uno degli attributi di A ha un getter personalizzato? (una funzione con un decoratore @property)? Viene ancora visualizzato in ____dict____? Quale sarà il suo valore?
zakdances

11
__dict__non funzionerà se l'oggetto utilizza degli slot (o definiti in un modulo C).
Antimonio

1
Esiste un equivalente di questo metodo per gli oggetti di classe? IE Invece di usare f = Foo () e quindi fare f .__ dict__, fare direttamente Foo .__ dict__?
Chiffa,

50
Scusa, arrivo tardi, ma non dovresti vars(a)farlo? Per me è preferibile invocare __dict__direttamente.
robert,

2
per il secondo esempio sarebbe meglio fare __getattr__ = dict.__getitem__esattamente la replica del comportamento, quindi si vorrebbe anche __setattr__ = dict.__setitem__e __delattr__ = dict.__delitem__per completezza.
Tadhg McDonald-Jensen,

142

Invece x.__dict__, in realtà è più pitonico da usare vars(x).


3
Concordato. Nota che puoi anche convertire l'altro modo (dict-> class) digitando MyClass(**my_dict), supponendo che tu abbia definito un costruttore con parametri che rispecchiano gli attributi della classe. Non è necessario accedere ad attributi privati ​​o sovrascrivere dict.
tvt173,

2
Puoi spiegare perché è più Pythonic?
Hugh W,

1
In primo luogo, Python generalmente evita direttamente le chiamate di oggetti di dunder, e quasi sempre c'è un metodo o una funzione (o un operatore) per accedervi indirettamente. In generale, gli attributi e i metodi di dunder sono un dettaglio di implementazione e l'utilizzo della funzione "wrapper" consente di separare i due. In secondo luogo, in questo modo è possibile ignorare la varsfunzione e introdurre funzionalità aggiuntive senza modificare l'oggetto stesso.
Berislav Lopac il

1
Non riesce comunque se la tua classe usa __slots__però.
CZ,

È corretto, e ho sempre pensato che sarebbe stata una buona direzione estendersi vars, vale a dire restituire un equivalente di __dict__per le classi "scanalate". Per ora, può essere emulato aggiungendo una __dict__proprietà che restituisce {x: getattr(self, x) for x in self.__slots__}(non sono sicuro se ciò influisca in qualche modo sulle prestazioni o sul comportamento).
Berislav Lopac,

59

Il dirbuiltin ti darà tutti gli attributi dell'oggetto, inclusi metodi speciali come __str__, __dict__e un sacco di altri che probabilmente non vuoi. Ma puoi fare qualcosa del tipo:

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

Quindi puoi estenderlo per restituire solo attributi di dati e non metodi, definendo la tua propsfunzione in questo modo:

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
Questo codice include metodi. C'è un modo per escludere i metodi? Ho solo bisogno dei campi dell'oggetto. Grazie
Julio César,

ismethodnon cattura le funzioni. Esempio: inspect.ismethod(str.upper). inspect.isfunctionnon è molto più utile, però. Non sono sicuro di come affrontarlo subito.
Ehtesh Choudhury,

Ho fatto alcune modifiche per ricorrere grossolanamente e ignorare tutti gli errori a fondo qui, grazie! gist.github.com/thorsummoner/bf0142fd24974a0ced778768a33a3069
ThorSummoner

26

Ho risolto con una combinazione di entrambe le risposte:

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

Anche questo funziona, ma tieni presente che ti darà solo gli attributi impostati sull'istanza, non sulla classe (come la classe Foo nel tuo esempio) ...
dF.

Quindi, jcarrascal, è meglio racchiudere il codice sopra in una funzione come props (), quindi puoi chiamare sia props (f) che props (Foo). Si noti che è quasi sempre meglio scrivere una funzione, piuttosto che scrivere il codice "inline".
quamrana,

Bene, btw nota che questo è per python2.7, per python3 relpace iteritems () con semplicemente items ().
Morten,

E che dire staticmethod? Non lo è callable.
Alex,

17

Ho pensato che avrei impiegato del tempo per mostrarti come puoi tradurre un oggetto da dettare tramite 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'}"

La sezione chiave di questo codice è la __iter__funzione.

Come spiegano i commenti, la prima cosa che facciamo è prendere gli oggetti Class e prevenire tutto ciò che inizia con '__'.

Dopo averlo creato dict, puoi utilizzare la updatefunzione dict e passare l'istanza __dict__.

Questi ti daranno un dizionario completo di membri di classe + istanza. Ora non resta che iterare su di essi e produrre i rendimenti.

Inoltre, se hai intenzione di usarlo molto, puoi creare un @iterabledecoratore di classe.

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

Questo afferrerà anche tutti i metodi, ma abbiamo bisogno solo dei campi di classe + istanza. Forse dict((x, y) for x, y in KpiRow.__dict__.items() if x[:2] != '__' and not callable(y))lo risolverà? Ma potrebbero esserci ancora dei staticmetodi :(
Alex

15

Per costruire un dizionario da un oggetto arbitrario , è sufficiente usarlo __dict__.

Questo manca attributi che l'oggetto eredita dalla sua classe. Per esempio,

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

hasattr (a, 'x') è vero, ma 'x' non appare in un .__ dict__


In questo caso qual è la soluzione? Dal momento vars()che non funziona
should_be_working

@should_be_working dirè la soluzione in questo caso. Vedi l'altra risposta a riguardo.
Albert,

8

Risposta tardiva ma fornita completezza e beneficio dei googler:

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

Questo non mostrerà i metodi definiti nella classe, ma mostrerà comunque i campi inclusi quelli assegnati a lambdas o quelli che iniziano con un doppio trattino basso.


6

Penso che il modo più semplice sia creare un attributo getitem per la classe. Se è necessario scrivere sull'oggetto, è possibile creare un setattr personalizzato . Ecco un esempio di 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 genera gli attributi degli oggetti in un dizionario e l'oggetto dizionario può essere utilizzato per ottenere l'elemento necessario.


Dopo questa risposta non è ancora chiaro come ottenere un dizionario da un oggetto. Non proprietà, ma intero dizionario;)
maxkoryukov

6

Un aspetto negativo dell'utilizzo __dict__è che è poco profondo; non converte alcuna sottoclasse in dizionari.

Se stai usando Python3.5 o versioni successive, puoi usare jsons:

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

3

Se vuoi elencare parte dei tuoi attributi, sovrascrivi __dict__:

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

# Call __dict__
d = instance.__dict__()

Questo aiuta molto se instanceottieni alcuni dati di blocco di grandi dimensioni e vuoi spingere dsu Redis come una coda di messaggi.


__dict__è un attributo, non un metodo, quindi questo esempio cambia l'interfaccia (cioè è necessario chiamarlo come richiamabile), quindi non lo ignora.
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

Ora puoi usare il codice sopra nella tua classe:

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() è fantastico, ma non funziona con oggetti nidificati di oggetti

Converti oggetto nidificato di oggetti in dict:

def to_dict(self):
    return json.loads(json.dumps(self, default=lambda o: o.__dict__))
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.