NotificationsYou must be signed in to change notification settings
Fork32k
Star67.3k

gh-133005: Support`tarfile.open(mode="w|xz", preset=...)`#133007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

gpshead merged 4 commits intopython:mainfrommgorny:tarfile-stream-xz-preset-133005

Apr 27, 2025

Merged

gh-133005: Support`tarfile.open(mode="w|xz", preset=...)`#133007

gpshead merged 4 commits intopython:mainfrommgorny:tarfile-stream-xz-preset-133005

Apr 27, 2025

Conversation

Copy link

Contributor

mgorny commentedApr 26, 2025•
edited by github-actionsbot
Loading

Support passing thepreset option totarfile.open when the file is open withmode="w|xz". This aligns the behavior with"w:xz" mode.

Issue:tarfile: Supportpreset argument totarfile.open(mode="w|xz") #133005

📚 Documentation preview 📚:https://cpython-previews--133007.org.readthedocs.build/

mgorny requested a review fromethanfurman as acode owner

April 26, 2025 12:46

bedevere-appbot added the awaiting review label

Apr 26, 2025

bedevere-appbot mentioned this pull request

Apr 26, 2025

tarfile: Supportpreset argument totarfile.open(mode="w|xz")#133005

Closed

pythongh-133005: Supporttarfile.open(mode="w|xz", preset=...)

ebf37b6

Support passing the `preset` option to `tarfile.open` when the fileis open with `mode="w|xz"`.  This aligns the behavior with `"w:xz"`mode.

mgorny force-pushed thetarfile-stream-xz-preset-133005 branch from697bbca toebf37b6Compare

April 26, 2025 12:49

Also raise an error forcompresslevel orpreset with wrong mode

414b94e

Raise an error if `compresslevel` or `preset` argument is specifiedfor stream mode with incorrect compression. This should reduce the riskof mistakes and align the stream modes with regular modes, that raisean implicit TypeError on unsupported arguments.

Copy link

ContributorAuthor

mgorny commentedApr 26, 2025

I've added raising an exception ifcompresslevel orpreset are specified for wrong compression as a second commit, since it's non-critical to the issue at hand, so it can be easily removed if you don't like it.

Copy link

ContributorAuthor

mgorny commentedApr 26, 2025

The macOS failures don't seem related.

brianschubert reviewed

Apr 26, 2025

View reviewed changes

Doc/library/tarfile.rst OutdatedShow resolvedHide resolved

Misc/NEWS.d/next/Library/2025-04-26-14-44-21.gh-issue-133005.y4SRfk.rst OutdatedShow resolvedHide resolved

Apply suggestions from code review

406dc4c

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>

Copy link

ContributorAuthor

mgorny commentedApr 26, 2025

Thank you for your suggestions!

gpshead approved these changes

Apr 27, 2025

View reviewed changes

Copy link

Member

gpshead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

if the silently ignored when irrelevant compresslevel= that now raises causes an issue during the beta period we can revisit that error addition. (the error codepath will be adjusted with zstd support landing soon as well)