Document return value for ZipFile.extract()

[mjpieters]

BPO	23730
Nosy	@mjpieters, @zware, @matrixise
Files	issue23730.diff

^{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 = <Date 2015-04-13.21:44:17.787>
created_at = <Date 2015-03-21.09:11:29.417>
labels = ['type-feature', 'docs']
title = 'Document return value for ZipFile.extract()'
updated_at = <Date 2015-04-13.21:46:02.155>
user = 'https://github.com/mjpieters'

bugs.python.org fields:

activity = <Date 2015-04-13.21:46:02.155>
actor = 'zach.ware'
assignee = 'docs@python'
closed = True
closed_date = <Date 2015-04-13.21:44:17.787>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2015-03-21.09:11:29.417>
creator = 'mjpieters'
dependencies = []
files = ['38943']
hgrepos = []
issue_num = 23730
keywords = ['patch']
message_count = 4.0
messages = ['238778', '240687', '240770', '240771']
nosy_count = 5.0
nosy_names = ['mjpieters', 'docs@python', 'python-dev', 'zach.ware', 'matrixise']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue23730'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']

[mjpieters]

The documentation for zipfile.ZipFile.extract() doesn't mention at all that it returns the local path created, either for the directory that the member represents, or the new file created from the zipped data.

*Returns the full local path created (a directory or new file)* or similar.

[matrixise]

fix for the documentation of ZipFile.extract.

In the code of _extract_member, there is a normalisation of the target path, I use this term "normalized" for the fix.

[python-dev]

New changeset 731e366885f5 by Zachary Ware in branch '2.7':
Issue bpo-23730: Document the return value of ZipFile.extract
https://hg.python.org/cpython/rev/731e366885f5

New changeset 7ac1c2307a70 by Zachary Ware in branch '3.4':
Issue bpo-23730: Document the return value of ZipFile.extract
https://hg.python.org/cpython/rev/7ac1c2307a70

New changeset d958c74ddb0c by Zachary Ware in branch 'default':
Closes bpo-23730: merge with 3.4
https://hg.python.org/cpython/rev/d958c74ddb0c

[zware]

Thanks for the patch!