Add type signatures in support of strict type-review on example.py #83
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ajnelson-nist
force-pushed
the
support_strict_review_on_example_py
branch
from
33f0844 to
2f47498
Compare
This patch does not take the last step of adding the `--strict` flag in type review. This patch satisfies a run of the type checker in strict mode against the script `/example.py` and all of the library functions that script depends on. Additionally, all touched `__init__` methods observed to not have `*args` & `**kwargs` catch-alls had those added and incorporated into `super()` calls (which will assist with tying to, e.g., knowledge base namespace helpers available in the ultimate parent class `UcoThing`). One effect reflected back into the example script is that the EXIF dictionary incorporation logic needed its own keyword parameter, because the `**kwargs` catch-all parameter being used was an atypical usage versus the pass-through-to-superclass functionality of `**kwargs`. This patch also adjusted one class position, moving `MessageThread` under `ObservableObject` instead of `UcoObject`. A follow-on patch will do the same for `CaseInvestigation`. A follow-on patch will regenerate Make-managed files. Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
ajnelson-nist
force-pushed
the
support_strict_review_on_example_py
branch
from
2f47498 to
86de46e
Compare
Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
…Object One effect reflected back into the example script is that `Compilation`, `ContextualCompilation`, and their subclasses now must be initialized with at least one object `UcoObject` linked in the `core_objects` keyword parameter. Documentation is added to note this is to guarantee minimum cardinality constraints in the ontology are always satisfied. A follow-on patch will regenerate Make-managed files. Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
Signed-off-by: Alex Nelson <alexander.nelson@nist.gov>
Contributor
|
Hi Alex, |
Member
Author
|
@fabrizio-turchi The reason for introducing those classes into the Python class hierarchy is that they are in the UCO ontology class hierarchy, but hadn't been implemented in the Python class hierarchy yet. They are parent classes of I'm glad there was no downstream effect. That was one of the goals of this PR. |
kchason
approved these changes
Dec 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does not take the last step of adding the
--strictflag in type review.This PR satisfies a run of the type checker in strict mode against the script
/example.pyand all of the library functions that script depends on. Additionally, all touched__init__methods observed to not have*args&**kwargscatch-alls had those added and incorporated intosuper()calls (which will assist with tying to, e.g., knowledge base namespace helpers available in the ultimate parent classUcoThing).The first patch also adjusted one class position, moving
MessageThreadunderObservableObjectinstead ofUcoObject. The third patch does the same forCaseInvestigation, entailing a few more classes.Two effects reflected back into the example script are:
**kwargscatch-all parameter being used was an atypical usage versus the pass-through-to-superclass functionality of**kwargs.Compilation,ContextualCompilation, and their subclasses now must be initialized with at least one objectUcoObjectlinked in thecore_objectskeyword parameter. Documentation is added to note this is to guarantee minimum cardinality constraints in the ontology are always satisfied.