feat(commons): data model type annotations #892
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
kieran-ryan
force-pushed
the
commons-models-types
branch
4 times, most recently
from
8e48ad2 to
b162be9
Compare
kieran-ryan
force-pushed
the
commons-models-types
branch
5 times, most recently
from
9f10548 to
9fd83bd
Compare
kieran-ryan
changed the title
kieran-ryan
force-pushed
the
commons-models-types
branch
3 times, most recently
from
401fdd9 to
0790eb6
Compare
kieran-ryan
changed the title
kieran-ryan
changed the title
kieran-ryan
force-pushed
the
commons-models-types
branch
2 times, most recently
from
2ab2ed8 to
456b412
Compare
- Corrected `TestResult` to initialise with required UUID - Updated `ParameterMode.DEFAULT` from `None` to `"default"` - Updated `ALLURE_UNIQUE_LABELS` to use `LabelType` values
kieran-ryan
force-pushed
the
commons-models-types
branch
from
456b412 to
00e6f4f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Context
Establish type annotations on common data models towards #878.
TestResultusage to initialise with required UUIDParameterModeto a string-based enum of(str, Enum)fromEnumParameterMode.DEFAULTto a"default"string fromNone- matching allure2ALLURE_UNIQUE_LABELSto useLabelTypevaluesThis enables static type checking and rich language services through language servers. The
tyVisual Studio Code extension will only recogniseattrsattributes once type annotations are provided for instance - seeattrsdocumentation on type annotations.Withholding removing
Nonefrom required fields - being a breaking change for any improper initialisation - reserving for more fundamental model updates. Similarly withholding standardising all types to string-based enums.Screenshots
Without annotations