DRAFT: Improve the compare_entities function

Summary

See #197. After the premature merge and following revert of !103 (merged), this MR re-introduces the changes.

TODO: Make these changes compatible to caosadvancedtools.

This MR has diverged very much from dev! It's probably easier to create a new MR with these changes based on the current dev branch.

The main problem is:

• caosadvancedtools relies on the function compare_entities to be able to compare abstract properties.
• This MR introduces NotImplementedErrors which are raised upon comparison of abstract properties.
• Implement support to compare abstract properties as a special case.

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

Apart from unit tests, also check manually with caosdb crawler and advanced user tools.

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)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• 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)
• Appropriate user and developer documentation (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.