Implement compress #54
Conversation
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR implements a compress method for the file handling functionality, which creates tar.gz archives of directories. The implementation is based on _job_compress from pyiron_base but excludes file deletion functionality.
- Adds a
compressmethod to create tar.gz archives with optional file exclusion - Includes comprehensive test coverage for the compression functionality
- Prevents overwriting existing archives by checking for file existence
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| pyiron_snippets/files.py | Implements the compress method with tarfile creation and exclude functionality |
| tests/unit/test_files.py | Adds comprehensive unit tests for the compress method including exclusion scenarios |
| def compress(self, exclude_files: list[str | Path] | None = None): | ||
| directory = self.path.resolve() | ||
| output_tar_path = directory.with_suffix(".tar.gz") | ||
| if output_tar_path.exists(): | ||
| return |
There was a problem hiding this comment.
The method silently returns without indication when the target file already exists. Consider raising an exception, returning a boolean status, or providing an overwrite parameter to make this behavior explicit to callers.
| def compress(self, exclude_files: list[str | Path] | None = None): | |
| directory = self.path.resolve() | |
| output_tar_path = directory.with_suffix(".tar.gz") | |
| if output_tar_path.exists(): | |
| return | |
| def compress(self, exclude_files: list[str | Path] | None = None, overwrite: bool = False): | |
| directory = self.path.resolve() | |
| output_tar_path = directory.with_suffix(".tar.gz") | |
| if output_tar_path.exists(): | |
| if not overwrite: | |
| raise FileExistsError(f"Archive '{output_tar_path}' already exists. Set overwrite=True to overwrite.") | |
| else: | |
| output_tar_path.unlink() |
Copilot uses AI. Check for mistakes.
| @@ -95,3 +96,24 @@ def remove_files(self, *files: str): | |||
| path = self.get_path(file) | |||
| if path.is_file(): | |||
| path.unlink() | |||
|
|
|||
| def compress(self, exclude_files: list[str | Path] | None = None): | |||
There was a problem hiding this comment.
The compress method lacks docstring documentation. It should document the purpose, parameters (especially the exclude_files behavior), return value, and the silent behavior when target file exists.
| def compress(self, exclude_files: list[str | Path] | None = None): | |
| def compress(self, exclude_files: list[str | Path] | None = None): | |
| """ | |
| Compress the directory into a `.tar.gz` archive, optionally excluding specified files. | |
| Parameters | |
| ---------- | |
| exclude_files : list of str or pathlib.Path, optional | |
| A list of file paths (relative to the directory or absolute) to exclude from the archive. | |
| Each path is resolved relative to the directory if not absolute. Only files matching | |
| the resolved paths are excluded; directories are not excluded recursively. | |
| Returns | |
| ------- | |
| None | |
| Notes | |
| ----- | |
| - If the target archive file (`<directory>.tar.gz`) already exists, the method does nothing and returns silently. | |
| - Only files are added to the archive; directories themselves are not stored. | |
| """ |
Copilot uses AI. Check for mistakes.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
==========================================
- Coverage 95.22% 95.11% -0.12%
==========================================
Files 13 13
Lines 503 532 +29
==========================================
+ Hits 479 506 +27
- Misses 24 26 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
It should be comparable to
_job_compressinpyiron_base, with the difference that this one does not have the functionality to erase files, because I don’t have the feeling that it belongs here.