Fix utils.copy_tree() to create dst if it doesn't exist
#1231
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
Kapitan's `utils.copy_tree()` calls `shutil.copytree()` which will create the destination directory if it doesn't exist yet. However, currently, `utils.copy_tree()` doesn't support this case and will raise a `SafeCopyError` when the destination directory doesn't exist. This commit adjusts the implementation to only raise a `SafeCopyError` when the destination exists and isn't a directory and will let `shutil.copytree()` create the destination if the destination doesn't exist at all.
simu
force-pushed
the
fix/copy-tree-missing-dst
branch
from
06ccc9d
to
5958982
Compare
ademariag
approved these changes
Sep 3, 2024
auto-merge was automatically disabled
September 3, 2024 15:06
Head branch was pushed to by a user without write access
3 tasks
ademariag
pushed a commit
that referenced
this pull request
Sep 4, 2024
…force_fetch=True` (#1232) ## Proposed Changes When force fetching Git dependencies, we need to be able to overwrite read-only files in the destination, since Git repos may contain read-only pack and index files in `.git/`. To do so, this PR introduces flag `clobber_files` for `utils.copy_tree()` which will completely clobber existing files in the destination by setting a custom `copy_function` for `shutil.copytree()` which deletes existing destination files before copying them with `shutil.copy2()`. With this change, `utils.copy_tree()` with `clobber_files=True` behaves pretty much identically to distutils' `copy_tree()` which was used in previous versions of Kapitan. ## TODO - [x] Rebase once #1231 is merged ## Docs and Tests * [x] Tests added * [x] Updated documentation
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.
Proposed Changes
Kapitan's
utils.copy_tree()callsshutil.copytree()which will create the destination directory if it doesn't exist yet. However, currently,utils.copy_tree()doesn't support this case and will raise aSafeCopyErrorwhen the destination directory doesn't exist.This PR adjusts the implementation to only raise a
SafeCopyErrorwhen the destination exists and isn't a directory and will letshutil.copytree()create the destination if the destination doesn't exist at all.Docs and Tests