Documentation: mention 'close' and iteration for tarfile.TarFile.extractfile()

[bennorth]

BPO	5821
Nosy	@birkenfeld, @bennorth
Files	tarfile.rst.patch: Patch to Doc/library/tarfile.rst

^{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 = 'https://github.com/birkenfeld'
closed_at = <Date 2009-04-25.15:05:14.652>
created_at = <Date 2009-04-23.13:03:08.139>
labels = ['type-feature', 'docs']
title = "Documentation: mention 'close' and iteration for tarfile.TarFile.extractfile()"
updated_at = <Date 2009-04-25.15:05:14.651>
user = 'https://github.com/bennorth'

bugs.python.org fields:

activity = <Date 2009-04-25.15:05:14.651>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-04-25.15:05:14.652>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2009-04-23.13:03:08.139>
creator = 'bennorth'
dependencies = []
files = ['13749']
hgrepos = []
issue_num = 5821
keywords = ['patch']
message_count = 2.0
messages = ['86366', '86525']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'bennorth']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue5821'
versions = []

[bennorth]

The current documentation for tarfile.TarFile.extractfile() does not
mention that the returned 'file-like object' supports close() and also
iteration. The attached patch (against svn trunk) fixes this.

(Background: I was wondering whether I could write

  def process_and_close_file(f_in):
      with closing(f_in) as f:
          # Do stuff with f.

and have it work whether f_in was a true file or the return value of
extractfile(), and thought from the documentation that I couldn't. Of
course, I could have just tried it, but I think fixing the documentation
wouldn't hurt.)

[birkenfeld]

Thanks, applied in r71903.