Skip to content
Snippets Groups Projects

ENH: Special treatment for name property

ENH: Special treatment for name property
f-name-in-json-schema into dev
2 unresolved threads
Merged Florian Spreckelsen requested to merge f-name-in-json-schema into dev
2 unresolved threads

Summary

For https://gitlab.indiscale.com/caosdb/customers/leibniz-zmt/management/-/issues/58. Simply skip name properties in json-schema datamodel definitions -- they will be identified with CaosDB's name property when actually creating records s.th. we don't need to create a separate property.

Focus

name propeties are now caught in JsonSchemaParser._treat_element.

Test Environment

Unittest should be sufficient, but feel free to test it manually, too.

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.

Edited by Florian Spreckelsen

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
src/caosadvancedtools/models/parser.py
692 694 # Each element must have a specific type
693 695 raise JsonSchemaDefinitionError(
694 696 f"`type` is missing in element {name}.")
697 if name == "name":
  • Florian Spreckelsen
    Florian Spreckelsen @florian started a thread on the diff
    • src/caosadvancedtools/models/parser.py
    726 737 else:
    727 738 name = self._stringify(key)
    728 739 prop_ent, force_list = self._treat_element(prop, name)
    740 if prop_ent is None:
    741 # Nothing to be appended since the property has to be
    742 # treated specially.
    743 continue
  • Florian Spreckelsen marked the checklist item Annotations in code (Gitlab comments) as completed

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

  • Florian Spreckelsen marked the checklist item All automated tests pass as completed

    marked the checklist item All automated tests pass as completed

  • Daniel Hornung requested review from @daniel

    requested review from @daniel

  • Daniel Hornung added 1 commit

    added 1 commit

    • ab8bdd9f - DOC: Slight docstring change.

    Compare with previous version

  • Daniel Hornung approved this merge request

    approved this merge request

  • Daniel Hornung enabled an automatic merge when the pipeline for ab8bdd9f succeeds

    enabled an automatic merge when the pipeline for ab8bdd9f succeeds

  • Daniel Hornung merged

    merged

  • Daniel Hornung mentioned in commit ed5695e0

    mentioned in commit ed5695e0

    • Please register or sign in to reply