Implement kadet input type cache #1319
Draft
Conversation
This file contains hidden or 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
rjmco
reviewed
Jun 9, 2025
| "-c", | ||
| help="enable compilation caching to .kapitan_cache\ | ||
| and dependency caching to .dependency_cache, default is False", | ||
| help="enable compilation caching to $XDG_CACHE_HOME/kapitan, default is False", |
There was a problem hiding this comment.
Maybe it is should state:
caching preferably to $XDG_CACHE_HOME/kapitan or $HOME/kapitan, default is False"
or
caching preferably to $XDG_CACHE_HOME/kapitan (if XDG-compliant) or $HOME/kapitan, default is False"
or
caching either to $XDG_CACHE_HOME/kapitan or $HOME/kapitan, default is False"
| default=from_dot_kapitan("compile", "cache", False), | ||
| ) | ||
| compile_parser.add_argument( | ||
| "--cache-paths", |
There was a problem hiding this comment.
Should the removal of the --cache-paths be announced on CHANGELOG.md file under the NEXT RELEASE - Breaking section?
|
I think it would be good to have docstrings for the new functions |
rjmco
reviewed
Jun 9, 2025
rjmco
left a comment
There was a problem hiding this comment.
Announcement of the new feature on the NEXT RELEASE section of the CHANGELOG.md might be missing.
default.nix
Outdated
| # from https://nixos.wiki/wiki/Python#Emulating_virtualenv_with_nix-shell | ||
| let | ||
| pkgs = import <nixpkgs> {}; | ||
| in pkgs.mkShell { |
rjmco
reviewed
Jun 9, 2025
| """ | ||
|
|
||
| input_params = config.input_params | ||
| target_name = self.target_name |
There was a problem hiding this comment.
I would suggest changing slightly the initial line of this function's docstring from:
Compile a kadet input file.
to
Compile a kadet input file, if resulting compilation is not already cached
rjmco
reviewed
Jun 9, 2025
| with open(cached_path_lock, "wb") as fp: | ||
| logger.debug("Writing cache file: %s", cached_path_lock) | ||
| self.dump_output(output_obj, fp) | ||
| cached_path_lock.rename(Path(str(cached_path_lock).removesuffix(".lock"))) |
There was a problem hiding this comment.
What if for some reason, someone aborts execution and this step is never executed? Should there be a recommendation to remove the .lock? Would it be to:
- Delete the whole cache?
- Delete just the
.lockfile? - Remove the
.loclsuffix?
97da85b to
8dbb04b
Compare
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.
Fixes #1318
Proposed Changes
Docs and Tests