[Docs] Use Pure Dataclass In Example #5829
Merged
+18
−16
Conversation
This file contains 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
Signed-off-by: Future-Outlier <eric901201@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5829 +/- ##
=======================================
Coverage 36.35% 36.35%
=======================================
Files 1304 1304
Lines 110148 110148
=======================================
+ Hits 40042 40043 +1
+ Misses 65939 65938 -1
Partials 4167 4167
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
neverett
requested changes
Oct 9, 2024
| `from dataclasses_json import dataclass_json` instead of inheriting from Mashumaro's `DataClassJSONMixin`. | ||
|
|
||
| If you're using Flytekit version >= v1.11.1, you don't need to decorate with `@dataclass_json` or | ||
| If you're using Flytekit version below v1.11.1, your dataclass will need to decorate with `@dataclass_json` or |
There was a problem hiding this comment.
Just to clarify, this means that if you are using Flytekit < 1.11.1, you either need to decorate your dataclass with @dataclass_json or create a class that inherits DataClassJSONMixin, but that you don't need to do both? If you inherit from DataClassJSONMixin, do you need to do from mashumaro.mixins.json import DataClassJSONMixin as well?
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
neverett
reviewed
Oct 9, 2024
| `from dataclasses_json import dataclass_json` instead of inheriting from Mashumaro's `DataClassJSONMixin`. | ||
|
|
||
| If you're using Flytekit version >= v1.11.1, you don't need to decorate with `@dataclass_json` or | ||
| If you're using Flytekit version below v1.11.1, your dataclass will need to decorate with `@dataclass_json` or |
There was a problem hiding this comment.
Suggested change
| If you're using Flytekit version below v1.11.1, your dataclass will need to decorate with `@dataclass_json` or | |
| If you're using Flytekit version greater than v1.10 and less than v1.11.1, you will need add `from mashumaro.mixins.json import DataClassJSONMixin` to your imports and either decorate your dataclass with `@dataclass_json` or create a class that inherits from `DataClassJSONMixin`. |
There was a problem hiding this comment.
Let me know if this is accurate!
There was a problem hiding this comment.
it's not, but I can update it
Signed-off-by: Future-Outlier <eric901201@gmail.com>
neverett
reviewed
Oct 9, 2024
neverett
previously approved these changes
Oct 9, 2024
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
neverett
approved these changes
Oct 9, 2024
Future-Outlier
deleted the
remove-decorator-and-base-class-from-dataclass
branch
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.
Docs link
flyte dataclass: https://flyte--5829.org.readthedocs.build/en/5829/user_guide/data_types_and_io/dataclass.html