Add type hints to models.py

Summary

Introduce type hints in models.py. #144 (closed)

Focus

This MR adds many type hints to models.py, but is not complete. Also, probaby not all type hints are fully correct and will have to be checked, in particular whether really all Optional arguments are actually optional, i.e. are allowed to be None.

Test Environment

Regular test environment.

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 @henrik

mentioned in issue #80

mentioned in issue #77 (closed)

added 99 commits

• ca585439...7b9bc313 - 94 commits from branch dev
• a82bc1cc - MAINT: order of description setter
• 39abcdbd - ENH: Type Hints and fix has_parents
• 35d64442 - ENH: Type Hints and fix get_property
• 04f885e9 - STY: Whitespaces
• d5c380f5 - Merge branch 'f-types' into f-type-hints

Compare with previous version

mentioned in issue #144 (closed)

added 518 commits

• d5c380f5...94de0ce0 - 517 commits from branch dev
• 1e3e8edb - Merge branch 'dev' into f-type-hints

Compare with previous version

assigned to @joschaschmiedt

added 99 commits

• 1e3e8edb...1ecb0883 - 98 commits from branch dev
• db92c531 - Merge branch 'dev' into 'f-type-hints'

Compare with previous version

added 2 commits

• ddbf5fe8 - WIP: Re-add type hints after merge
• 2d1a2f67 - WIP: Add temporary hinted file from before merge

Compare with previous version

added 1 commit

• 30b7c58e - Fix error in _Properties.to_xml due to Importance enum

Compare with previous version

added 1 commit

• 48e74e1f - Move typing imports behin TYPE_CHECKING guard

Compare with previous version

added 2 commits

• 6880c85c - Add pynose to test requirements
• 6ffb356b - WIP: Add type hintes for models.py

Compare with previous version

added 33 commits

• 6ffb356b...e042a85a - 32 commits from branch dev
• 0dd1adbd - Merge remote-tracking branch 'origin/dev' into f-type-hints

Compare with previous version

added 2 commits

• f0224885 - Undo use of Inheritance enum in models.py
• be8db4fe - Remove copy of previously hinted models.py

Compare with previous version

added 1 commit

• 34ca7c3a - Add more type hints to models.py and datatype.py

Compare with previous version

added 1 commit

• e9d61ce7 - Add even more type hints to models.py

Compare with previous version

I have a couple of open questions:

• What is the difference between the values that inheritance and importance can take?
• Are permissions str or Permission?
• Are permissions ever optional?

• inheritance states whether a property is taken from a parent (if obligatory, only obligatory properties are taken from the parent)
• importance states whether an error is raised, when an entity is updated or inserted and a property is missing

I see. Is the overlap in possible values for inheritance and importance (see docs here) something that my change in the future?

If so, it may makes sense to have two different types for them, i.e.

INHERITANCE = Literal["OBLIGATORY", "SUGGESTED", "RECOMMENDED", "ALL", "NONE"]
IMPORTANCE = Literal["OBLIGATORY", "SUGGESTED", "RECOMMENDED", "FIX", "NONE"]

Hm, I now see that for example Property.add_property has a default value of FIX for both importance and inheritance although the server docs don't list FIX as a possible value for inheritance.

FIX was a valid argument for inheritance but is no longer. We should change that.

Is ALL valid for inheritance and importance?

added 1 commit

• 781fccd5 - Prevent import of Literal on Python < 3.8

Compare with previous version

added 1 commit

• b2fdaed4 - STY: Fix style in models.py

Compare with previous version

added 1 commit

• c1782415 - Prevent import of Literal for Python < 3.8

Compare with previous version