{"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\/es\/validate-json-documents-in-python-using-pydantic\/","title":{"rendered":"Validar documentos JSON en Python con Pydantic"},"content":{"rendered":"

Uno de los principales atractivos de <\/span>bases de datos de documentos<\/b> es la flexibilidad de la estructura o esquema del documento. En la mayor\u00eda de los casos, la flexibilidad del esquema del documento es beneficiosa. Sin embargo, puede haber algunas situaciones en las que tener alguna estructura en el documento puede ser \u00fatil. Este art\u00edculo muestra c\u00f3mo validar tus documentos JSON contra un esquema especificado usando la popular librer\u00eda Python <\/span>pydantic<\/span><\/a>.<\/span><\/p>\n

\u00bfCu\u00e1ndo hay que validar los documentos?<\/span><\/h4>\n

Un error com\u00fan sobre el uso de bases de datos NoSQL es que no se requieren estructuras o esquemas de documentos. En la mayor\u00eda de los casos, las aplicaciones suelen tener algunas restricciones para los datos, aunque no las validen espec\u00edficamente. Por ejemplo, puede haber algunos campos en el documento de los que la aplicaci\u00f3n depende para su funcionalidad. Una aplicaci\u00f3n podr\u00eda simplemente no funcionar correctamente si faltan algunos de estos campos JSON p\u00eddanticos.<\/span><\/p>\n

Un ejemplo real de este problema podr\u00eda ser una aplicaci\u00f3n que lee datos de otra aplicaci\u00f3n poco fiable que env\u00eda peri\u00f3dicamente datos err\u00f3neos. Ser\u00eda prudente resaltar los documentos que podr\u00edan romper la aplicaci\u00f3n en tales casos. Los desarrolladores pueden hacer esto <\/span>en la aplicaci\u00f3n <\/span><\/i>o <\/span>a nivel de documento<\/span><\/i>.\u00a0<\/span><\/p>\n

En este enfoque, especificamos un esquema de JSON a pydantic para los documentos con el fin de ayudar a identificar aquellos que no coinciden con las especificaciones de la aplicaci\u00f3n a nivel de documento.<\/span><\/p>\n

Generar datos de prueba JSON<\/span><\/h4>\n

Utilizamos la biblioteca de c\u00f3digo abierto, <\/span>Farsante<\/span><\/a>para generar algunos perfiles de usuario falsos para este tutorial.<\/span><\/p>\n

Esta es la estructura de un documento \u00fanico:<\/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 los documentos rotos, modifico una peque\u00f1a parte de los perfiles de usuario eliminando algunos de los campos de tel\u00e9fono m\u00f3vil y correo. Nuestro objetivo es identificar estos registros que, en el mundo real, se almacenar\u00edan en una base de datos de documentos como Couchbase.<\/span><\/p>\n
Cargo los datos pydantic generados a partir de JSON en un bucket de nuestro hosted <\/span>Couchbase Capella<\/span><\/a> cl\u00faster utilizando el <\/span>importar <\/span><\/i>en la interfaz de usuario de la consola web integrada para nuestras pruebas. Especifico el <\/span>nombre de usuario <\/span><\/i>como clave para identificar un\u00edvocamente cada documento.<\/span><\/p>\n
\u00bfC\u00f3mo especificar un esquema para documentos JSON?<\/span><\/h4>\n
En los datos del perfil de usuario, espero que los documentos se ajusten a la siguiente estructura en mis aplicaciones:<\/span><\/p>\n