gh-85809: Ensure shutil.make_archive accepts path-like objects in all cases #143668
+35
−10
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
Support for path-like objects such as `Pathlib.path` in `shutil.make_archive`. The change ensures path-like support for all parameters regardless of input. Added lightweight tests and updated documentation including examples.
Contributor
Author
|
@serhiy-storchaka nicely described the suggested approach in #94844 (comment). Wondering if it is possible get a PR review for this. |
Misc/NEWS.d/next/Library/2026-01-10-22-58-30.gh-issue-85809.0eW4wt.rst
Outdated
Show resolved
Hide resolved
Member
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
I just tested -- directory descriptor is not supported as root_dir. So we do not need to worry about this.
As for the test -- currently it only tests that the zip archiver supports path-like arguments. We need something like test_make_archive_cwd_default, test_make_archive_cwd and test_make_archive_cwd_supports_root_dir to test format independent support. Register temporary a mock archiver, call make_archive() with path-like objects, and check what was passed to the archiver.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This change ensures
shutil.make_archiveaccepts path-like objects such asPathlib.pathfor all parameters regardless of input. Includes lightweight tests and updated documentation with refreshed examples.While
shutil.make_archivedid supportPathlib.pathinputs in some cases, this behavior was undocumented, untested and resulted in an exception ifroot_dirwasNone. This case is well described in #94844 (comment).This PR addresses the above issue following this suggested approach.
📚 Documentation preview 📚: https://cpython-previews--143668.org.readthedocs.build/