# Pydantic

This addon provides a utility method that can be used to map odoo record to a Pydantic model.

If you need to make your Pydantic models extendable at runtime, takes a look at the python package extendable-pydantic and the odoo addon extendable

Table of contents

- Usage
- Known issues / Roadmap
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

## Usage

To support pydantic models that map to Odoo models, Pydantic model instances can be created from arbitrary odoo model instances by mapping fields from odoo models to fields defined by the pydantic model. To ease the mapping, the addon provide a utility class odoo.addons.pydantic.utils.GenericOdooGetter.

    import pydantic
    from odoo.addons.pydantic import utils

    class Group(pydantic.BaseModel):
        name: str

        class Config:
            orm_mode = True
            getter_dict = utils.GenericOdooGetter

    class UserInfo(pydantic.BaseModel):
        name: str
        groups: List[Group] = pydantic.Field(alias="groups_id")

        class Config:
            orm_mode = True
            getter_dict = utils.GenericOdooGetter

    user = self.env.user
    user_info = UserInfo.from_orm(user)

See the official Pydantic documentation to discover all the available functionalities.

## Known issues / Roadmap

The roadmap and known issues can be found on GitHub.

## 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

### Authors

- ACSONE SA/NV

### Contributors

- Laurent Mignon <laurent.mignon@acsone.eu>
- Tris Doan <tridm@trobz.com>

### 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/rest-framework project on GitHub.

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