Should I use Schema.model_dump() or Schema.dict()?

[darshan-roon]

Hi, I'm trying to figure out what the best method to use is for the latest version of Dango Ninja.

Example:

class EducationUpdatePayload(Schema):
    type: EducationType | None = Field(
        None, description="The type of education entry.", example=EducationType.MEDICAL_SCHOOL
    )
    institution_name: str | None = Field(
        None, description="The name of the institution.", example="University of California, San Francisco"
    )
    start_year: int | None = Field(None, description="The year the education started.", example=2010)
    end_year: int | None = Field(
        None, description="The year the education ended. If None, the education is still ongoing.", example=2014
    )

payload = EducationUpdatePayload(...)

payload.model_dump() OR payload.dict()?

Thanks!

[luckydonald]

The .dict() method in pydantic 2 is marked deprecated, and in ninja it's marked as "pydantic v1 compatibility", too.

The model_dump() is the way to go.

Probably it should properly deprecated here too.

[luckydonald]

See also #1537

[darshan-roon]

Thanks!

[vitalik]

Well that's an open question actually

In django ninja we try to avoid "model" word as in django universe it's mainly mean database table

Currently both are supported without any deprecation warnings - what should be at the end - i'm not sure yet

[pmdevita]

@darshan-roon Did you have any confusion about whether model_dump had something to do with Django ORM models? Or did you feel like you understood it just dumped the schema?

[darshan-roon]

@darshan-roon Did you have any confusion about whether model_dump had something to do with Django ORM models? Or did you feel like you understood it just dumped the schema?

I understood what model_dump was from using previously using Pydantic

[darshan-roon]

So which is preferred usage? model_dump() or dict()?