Em Python o dicionário de campos de um objeto
-
09-06-2019 - |
Pergunta
Você sabe se há um built-in função a construção de um dicionário de um arbitrário objeto?Eu gostaria de fazer algo como isto:
>>> class Foo:
... bar = 'hello'
... baz = 'world'
...
>>> f = Foo()
>>> props(f)
{ 'bar' : 'hello', 'baz' : 'world' }
NOTA: Ele não deve incluir métodos.Apenas os campos.
Solução
Note que as melhores práticas em Python 2.7 é usar novo estilo classes (não é necessário com o Python 3), i.é.
class Foo(object):
...
Além disso, há uma diferença entre um 'objeto' e uma 'classe'.A construção de um dicionário de um arbitrário objeto, é suficiente o uso do __dict__
.Geralmente, você irá declarar seus métodos em nível de classe e seus atributos no nível de instância, para __dict__
deve ser fino.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 melhor abordagem (sugerido por robert nos comentários) é o grupo builtin vars
função:
>>> vars(a)
{'c': 2, 'b': 1}
Em alternativa, dependendo do que você pretende fazer, o que poderia ser bom para herdar a partir de dict
.Em seguida, a sua classe é já um dicionário, e se você quiser, pode substituir getattr
e/ou setattr
para chamar e configurar o dict.Por exemplo:
class Foo(dict):
def __init__(self):
pass
def __getattr__(self, attr):
return self[attr]
# etc...
Outras dicas
Em vez de x.__dict__
, na verdade é mais pythonic usar vars(x)
.
O dir
builtin irá dar-lhe todos os atributos do objeto, incluindo métodos especiais, como __str__
, __dict__
e um monte de outros 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' }
Então, pode estender isso para retornar somente os atributos de dados e não os métodos, pela definição de seu props
função como esta:
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
Estabeleci 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('__'))
A construção de um dicionário de um arbitrário objeto, é suficiente o uso do
__dict__
.
Este perde os atributos que o objeto herda de sua classe.Por exemplo,
class c(object):
x = 3
a = c()
hasattr(a, 'x') é verdade, mas 'x' não aparece em uma.__dict__
Eu pensei que eu ia levar algum tempo para mostrar como você pode traduzir um objeto para dict 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 chave deste código é o __iter__
função.
Como os comentários explicar, a primeira coisa que faço é pegar a Classe de itens e evitar qualquer coisa que começa com '__'.
Uma vez que você tenha criado e que dict
, e , em seguida, você pode usar o update
dict função e passar a instância __dict__
.
Estes irão dar-lhe uma classe completa+instância dicionário de membros.Agora tudo o que resta é para iterar sobre eles e sobre o rendimento o retorna.
Além disso, se você planeja usar muito isso, você pode criar uma @iterable
classe decorator.
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))
Final de resposta, mas previsto para a integralidade e o benefício de colaboradores:
def props(x):
return dict((key, getattr(x, key)) for key in dir(x) if key not in dir(x.__class__))
Isto não irá mostrar métodos definidos na classe, mas ainda vai mostrar campos, incluindo aqueles atribuídos a lambdas ou aqueles que começam com um sublinhado duplo.
Eu acho que a maneira mais fácil é criar um getitem atributo 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}
dict gera os atributos de objetos em um dicionário e dicionário de objeto pode ser usado para obter o item que você precisa.
Se você quiser listar parte de seus atributos, substituir __dict__
:
def __dict__(self):
d = {
'attr_1' : self.attr_1,
...
}
return d
# Call __dict__
d = instance.__dict__()
Isso ajuda muito se o seu instance
obter algum grande bloco de dados e você quer empurrar d
para Redis, como fila de mensagens.
Uma desvantagem de utilizar __dict__
é que ele é superficial;ele não vai converter qualquer subclasses para os dicionários.
Se você estiver usando Python3.5 ou superior, você pode usar jsons
:
>>> import jsons
>>> jsons.dump(f)
{'bar': 'hello', 'baz': 'world'}
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
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()