feat(commons): data model type annotations#892
Open
kieran-ryan wants to merge 1 commit into
Open
Conversation
kieran-ryan
force-pushed
the
commons-models-types
branch
4 times, most recently
from
January 1, 2026 20:03
8e48ad2 to
b162be9
Compare
kieran-ryan
force-pushed
the
commons-models-types
branch
5 times, most recently
from
January 1, 2026 22:17
9f10548 to
9fd83bd
Compare
kieran-ryan
changed the title
kieran-ryan
force-pushed
the
commons-models-types
branch
3 times, most recently
from
January 4, 2026 17:40
401fdd9 to
0790eb6
Compare
kieran-ryan
changed the title
kieran-ryan
changed the title
kieran-ryan
marked this pull request as ready for review
January 4, 2026 18:11
kieran-ryan
force-pushed
the
commons-models-types
branch
3 times, most recently
from
January 5, 2026 20:53
456b412 to
00e6f4f
Compare
kieran-ryan
force-pushed
the
commons-models-types
branch
from
May 4, 2026 11:55
093ea59 to
f134692
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
May 4, 2026 12:26
f134692 to
f4775f4
Compare
Contributor
Author
|
@delatrie would you be able to advise whether this change is good to go, or otherwise whether there is anything I can action? 🙂 Should make a big improvement on client code and within the development of this library. The changes to the |
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
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 - to enable 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.Changes
ParameterMode.DEFAULTto a"default"string fromNone- matching allure2ParameterModeto a string-based enum of(str, Enum)rather thanEnumTestResultwith a UUID - rather than initialise without it and then set its attributeALLURE_UNIQUE_LABELSto the same values, though viaLabelTypeattributes to avoid duplicationWithholding 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