Como converter JSON para objeto Python
Python's json
biblioteca possui muitos utilitários para codificação e decodificação de dados no formato JSON. Em particular, o json.load()
método decodifica um JSON lido como um arquivo, e o json.loads()
decodificar um JSON lido como uma string. Em geral, ao decodificar arquivos JSON, os dados são convertidos em dicionários Python, mas é possível convertê-los em um objeto personalizado usando o parâmetro object_hook
.
Por exemplo, suponha que você tenha o seguinte objeto JSON:
json_obj = """{
"name" : "Felipe",
"email" : "[email protected]",
"age" : 29
}"""
e a seguinte classe:
class User():
name : str
email : str
age : int
def __init__(self, input):
self.name = input.get("name")
self.email = input.get("email")
self.age = input.get("age")
Se ligarmos json.loads()
de User
como o object_hook
parâmetro, o User.__init__()
método será chamado com o JSON correspondente dict
como entrada.
import json
user = json.loads(json_obj, object_hook = User)
print(f"User {user.name}, age {user.age}, email {user.email}")
User Felipe, age 29, email [email protected]
Mas e se você tiver um JSON aninhado?
json.loads()
na verdade chama o object_hook
funciona sempre que lê um objeto JSON totalmente formado da string. Considere o seguinte JSON, retornado do API geradora de usuários aleatórios
json_obj = """{
"gender": "male",
"name": {
"title": "Mr",
"first": "Ian",
"last": "Walters"
},
"location": {
"street": {
"number": 3161,
"name": "Saddle Dr"
},
"city": "Bendigo",
"state": "Western Australia",
"country": "Australia",
"postcode": 4285,
"coordinates": {
"latitude": "-84.7903",
"longitude": "-29.1020"
},
"timezone": {
"offset": "+9:00",
"description": "Tokyo, Seoul, Osaka, Sapporo, Yakutsk"
}
},
"email": "[email protected]",
"login": {
"uuid": "6ee5b2e8-01c3-4314-8f7f-80059f5dd9ec",
"username": "lazyzebra585",
"password": "walter",
"salt": "afXmogsa",
"md5": "a40e87023b57a4a60c7cb398584cbac3",
"sha1": "74caf43400be38cce60a8da2e6d1c367246505c2",
"sha256": "1becdf34bcc6704726c7e9b38821a5792f9dd0689d30789fb5e099a6e51e860a"
},
"dob": {
"date": "1947-06-06T02:45:41.895Z",
"age": 75
},
"registered": {
"date": "2003-03-25T00:15:32.791Z",
"age": 19
},
"phone": "06-9388-6976",
"cell": "0469-101-424",
"id": {
"name": "TFN",
"value": "561493929"
},
"picture": {
"large": "https://randomuser.me/api/portraits/men/32.jpg",
"medium": "https://randomuser.me/api/portraits/med/men/32.jpg",
"thumbnail": "https://randomuser.me/api/portraits/thumb/men/32.jpg"
},
"nat": "AU"
}"""
Vamos imprimir o JSON decodificado em cada etapa para ver o que acontece:
json.loads(json_obj, object_hook = print)
{'title': 'Mr', 'first': 'Ian', 'last': 'Walters'}
{'number': 3161, 'name': 'Saddle Dr'}
{'latitude': '-84.7903', 'longitude': '-29.1020'}
{'offset': '+9:00', 'description': 'Tokyo, Seoul, Osaka, Sapporo, Yakutsk'}
{'street': None, 'city': 'Bendigo', 'state': 'Western Australia', 'country': 'Australia', 'postcode': 4285, 'coordinates': None, 'timezone': None}
{'uuid': '6ee5b2e8-01c3-4314-8f7f-80059f5dd9ec', 'username': 'lazyzebra585', 'password': 'walter', 'salt': 'afXmogsa', 'md5': 'a40e87023b57a4a60c7cb398584cbac3', 'sha1': '74caf43400be38cce60a8da2e6d1c367246505c2', 'sha256': '1becdf34bcc6704726c7e9b38821a5792f9dd0689d30789fb5e099a6e51e860a'}
{'date': '1947-06-06T02:45:41.895Z', 'age': 75}
{'date': '2003-03-25T00:15:32.791Z', 'age': 19}
{'name': 'TFN', 'value': '561493929'}
{'large': 'https://randomuser.me/api/portraits/men/32.jpg', 'medium': 'https://randomuser.me/api/portraits/med/men/32.jpg', 'thumbnail': 'https://randomuser.me/api/portraits/thumb/men/32.jpg'}
{'gender': 'male', 'name': None, 'location': None, 'email': '[email protected]', 'login': None, 'dob': None, 'registered': None, 'phone': '06-9388-6976', 'cell': '0469-101-424', 'id': None, 'picture': None, 'nat': 'AU'}
So json.loads()
chama o object_hook
funciona toda vez que lê um JSON totalmente formado, ou seja, toda vez que fecha um par de colchetes {}
. Em seguida, ele cria todo o objeto JSON usando o resultado do object_hook
função – observe o None
(o valor de retorno de print
) na última linha impressa.
Mostraremos duas soluções alternativas para esse problema. A primeira é modificar nosso User.__init__()
método para ser mais flexível em relação à entrada. Faremos isso usando o __dict__
atributo. Todo objeto Python tem um __dict__
atributo que contém o nome e o valor de cada atributo. Nosso modificado __init__()
método atualizará este dicionário:
class User():
def __init__(self, input):
self.__dict__.update(input)
user = json.loads(json_obj, object_hook = User)
print(f"User {user.name.first} {user.name.last}, age {user.dob.age}, email {user.email}")
Confira nosso guia prático e prático para aprender Git, com práticas recomendadas, padrões aceitos pelo setor e folha de dicas incluída. Pare de pesquisar comandos Git no Google e realmente aprender -lo!
User Ian Walters, age 75, email [email protected]
Outra solução possível é usar o collections.namedtuple
classe:
from collections import namedtuple
def create_user(input):
User = namedtuple('User', input.keys())
return User(**input)
user = json.loads(json_obj, object_hook=create_user)
print(f"User {user.name.first} {user.name.last}, age {user.dob.age}, email {user.email}")
User Ian Walters, age 75, email [email protected]
onde namedtuple('User', input.keys())
cria uma subclasse de tupla chamada User
com as chaves da entrada como nomes de atributos, e User(**input)
atribui os valores correspondentes aos atributos.