Spec Driven Model

Introducción

Este módulo es un framework de enlace de datos para Odoo y datos XML: permite ir de XML a objetos de Odoo y viceversa. Aunque no tiene una dependencia estricta con él, ha sido diseñado para usarse junto con xsdata. Por lo tanto, un buen punto de partida es leer la documentación de xsdata aquí.

Pero, ¿y si en lugar de solo generar estructuras Python a partir de archivos XML pudieras generar objetos Odoo completos o serializar objetos Odoo de vuelta a XML? ¡Para esto sirve este módulo!

Primero deberías generar las librerías de enlace Python de xsdata que generarías para tu gramática XSD específica, la Facturación Electrónica Brasileña por ejemplo, o UBL o cualquier archivo XSD...

Segundo deberías generar mixins abstractos de Odoo para todos estos enlaces Python puros. Esto se puede lograr usando xsdata-odoo. Un ejemplo es OCA/l10n-brazil/l10n_br_nfe_spec para la Facturación Electrónica Brasileña.

SpecModel

Ahora que has generado estos enlaces abstractos de Odoo deberías indicarle a Odoo cómo usarlos. Por ejemplo, puede que quieras que tu modelo abstracto para el receptor de la factura electrónica coincida con el objeto res.partner de Odoo. Esto es bastante fácil, principalmente necesitas definir una sobrescritura como:

Ten en cuenta que deberías heredar de spec_models.SpecModel y no del habitual models.Model.

Mapeo de campos: Puedes entonces definir un mapeo bidireccional entre campos sobrescribiendo campos desde Odoo o desde el enlace usando _compute= , _inverse= o simplemente related=.

Campos relacionales: los campos simples se mapean fácilmente de esta manera. Sin embargo, ¿qué pasa con los campos relacionales? En tu esquema XSD, tu factura electrónica está relacionada con el partner.binding.mixin y no con un res.partner de Odoo. No te preocupes, cuando las clases SpecModel se instancian para todos los campos relacionales, buscamos si su comodel ha sido inyectado en algún modelo de Odoo existente y, de ser así, los reasignamos al modelo de Odoo adecuado.

Prefijos de campos: para evitar colisiones de campos entre los campos de Odoo y los campos XSD, los campos XSD se prefijan con el nombre del esquema y algunos dígitos que representan la versión del esquema (típicamente 2 dígitos). Así, si tu esquema recibe una actualización de versión menor, se usan los mismos campos y clases. Sin embargo, para una actualización mayor pueden usarse nuevos campos y clases, de modo que datos de varias versiones mayores podrían coexistir dentro de tu base de datos de Odoo.

StackedModel

Lamentablemente, el XML de la vida real es un poco más complejo que eso. A menudo las estructuras XML están profundamente anidadas simplemente porque hace más fácil que los esquemas XSD las validen. Por ejemplo, una línea de factura electrónica puede ser una estructura anidada con muchos detalles de impuestos y detalles de productos. Sin embargo, en un modelo relacional como Odoo a menudo quieres estructuras de datos más planas. ¡Aquí es donde StackedModel viene al rescate! Hereda de SpecModel y cuando heredas de StackedModel puedes heredar de todos los mixins generados correspondientes a las etiquetas XML anidadas bajo alguna etiqueta (aquí invoice.line.binding.mixin). Todos los campos correspondientes a estos atributos de etiquetas XML se recopilarán en tu modelo y el análisis y la serialización XML ocurrirán como se espera. Aquí hay un ejemplo inspirado en la Facturación Electrónica Brasileña donde el esquema se llama nfe y donde usamos los 2 dígitos 40 para su versión corta:

Todos los campos many2one que son requeridos en el XSD (xsd_required=True) obtendrán su modelo apilado automáticamente y de forma recursiva. También puedes forzar que los campos many2one no requeridos se apilen usando el atributo stacking_force_paths. Por el contrario, puedes evitar que algunos campos many2one requeridos se apilen usando el atributo stacking_skip_paths.

Hook de inicialización

Debido a que los esquemas XSD pueden definir muchos modelos diferentes, spec_driven_model viene con una práctica sobrescritura de _register_hook (en spec.mixin) que automáticamente hará que todos los mixins XSD se conviertan en modelos concretos de Odoo (por ejemplo, con una tabla) si no los has inyectado ya en modelos de Odoo existentes.