Refactor sort_keys implementation

[evetion]

Fixes #956

While ideally we set the sort_keys on the Schema of a TableModel, or on the TableModel themselves, this is not directly possible AFAIK:

• Schemas are autogenerated, and sort_keys is not something we can serialize or parse in a JSONSchema
• The TableModels are generic (TableModel[T]), so specific sort_keys can't be hardcoded to a class.

The previous approach was to hold the sort keys in a Dict[table, sort_keys] on a NodeModel (which holds multiple tables), and passing them on when save/sort was called from the Node. This PR improves on that approach by introducing a private _sort_keys on the TableModel, which is always set (from an empty list by default) on initialization from the NodeModel.

Instead of keeping a separate Dict with sort_keys on a NodeModel, we now set them in the Field attribute json_schema_extra (the only customizable attribute of a Field) for each field. Each field of a NodeModel is now validated by default (also on assignment), and if a sort_keys is present for a fieldtype, it is set on the TableModel.

Based on the initial exploration by @deltamarnix in https://github.com/Deltares/Ribasim/tree/feat/sort-keys-in-tablemodel

[deltamarnix]

The code itself looks good, I would like to see some more error handling and documentation on the decisions that were made so that it will be in the git history

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[deltamarnix]

Because of the nesting I would prefer some early returns here instead.

[deltamarnix]

I like the solution. Making use of the schema to set the information. I would love to eventually see this coming from the generated code instead.