[FAST_BUILD] Refactor tagging: create functions, better logs and names, textwrap.d… #2239
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
mathbunnyru
commented
Feb 23, 2025
| @@ -15,9 +15,6 @@ | |||
|
|
|||
|
|
|||
| def apply_tags(config: Config) -> None: | |||
| """ | |||
There was a problem hiding this comment.
These docstrings are not helpful (especially in apps), and not consistent at all
mathbunnyru
commented
Feb 23, 2025
| @@ -28,6 +25,8 @@ def apply_tags(config: Config) -> None: | |||
| LOGGER.info(f"Applying tag: {tag}") | |||
| docker["tag", config.full_image(), tag] & plumbum.FG | |||
|
|
|||
| LOGGER.info(f"All tags applied to image: {config.image}") | |||
There was a problem hiding this comment.
Tried to add it everywhere so looks are more meaningful
mathbunnyru
commented
Feb 23, 2025
| LOGGER.info(f"Merging tags for image: {config.image}") | ||
|
|
||
| all_tags: set[str] = set() | ||
| def read_tags_from_files(config: Config) -> set[str]: |
There was a problem hiding this comment.
Separate function makes it more understandable
mathbunnyru
commented
Feb 23, 2025
| config: Config, filename: str, all_tags: list[str] | ||
| ) -> None: | ||
| LOGGER.info("Appending build history line") | ||
| def get_build_history_line(config: Config, filename: str, container: Container) -> str: |
There was a problem hiding this comment.
The idea is that get-like functions are more testable.
And we don't mix writing to files and creating file content
mathbunnyru
commented
Feb 23, 2025
| from tagging.manifests.manifest_interface import ManifestInterface | ||
|
|
||
|
|
||
| def get_manifests(image: str | None) -> list[ManifestInterface]: |
There was a problem hiding this comment.
After this refactoring, there is no need to have both taggers and manifests in the same place.
So, it's better to have 2 functions.
Their implementation is similar, but that's ok
mathbunnyru
commented
Feb 23, 2025
| @@ -1,5 +1,7 @@ | |||
| # Copyright (c) Jupyter Development Team. | |||
| # Distributed under the terms of the Modified BSD License. | |||
| import textwrap | |||
There was a problem hiding this comment.
Makes the code a bit easier to read
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.
…edent
Describe your changes
Issue ticket if applicable
Checklist (especially for first-time contributors)