Use Cases / Context

When you export records to a search engine, it's common to want to provides documentation about the fields exported and their characteristics.

When the serializer used to export the records is a Pydantic model, you can use the json schema generated by Pydantic to provide this documentation.

Usage

When you define a serializer based on a Pydantic model, your serializer class must inherit from PydanticModelSerializer and implement the method get_model_class to take advantage of the functionality provided by this module.

Example:

from typing import Type
from pydantic import BaseModel

from odoo.addons.search_engine_serialize_pydantic.tools.serializer import (
    PydanticModelSerializer,
)


class MyModel(BaseModel):
    name: str
    description: str

    def record_to_model(self, record: Model) -> dict:
        return cls(
            name=record.name,
            description=record.description,
        )

class MyModelSerializer(PydanticModelSerializer):
    def get_model_class(self) -> Type[MyModel]:
        return MyModel

    def serialize(self, record: Model) -> dict:
        model: MyModel = self.get_model_class().record_to_model(record)
        return model.model_dump()

Known issues / Roadmap

• Add dedicated widget to display in a user friendly way the json schema generated by the serializer on the index form.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

This module is part of the OCA/search-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.