What is the best way to create a read-only/allow_mutation=False field?

[jidn]

Similar to the id field, I have a created_on field the database will auto create for me. Now, what is the best way to not allow the field in POST, PUT but have it in GETs?

1. Require the use of Create and Update Schema. Nothing would need to change, but all that schema creation smells of boilerplate.
2. Modify the _utils.py schema_factory to allow for additional fields to exclude. However, at that point you might as well add id to that list and make it generic.
3. Modify the _utils.py schema_factory to look for allow_mutation and exclude it along with id.

for f in schema_cls.__fields__.values()
if f.name != pk_field_name and f.field_info.allow_mutation

Now my field could look something like

# Not in OpenAPI post or put
update_on: datetime.datetime = Field(
    allow_mutation=False, description="Last update from sync system"
)

Is there a better way to remove fields from Create and Update schemas easily?

[awtkns]

Hi @jidn thanks for bringing this up.

I totally agree with what you suggested. I think removing fields with allow_mutation=false in the schema factory would be a great way of reducing potential boiler plate. 🚀

Is this something you would be interested in PRing?

[jidn]

Sure. Any tips where to best insert tests?

[jidn]

Is there anything else you need for this patch?

[awtkns]

Hey thanks for the reminder @jidn. I am planning on merging this in the coming days (with the next release).

[jsenecal]

Hey @awtkns , Do you know when this is going to be part of a released version ?