Dicionário Python dos campos de um objeto

339

Você sabe se existe uma função interna para criar um dicionário a partir de um objeto arbitrário? Eu gostaria de fazer algo assim:

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

NOTA: Não deve incluir métodos. Apenas campos.

Julio Cesar
fonte

Respostas:

419

Observe que a melhor prática no Python 2.7 é usar classes de novo estilo (não necessárias no Python 3), ou seja,

class Foo(object):
   ...

Além disso, há uma diferença entre um 'objeto' e uma 'classe'. Para criar um dicionário a partir de um objeto arbitrário , é suficiente usá-lo __dict__. Normalmente, você declarará seus métodos no nível da classe e seus atributos no nível da instância; portanto __dict__, tudo bem. Por exemplo:

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

Uma abordagem melhor (sugerida por robert nos comentários) é a varsfunção interna :

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

Como alternativa, dependendo do que você deseja fazer, pode ser bom herdar dict. Então sua turma é um dicionário e, se você quiser, pode substituir getattre / ou setattrchamar e definir o ditado. Por exemplo:

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

    # etc...
user6868
fonte
3
O que acontece se um dos atributos de A tiver um getter personalizado? (uma função com um decorador @property)? Ainda aparece no ____dict____? Qual será o seu valor?
Zakdances
11
__dict__não funcionará se o objeto estiver usando slots (ou definido em um módulo C).
Antimony
11
Existe um equivalente desse método para os objetos de classe? IE Em vez de usar f = Foo () e executar f .__ dict__, faça diretamente Foo .__ dict__?
Chiffa
49
Desculpe, estou chegando tarde demais, mas não deveria vars(a)fazer isso? Para mim, é preferível invocar o __dict__diretamente.
robert
2
por segundo exemplo, seria melhor fazer __getattr__ = dict.__getitem__exatamente para replicar o comportamento, então você também desejaria __setattr__ = dict.__setitem__e __delattr__ = dict.__delitem__por completo.
Tadhg McDonald-Jensen
140

Em vez disso x.__dict__, é realmente mais pitônico de usar vars(x).

Berislav Lopac
fonte
3
Acordado. Observe que você também pode converter para o outro lado (dict-> class) digitando MyClass(**my_dict), assumindo que você definiu um construtor com parâmetros que espelham os atributos da classe. Não há necessidade de acessar atributos privados ou substituir o ditado.
Tvt173
2
Você pode explicar por que é mais pitônico?
Hugh W
11
Primeiro, o Python geralmente rejeita os itens dunder de chamadas diretamente, e quase sempre existe um método ou função (ou operador) para acessá-lo indiretamente. Em geral, os atributos e métodos do dunder são um detalhe de implementação, e o uso da função "wrapper" permite separar os dois. Segundo, dessa forma, você pode substituir a varsfunção e introduzir funcionalidades adicionais sem alterar o próprio objeto.
Berislav Lopac
11
Ainda falhará se sua classe usar __slots__embora.
cz
Isso está correto, e eu sempre achei que seria uma boa direção estender varspara, ou seja, retornar um equivalente __dict__para classes "com fenda". Por enquanto, ele pode ser emulado adicionando uma __dict__propriedade que retorna {x: getattr(self, x) for x in self.__slots__}(embora não tenha certeza se isso afeta o desempenho ou o comportamento).
Berislav Lopac
59

O dirbuiltin lhe dará todos os atributos do objeto, incluindo métodos especiais como __str__, __dict__e um monte de outras pessoas que você provavelmente não quer. Mas você pode fazer algo como:

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

Portanto, você pode estender isso para retornar apenas atributos de dados e não métodos, definindo sua propsfunção assim:

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.
fonte
11
Este código inclui métodos. Existe uma maneira de excluir métodos? Eu só preciso dos campos do objeto. Obrigado
Julio César
ismethodnão pega funções. Exemplo: inspect.ismethod(str.upper). inspect.isfunctionnão é muito mais útil, no entanto. Não sei como abordar isso imediatamente.
Ehtesh Choudhury
Fiz alguns ajustes para se repetir grosseiramente e ignorar todos os erros em profundidade aqui, obrigado! gist.github.com/thorsummoner/bf0142fd24974a0ced778768a33a3069
ThorSummoner
26

Eu resolvi com uma combinação de ambas as respostas:

dict((key, value) for key, value in f.__dict__.iteritems() 
    if not callable(value) and not key.startswith('__'))
Julio Cesar
fonte
Isso também funciona, mas saiba que ele fornecerá apenas os atributos definidos na instância, não na classe (como a classe Foo no seu exemplo) ...
dF.
Então, jcarrascal, é melhor envolver o código acima em uma função como props (), então você pode chamar props (f) ou props (Foo). Observe que quase sempre é melhor escrever uma função, em vez de escrever o código 'inline'.
quamrana 14/09/08
Bom, note que isso é para python2.7, para python3, re-espaço iteritems () com simplesmente items ().
Morten
E que tal staticmethod? Não é callable.
10289 Alex
16

Eu pensei que levaria algum tempo para mostrar como você pode traduzir um objeto para ditar via 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'}"

A seção principal deste código é a __iter__função

Como os comentários explicam, a primeira coisa que fazemos é pegar os itens de classe e impedir qualquer coisa que comece com '__'.

Depois de criar isso dict, você poderá usar a updatefunção dict e passar na instância __dict__.

Isso fornecerá um dicionário completo de classe + instância de membros. Agora, tudo o que resta é iterar sobre eles e gerar os retornos.

Além disso, se você planeja usar muito isso, pode criar um @iterabledecorador de 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))
Seaux
fonte
Isso irá pegar também todos os métodos, mas precisamos apenas de campos de classe + instância. Talvez dict((x, y) for x, y in KpiRow.__dict__.items() if x[:2] != '__' and not callable(y))vai resolver isso? Mas ainda pode haver staticmétodos :( #
Alex
15

Para criar um dicionário a partir de um objeto arbitrário , é suficiente usá-lo __dict__.

Isso perde atributos que o objeto herda de sua classe. Por exemplo,

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

hasattr (a, 'x') é verdadeiro, mas 'x' não aparece em um .__ dict__

recuo
fonte
Nesse caso, qual é a solução? Desde vars()que não funciona
should_be_working
@should_be_working diré a solução neste caso. Veja a outra resposta sobre isso.
Albert
8

Resposta tardia, mas prevendo a integridade e o benefício dos googlers:

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

Isso não mostrará os métodos definidos na classe, mas ainda mostrará os campos, incluindo aqueles atribuídos a lambdas ou aqueles que começam com um sublinhado duplo.

Score_Under
fonte
6

Eu acho que a maneira mais fácil é criar um atributo getitem para a classe. Se você precisa escrever para o objeto, você pode criar um personalizado setattr . Aqui está um exemplo para 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}

O dict gera os atributos dos objetos em um dicionário e o objeto de dicionário pode ser usado para obter o item que você precisa.

Radtek
fonte
Após esta resposta ainda não está claro como obter um dicionário de um objeto. Nem propriedades, mas dicionário inteiro;)
maxkoryukov
6

Uma desvantagem do uso __dict__é que é raso; não converterá nenhuma subclasse em dicionários.

Se você estiver usando Python3.5 ou superior, poderá usar jsons:

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

Se você deseja listar parte de seus atributos, substitua __dict__:

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

# Call __dict__
d = instance.__dict__()

Isso ajuda muito se você instanceobtém alguns dados de bloco grandes e deseja enviar dpara o Redis como uma fila de mensagens.

coanor
fonte
__dict__é um atributo, não um método, portanto, este exemplo altera a interface (ou seja, você precisa chamá-la como chamadora), para que não a substitua.
Berislav Lopac
0

PITÃO 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

Agora você pode usar o código acima dentro de sua própria 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() 
spattanaik75
fonte
0

vars() é ótimo, mas não funciona para objetos aninhados de objetos

Converta objetos aninhados de objetos em ditado:

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