JSONifier

Este módulo añade un método 'jsonify' a cada modelo del ORM. Funciona sobre el recordset actual y requiere un único argumento 'parser' que especifica el campo a extraer.

Ejemplo de un parser simple:

Para ser coherente con la API de Odoo, el método jsonify siempre devuelve una lista de objetos incluso si solo hay un elemento en el recordset.

Por defecto, la clave dentro del JSON es el nombre del campo extraído del modelo. Si necesitas especificar un nombre alternativo para usar como clave, puedes definir tu mapping de la siguiente manera en la definición del parser:

Si necesitas parsear el valor de un campo de forma personalizada, puedes pasar un callable o el nombre de un método del modelo:

Además, el módulo proporciona un método "get_json_parser" en el objeto ir.exports que genera un parser a partir de una configuración de ir.exports.

Hay más funcionalidades disponibles para usos avanzados. Define un modelo "resolver" simple que tiene un campo "python_code" y una función resolve, de modo que se pueden configurar funciones arbitrarias para transformar campos o procesar el diccionario resultante. También permite especificar un lang para extraer la traducción de cualquier campo dado.

Para usar estas funcionalidades, un parser completo sigue la siguiente estructura:

Se obtendría un resultado con esta estructura (nótese que los campos traducidos se fusionan en el mismo diccionario):

Nótese que un resolver puede pasarse como un recordset o como un id, para que sea totalmente serializable. Una versión ligeramente más simple en caso de que no se necesite la traducción de campos, pero sí otras funcionalidades como resolvers personalizados, es:

Al pasar la clave fields en lugar de langs, tenemos esencialmente el mismo comportamiento que los parsers simples, con la ventaja añadida de poder usar resolvers.

Casos de uso estándar de los resolvers son: - dar valores por defecto específicos de campo (p. ej. "" en lugar de None) - convertir el tipo de un campo (p. ej. int()) - asignar un alias a un campo concreto para una exportación específica - ...

Un parser simple simplemente se traduce a un parser completo en la exportación.

Si se proporciona el resolver global, entonces el json_dict pasa por:

Lo que permite añadir datos externos desde el contexto o transformar el diccionario si es necesario. De forma similar, si se proporciona para un campo, el resolver evalúa el resultado.

Es posible que un target tenga un marshaller terminando el target con '=list': en ese caso el resultado se coloca en una lista.

Daría como resultado la siguiente estructura JSON:

El caso de uso previsto es ser compatible con APIs que requieren que todos los parámetros traducidos se exporten simultáneamente, y que piden que las propiedades personalizadas se coloquen en un subdiccionario. Dado que a menudo algunos de estos requisitos son opcionales, se podrían cumplir nuevos requisitos sin necesidad de añadir campos ni cambiar ningún código.

Nótese que los valores exportados con el parser simple dependen del lang del registro; esto contrasta con los parsers completos, que están diseñados para ser independientes del idioma.

NOTA: este módulo se llamó base_jsonify hasta la versión 14.0.1.5.0.