Initial commit: OCA Technical packages (595 packages)

odoo-bringout-oca-rest-framework-pydantic/pydantic/readme/USAGE.rst

@@ -0,0 +1,31 @@
+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`.
+
+.. code-block:: python
+
+    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.
+
+.. _`Pydantic documentation`: https://pydantic-docs.helpmanual.io/