MAINT: Deprecate `parent` keyword in yaml datamodel

Summary

For #65 (closed). Deprecates the parent keyword and also fixes its functionality

Focus

As discussed in https://gitlab.com/caosdb/caosdb-advanced-user-tools/-/issues/36, a DeprecationWarning is raised when the parent keyword is seen, otherwise it now does the same as the inherit_from_obligatory keyword.

Test Environment

New unit test should be sufficient.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

assigned to @florian

marked the checklist item Reference related issues as completed

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item All automated tests pass as completed

marked the checklist item Annotations in code (Gitlab comments) as completed

requested review from @salexan

marked the checklist item I understand the intent of this MR as completed

marked the checklist item All automated tests pass as completed

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item The test environment setup works and the intended behavior is reproducible in the test as completed

marked the checklist item In-code documentation and comments are up-to-date. as completed

marked the checklist item Check: Are there specifications? Are they satisfied? as completed

marked the checklist item Check: Are there specifications? Are they satisfied? as incomplete

marked the checklist item Check: Are there specifications? Are they satisfied? as completed

The only really minor issue I see is that the documentation implies that there can only be one given parent: https://docs.indiscale.com/caosdb-advanced-user-tools/yaml_interface.html

"parent: Parent of this entity."

... although a list would be allowed. As this kw is deprecated anyways, let's not make fuzz about it. :-)

approved this merge request

resolved all threads

mentioned in commit be6e2a63

merged