Pydantic dynamic model creation with json description attribute

Question

When pydantic model is created using class definition, the "description" attribute can be added to the JSON schema by adding a class docstring:

class account_kind(str, Enum):
    """Account kind enum."""
    regular = "r"
    premium = "p"

yields

"account_kind": {
  "title": "account_kind",
  "description": "Account kind enum.",
  "enum": ["r", "p"],
  "type": "string"
}

How do I add "description" when I use dynamic model creation via create_model?

company = create_model("company", **company_attributes)

PChemGuy · Accepted Answer · 2022-10-28 11:50:14Z

0

Apparently, the most straightforward option is to add the docstring explicitly:

company = create_model("company", **company_attributes)
company.__doc__ = "Company description."

answered Oct 28, 2022 at 11:50

PChemGuy

1,8593 gold badges10 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

gnikit Over a year ago

Any ideas on how to set the description for the individual attributes, like it would have been done statically with: regular = pydantic.Field("r", description="some desc"?

PChemGuy Over a year ago

See answer to stackoverflow.com/q/74317070

Collectives™ on Stack Overflow

Pydantic dynamic model creation with json description attribute

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related