{"id":12917,"date":"2022-03-22T08:54:20","date_gmt":"2022-03-22T15:54:20","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=12917"},"modified":"2025-06-13T21:25:03","modified_gmt":"2025-06-14T04:25:03","slug":"validate-json-documents-in-python-using-pydantic","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/validate-json-documents-in-python-using-pydantic\/","title":{"rendered":"Valida\u00e7\u00e3o de documentos JSON em Python usando Pydantic"},"content":{"rendered":"

Uma das principais atra\u00e7\u00f5es do <\/span>bancos de dados de documentos<\/b> \u00e9 a flexibilidade da estrutura ou do esquema do documento. Na maioria das vezes, a flexibilidade do esquema do documento \u00e9 ben\u00e9fica. No entanto, pode haver algumas situa\u00e7\u00f5es em que ter alguma estrutura para o documento pode ser \u00fatil. Este artigo mostra como validar seus documentos JSON em rela\u00e7\u00e3o a um esquema especificado usando a popular biblioteca Python <\/span>pydantic<\/span><\/a>.<\/span><\/p>\n

Quando voc\u00ea precisa validar documentos?<\/span><\/h4>\n

Uma concep\u00e7\u00e3o err\u00f4nea comum sobre o uso de bancos de dados NoSQL \u00e9 que n\u00e3o s\u00e3o necess\u00e1rias estruturas ou esquemas de documentos. Na maioria dos casos, os aplicativos tendem a ter algumas restri\u00e7\u00f5es para os dados, mesmo que n\u00e3o os validem especificamente. Por exemplo, pode haver alguns campos no documento dos quais o aplicativo depende para sua funcionalidade. Um aplicativo pode simplesmente n\u00e3o funcionar corretamente quando alguns desses campos JSON pid\u00eamicos estiverem faltando.<\/span><\/p>\n

Um exemplo do mundo real desse problema poderia ser um aplicativo que l\u00ea dados de outro aplicativo n\u00e3o confi\u00e1vel que envia periodicamente dados ruins. Seria prudente destacar todos os documentos que poderiam quebrar o aplicativo nesses casos. Os desenvolvedores podem fazer isso <\/span>no aplicativo <\/span><\/i>ou <\/span>no n\u00edvel do documento<\/span><\/i>.\u00a0<\/span><\/p>\n

Nessa abordagem, especificamos um esquema de JSON para pid\u00e2ntica para os documentos, a fim de ajudar a identificar aqueles que n\u00e3o correspondem \u00e0s especifica\u00e7\u00f5es do aplicativo no n\u00edvel do documento.<\/span><\/p>\n

Gerar dados de teste JSON<\/span><\/h4>\n

Usamos a biblioteca de c\u00f3digo aberto, <\/span>Faker<\/span><\/a>para gerar alguns perfis de usu\u00e1rio falsos para este tutorial.<\/span><\/p>\n

Essa \u00e9 a estrutura de um \u00fanico documento:<\/span><\/p>\n

{\r\n  \"job\": \"Radiographer, diagnostic\",\r\n  \"company\": \"Klein, Dillon and Neal\",\r\n  \"residence\": \"2232 Jackson Forks\\nLake Teresa, CO 46959\",\r\n  \"website\": [\r\n    \"https:\/\/bishop-torres.net\/\"\r\n  ],\r\n  \"username\": \"aabbott\",\r\n  \"name\": \"Madison Mitchell\",\r\n  \"address\": \"1782 Moore Hill Apt. 717\\nWest Stephaniestad, NM 75293\",\r\n  \"mail\": \"amberrodriguez@hotmail.com\",\r\n  \"phone\": {\r\n    \"home\": \"677-197-4239x889\",\r\n    \"mobile\": \"001-594-038-9255x99138\"\r\n  }\r\n}<\/pre>\n
Para simular os documentos quebrados, modifico uma pequena parte dos perfis de usu\u00e1rio, excluindo alguns dos campos de telefone celular e e-mail. Nosso objetivo \u00e9 identificar esses registros que, no mundo real, seriam armazenados em um banco de dados de documentos como o Couchbase.<\/span><\/p>\n
Carrego os dados pid\u00e2nticos gerados a partir do JSON em um bucket em nosso servidor hospedado <\/span>Couchbase Capella<\/span><\/a> cluster usando o <\/span>importa\u00e7\u00e3o <\/span><\/i>na interface integrada do console da Web para nossos testes. Eu especifico o <\/span>nome de usu\u00e1rio <\/span><\/i>como a chave para identificar exclusivamente cada documento.<\/span><\/p>\n
Como especificar um esquema para documentos JSON?<\/span><\/h4>\n
Nos dados do perfil do usu\u00e1rio, espero que os documentos estejam em conformidade com a seguinte estrutura em meus aplicativos:<\/span><\/p>\n