Rename container_image to image for improved UX #3094
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
1. Support both `image` and `container_image` for backward compatibility
2. Modify the core decorator used for any task type
* We focus on the user-facing inteface
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
…tests Signed-off-by: JiangJiaWei1103 <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3094 +/- ##
==========================================
- Coverage 76.85% 76.22% -0.63%
==========================================
Files 206 206
Lines 21851 21875 +24
Branches 2837 2840 +3
==========================================
- Hits 16794 16675 -119
- Misses 4269 4363 +94
- Partials 788 837 +49 ☔ View full report in Codecov by Sentry. |
Code Review Agent Run Status
|
Signed-off-by: JiangJiaWei1103 <[email protected]>
Signed-off-by: JiangJiaWei1103 <[email protected]>
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
JiangJiaWei1103
changed the title
JiangJiaWei1103
requested review from
wild-endeavor,
kumare3,
eapolinario,
pingsutw,
cosmicBboy,
samhita-alla,
thomasjpfan and
Future-Outlier
as code owners
thomasjpfan
reviewed
Feb 2, 2025
Code Review Agent Run #e396c5Actionable Suggestions - 3
Review Details
AI Code Review powered by |
Changelist by BitoThis pull request implements the following key changes.
|
flyte-bot
reviewed
Feb 2, 2025
flyte-bot
reviewed
Feb 2, 2025
flyte-bot
reviewed
Feb 2, 2025
1. Validate `image` and `container_image` in `PythonAutoContainerTask`'s
initializer
2. Maintain backward compatibility within `PythonAutoContainerTask`
Signed-off-by: JiangJiaWei1103 <[email protected]>
3 tasks
Code Review Agent Run #5e8094Actionable Suggestions - 2
Review Details
AI Code Review powered by |
flyte-bot
reviewed
Feb 3, 2025
flyte-bot
reviewed
Feb 3, 2025
thomasjpfan
previously approved these changes
Feb 4, 2025
Signed-off-by: JiangJiaWei1103 <[email protected]>
JiangJiaWei1103
dismissed stale reviews from thomasjpfan and pingsutw
via
e66743f
Code Review Agent Run #acb303Actionable Suggestions - 0Review Details
AI Code Review powered by |
Code Review Agent Run #74c115Actionable Suggestions - 0Additional Suggestions - 10
Review Details
AI Code Review powered by |
thomasjpfan
previously approved these changes
Feb 6, 2025
|
shoulnd't we also support |
|
Hi @eapolinario, Thanks for the suggestion! We focus on Supporting |
| @@ -42,6 +43,7 @@ def __init__( | |||
| name: str, | |||
| task_config: T, | |||
| task_type="python-task", | |||
| image: Optional[Union[str, ImageSpec]] = None, | |||
| container_image: Optional[Union[str, ImageSpec]] = None, | |||
There was a problem hiding this comment.
@eapolinario and I were talking about this and we were thinking we might want to put this behind kwargs instead. Could we try that please?
Like delete this line... but leave it in the docs below, maybe move it to the bottom of the params, and check for it explicitly in the code to see if it's set (like kwargs["container_image"]). This way we can hide it from the user, they don't see it in the IDE etc.
cc @thomasjpfan
There was a problem hiding this comment.
put this behind kwargs instead
+1
There was a problem hiding this comment.
It's a bit non-standard, but I am okay with hiding it in kwargs, but keeping it in the docs.
There was a problem hiding this comment.
I've hidden container_image behind kwargs and kept it at the bottom of docstring. Thanks a lot!
| "Please use image because container_image is deprecated and will be removed in the future." | ||
| ) | ||
| elif container_image is not None: | ||
| warnings.warn( |
There was a problem hiding this comment.
should we just make this info? warning is a little too annoying I think.
There was a problem hiding this comment.
I feel like this is not annoying enough. DeprecationWarning does not really show up with default filter warnings. (FutureWarning would be more annoying)
If we really want users to change their code, then I think warnings should be a bit annoying. Because when we remove this feature, breaking code will be even more annoying.
Add `ImageSpec` to the docstring of the `image` parameter for better clarity. Co-authored-by: Yee Hing Tong <[email protected]>
Code Review Agent Run #3a28a5Actionable Suggestions - 0Review Details
AI Code Review powered by |
1. Put deprecated `container_image` param behind `kwargs` 2. Keep `container_image` at the bottom of docstring Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run #44e3d6Actionable Suggestions - 1
Review Details
AI Code Review powered by |
flyte-bot
reviewed
Feb 13, 2025
|
@JiangJiaWei1103 could you change Also, could you remove Thank you! Let's merge after this last change |
|
Hi Yee, I’ll get it done this weekend. Thanks for the suggestion! |
Signed-off-by: JiangJiaWei1103 <[email protected]>
1. Remove `container_image` from `@task` and `@overload` to hide it
behind `kwargs`
2. Let `image` take precedence for version hash generation
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run #914520Actionable Suggestions - 0Additional Suggestions - 10
Review Details
AI Code Review powered by |
1. Hide `container_image` of `Node`'s `with_override` behind `kwargs`
2. Add validation in `Node`'s `with_override` to enforce `image` over
deprecated `container_image`
3. Hide `container_image` of `Promise`'s `with_override` behind `kwargs`
Signed-off-by: JiangJiaWei1103 <[email protected]>
Signed-off-by: JiangJiaWei1103 <[email protected]>
Signed-off-by: JiangJiaWei1103 <[email protected]>
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run #4f136eActionable Suggestions - 1
Review Details
AI Code Review powered by |
flyte-bot
reviewed
Feb 16, 2025
Comment on lines
+275
to
+278
| @property | ||
| def _container_image(self) -> typing.Optional[str]: | ||
| """Deprecated, please use `_image` instead.""" | ||
| return self._image |
There was a problem hiding this comment.
Consider adding deprecation warning for _container_image
Consider enhancing the deprecation notice for _container_image by adding a warning using the warnings module. This would help users transition to using _image instead.
Code suggestion
Check the AI-generated fix before applying
Suggested change
| @property | |
| def _container_image(self) -> typing.Optional[str]: | |
| """Deprecated, please use `_image` instead.""" | |
| return self._image | |
| def _container_image(self) -> typing.Optional[str]: | |
| """Deprecated, please use `_image` instead.""" | |
| warnings.warn("_container_image is deprecated, use _image instead", DeprecationWarning, stacklevel=2) | |
| return self._image |
Code Review Run #4f136e
Is this a valid issue, or was it incorrectly flagged by the Agent?
- it was incorrectly flagged
|
The Follow-upsI’m curious to know if it’s also necessary to modify flytekit/flytekit/models/core/workflow.py Lines 615 to 626 in 66d4aed Thanks! |
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.
Tracking issue
Closes flyteorg/flyte#6140.
Why are the changes needed?
To enhance the user experience, the concept of
containershould be abstracted from flytekit users.What changes were proposed in this pull request?
We propose renaming
container_imagetoimagefor both the@taskdecorator and thewith_overridesmethod. To ensure backward compatibility, we will support both parameters with the following behavior:imageandcontainer_imageare specified: Raise an errorcontainer_imageis used: Warn users about the future deprecationimageis used: UseimagedirectlyIn the future, we can revisit whether modifying the developer-facing code is beneficial when it becomes more relevant.
How was this patch tested?
This patch has been tested using enhanced and newly added unit tests.
Setup process
Run all unit tests using the following command:
Check all the applicable boxes
Related PRs
NA
Docs link
Please refer to flyteorg/flyte#6211
Summary by Bito
This PR implements comprehensive improvements including: 1) renaming 'container_image' parameter to 'image' across Flytekit while maintaining backward compatibility and adding deprecation warnings, 2) enhanced error handling in signal handlers, msgpack processing, and authentication flows, 3) improved type validation for shared memory resources and cache policy handling, and 4) implementation of secure pip argument handling and Kubernetes resource validation.Unit tests added: True
Estimated effort to review (1-5, lower is better): 5