Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update comments in _make_dataclass_serializable #2856

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Update comments in _make_dataclass_serializable #2856

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0f8401
update comments in _make_dataclass_serializable
mao3267 Oct 24, 2024
f9b9cba
update comments for flyte types
mao3267 Oct 24, 2024
bba4ff7
fix: make lint
mao3267 Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions flytekit/core/type_engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,18 @@ def _fix_structured_dataset_type(self, python_type: Type[T], python_val: typing.
def _make_dataclass_serializable(self, python_val: T, python_type: Type[T]) -> typing.Any:
"""
If any field inside the dataclass is flyte type, we should use flyte type transformer for that field.
Since Flyte types are already serializable, this function is intended for using strings instead of directly creating Flyte files and directories in the dataclass.
An example shows the lifecycle:

@dataclass
class DC:
ff: FlyteFile

@task
def t1() -> DC:
return DC(ff="s3://path")

Lifecycle: DC(ff="s3://path") -> to_literal() -> DC(ff=FlyteFile(path="s3://path")) -> msgpack -> to_python_value() -> DC(ff=FlyteFile(path="s3://path"))
"""
from flytekit.types.directory import FlyteDirectory
from flytekit.types.file import FlyteFile
Expand Down
Loading