[Feature]: Handle conflicts between core schema and extensions #2108
Description
What would you like to see added to PyNWB?
Related to NeurodataWithoutBorders/nwb-schema#633
NWB Schema 2.9.0 was just released, which adds an attribute Device.model - an optional link to a DeviceModel object.
Some extensions have an optional Device.model string attribute.
- https://github.com/catalystneuro/ndx-fiber-photometry/blob/main/spec/ndx-fiber-photometry.extensions.yaml#L24 (multiple instances)
- https://github.com/histedlab/ndx-photostim/blob/main/spec/ndx-photostim.extensions.yaml#L8
- https://github.com/catalystneuro/ndx-extracellular-channels/blob/main/spec/ndx-extracellular-channels.extensions.yaml#L88
One extension has a required or optional Device.model link to a Device object.
One extension defines its own DeviceModel type (that extends Device) and Device.model is an optional link to that:
Is your feature request related to a problem?
No response
What solution would you like?
When reading data:
- We need to detect if there is an incompatibility between the cached extension schema and the pynwb-loaded core schema.
- If so, we need to raise a warning, change the name of the extension field (or class), and load data into it so that old data is still readable.
When writing data:
- We need to detect if there is an incompatibility between the loaded extension schema and the pynwb-loaded core schema (or really any other loaded schema).
- We need to warn (or raise an error for now) saying there is a conflict. Maybe we remap the name of the extension field and still allow writing data?
Do you have any interest in helping implement the feature?
Yes.
Code of Conduct
- I agree to follow this project's Code of Conduct
- Have you checked the Contributing document?
- Have you ensured this change was not already requested?