Tarfile to stdout documentation example

BPO	42442

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-11-23.12:10:03.206>
labels = ['3.7', '3.8', '3.9', 'docs']
title = 'Tarfile to stdout documentation example'
updated_at = <Date 2020-11-23.12:10:03.206>
user = 'https://bugs.python.org/ilaughlin'

bugs.python.org fields:

activity = <Date 2020-11-23.12:10:03.206>
actor = 'ilaughlin'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-11-23.12:10:03.206>
creator = 'ilaughlin'
dependencies = []
files = []
hgrepos = []
issue_num = 42442
keywords = []
message_count = 1.0
messages = ['381665']
nosy_count = 2.0
nosy_names = ['docs@python', 'ilaughlin']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42442'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9']

Linked PRs

Recommend adding example to tarfile documentation to provide example of writing a tarfile to stdout.

example:

files = [(file_1, filename_1), (file_2, filename_2)]


with tarfile.open(fileobj=sys.stdout.buffer, mode = 'w|gz') as tar:
    for file, filename in files:
        file_obj = io.BytesIO() #starts a BytesIO object
        file_obj.write(file.encode('utf-8')) #writes the file to the BytesIO object
        info = tarfile.TarInfo(filename) #creates the TarInfo
        file_obj.seek(0) #goes to the beginning of the BytesIO object else it won't write
        info.size = len(file) #sets the length of the file
        tar.addfile(info, fileobj=file_obj) #writes the tar to stdout.

gh-86608: Improve and restructure tarfile examples (#121771)

pythongh-86608: Improve and restructure tarfile examples (pythonGH-12…

pythongh-86608: Improve and restructure tarfile examples (python#121771)

[3.14] gh-86608: Improve and restructure tarfile examples (GH-121771) (…

[3.13] gh-86608: Improve and restructure tarfile examples (GH-121771) (…

pythongh-86608: Improve and restructure tarfile examples (python#121771)

[3.14] pythongh-86608: Improve and restructure tarfile examples (pyth…

Navigation Menu

Repository navigation

Tarfile to stdout documentation example #86608

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Tarfile to stdout documentation example #86608

Description

Linked PRs

Activity

ilaughlin commented on Nov 23, 2020

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions