Skip to content

gh-86608: Improve and restructure tarfile examples #121771

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jul 20, 2025
Merged

gh-86608: Improve and restructure tarfile examples #121771

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
08a5ca9
Add example on how to write a tarfile to stdout
GovernmentPlates Jul 14, 2024
b91aa1b
Fix sphinx doc warning
GovernmentPlates Jul 14, 2024
b4d66f9
Use correct sphinx notation in docs
GovernmentPlates Jul 14, 2024
d1f942b
Remove trailing space
GovernmentPlates Jul 14, 2024
84fabe0
Conform with previous examples
GovernmentPlates Jul 27, 2024
fa974e6
Add sections to docs
GovernmentPlates Jul 20, 2025
4c90c51
Remove news blurb
GovernmentPlates Jul 20, 2025
b2a1f90
Update Doc/library/tarfile.rst
AA-Turner Jul 20, 2025
9978ce5
Move writing examples up a little
GovernmentPlates Jul 20, 2025
9f0943f
whitespace
AA-Turner Jul 20, 2025
760e8b4
Merge branch 'main' into docs-tar-stdout
AA-Turner Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Doc/library/tarfile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1346,6 +1346,15 @@ parameter in :meth:`TarFile.add`::
tar.add("foo", filter=reset)
tar.close()

How to create and write an archive to stdout using
:data:`sys.stdout.buffer <sys.stdout>` in the *fileobj* parameter
in :meth:`TarFile.add`::

import sys
import tarfile
with tarfile.open("sample.tar.gz", "w:gz", fileobj=sys.stdout.buffer) as tar:
for name in ["foo", "bar", "quux"]:
tar.add(name)

.. _tar-formats:

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2024-07-14-16-12-31.gh-issue-86608.di8ggz.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add an example on how to write a tarfile to stdout.
Loading