Improve image-labels metadata #63
Conversation
| @@ -71,6 +72,11 @@ class ImageAttrs(Base): | |||
| min_length=1, | |||
| ) | |||
| omero: Omero | None = None | |||
| image_labels: Annotated[ImageLabel | None, Field(..., alias="image-label")] = None | |||
There was a problem hiding this comment.
are we allowed by the spec to write this to JSON as null if the field is unset?
There was a problem hiding this comment.
Probably not. We can use the exclude_unset keyword argument to model_dump() to make sure we're not dumping any unset, but I think that still leaves open the option that someone sets the value to None then writes 😢 looking at https://docs.pydantic.dev/latest/migration/#required-optional-and-nullable-fields I'm not sure there's a way round this though - perhaps we should just document it as a known issue and advise folks not to set values to None when using this library?
There was a problem hiding this comment.
over in pydantic-ome-ngff I used a special attribute to track the fields that shouldn't be serialized if they are null. we might want to do something similar. But until then I would suggest we keep this as-is and put in a TODO statement about dealing with the null value
There was a problem hiding this comment.
👍 I've put in a "known issue" note on the homepage of the docs, definiltey up for us fixing this in a follow up though
|
looks good, I have 2 questions that I left as in-line comments |
Co-authored-by: Davis Bennett <[email protected]>
Work towards #36. Not quite finished, but I put everything still left to do in a TODO: comment in the code so it should be easy to tick them off later.