summaryrefslogtreecommitdiffstats
path: root/Doc/library/zipfile.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-05-25 18:19:30 (GMT)
committerGeorg Brandl <georg@python.org>2008-05-25 18:19:30 (GMT)
commitb533e26dfae98f00facb50a6d3d6c200771d051f (patch)
treec41061c14b853728742903222b936b9614ff1d93 /Doc/library/zipfile.rst
parentcea777423b67a5ea1ed104b217373556d6ff0383 (diff)
downloadcpython-b533e26dfae98f00facb50a6d3d6c200771d051f.zip
cpython-b533e26dfae98f00facb50a6d3d6c200771d051f.tar.gz
cpython-b533e26dfae98f00facb50a6d3d6c200771d051f.tar.bz2
Merged revisions 63412,63445-63447,63449-63450,63452,63454,63459,63463,63465,63470,63483-63484,63496-63497,63499-63501,63530-63531,63540,63614 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r63412 | georg.brandl | 2008-05-17 19:57:01 +0200 (Sat, 17 May 2008) | 2 lines #961805: fix Edit.text_modified(). ........ r63445 | georg.brandl | 2008-05-18 10:52:59 +0200 (Sun, 18 May 2008) | 2 lines GHOP #180 by Michael Schneider: add examples to the socketserver documentation. ........ r63446 | georg.brandl | 2008-05-18 11:12:20 +0200 (Sun, 18 May 2008) | 2 lines GHOP #134, #171, #137: unit tests for the three HTTPServer modules. ........ r63447 | georg.brandl | 2008-05-18 12:39:26 +0200 (Sun, 18 May 2008) | 3 lines Take namedtuple item names only from ascii_letters (this blew up on OSX), and make sure there are no duplicate names. ........ r63449 | georg.brandl | 2008-05-18 13:46:51 +0200 (Sun, 18 May 2008) | 2 lines GHOP #217: add support for compiling Python with coverage checking enabled. ........ r63450 | georg.brandl | 2008-05-18 13:52:36 +0200 (Sun, 18 May 2008) | 2 lines GHOP #257: test distutils' build_ext command, written by Josip Dzolonga. ........ r63452 | georg.brandl | 2008-05-18 15:34:06 +0200 (Sun, 18 May 2008) | 2 lines Add GHOP students. ........ r63454 | georg.brandl | 2008-05-18 18:32:48 +0200 (Sun, 18 May 2008) | 2 lines GHOP #121: improve test_pydoc, by Benjamin Peterson. ........ r63459 | benjamin.peterson | 2008-05-18 22:48:07 +0200 (Sun, 18 May 2008) | 2 lines bring test_pydoc up to my high standards (now that I have them) ........ r63463 | georg.brandl | 2008-05-18 23:10:19 +0200 (Sun, 18 May 2008) | 2 lines Fix test_pyclbr after another platform-dependent function was added to urllib. ........ r63465 | benjamin.peterson | 2008-05-19 01:07:07 +0200 (Mon, 19 May 2008) | 2 lines change some imports in tests so they will not be skipped in 3.0 ........ r63470 | georg.brandl | 2008-05-19 18:47:25 +0200 (Mon, 19 May 2008) | 2 lines test_httpservers has unpredictable refcount behavior. ........ r63483 | georg.brandl | 2008-05-20 08:15:36 +0200 (Tue, 20 May 2008) | 2 lines Activate two more test cases in test_httpservers. ........ r63484 | georg.brandl | 2008-05-20 08:47:31 +0200 (Tue, 20 May 2008) | 2 lines Argh, this is the *actual* test that works under Windows. ........ r63496 | georg.brandl | 2008-05-20 10:07:36 +0200 (Tue, 20 May 2008) | 2 lines Improve diffing logic and output for test_pydoc. ........ r63497 | georg.brandl | 2008-05-20 10:10:03 +0200 (Tue, 20 May 2008) | 2 lines Use inspect.getabsfile() to get the documented module's filename. ........ r63499 | georg.brandl | 2008-05-20 10:25:48 +0200 (Tue, 20 May 2008) | 3 lines Patch #1775025: allow opening zipfile members via ZipInfo instances. Patch by Graham Horler. ........ r63500 | georg.brandl | 2008-05-20 10:40:43 +0200 (Tue, 20 May 2008) | 2 lines #2592: delegate nb_index and the floor/truediv slots in weakref.proxy. ........ r63501 | georg.brandl | 2008-05-20 10:48:34 +0200 (Tue, 20 May 2008) | 2 lines #615772: raise a more explicit error from Tkinter.Misc.__contains__. ........ r63530 | benjamin.peterson | 2008-05-22 02:57:02 +0200 (Thu, 22 May 2008) | 2 lines use more specific asserts in test_opcode ........ r63531 | benjamin.peterson | 2008-05-22 03:02:23 +0200 (Thu, 22 May 2008) | 2 lines remove redundant invocation of json doctests ........ r63540 | benjamin.peterson | 2008-05-23 01:09:26 +0200 (Fri, 23 May 2008) | 3 lines fix test_pydoc so it works on make installed Python installations Also let it pass when invoked directly ........ r63614 | georg.brandl | 2008-05-25 10:07:37 +0200 (Sun, 25 May 2008) | 2 lines #2959: allow multiple close() calls for GzipFile. ........
Diffstat (limited to 'Doc/library/zipfile.rst')
-rw-r--r--Doc/library/zipfile.rst33
1 files changed, 20 insertions, 13 deletions
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 9b77214..6e933f6 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -150,11 +150,11 @@ ZipFile Objects
.. method:: ZipFile.open(name[, mode[, pwd]])
Extract a member from the archive as a file-like object (ZipExtFile). *name* is
- the name of the file in the archive. The *mode* parameter, if included, must be
- one of the following: ``'r'`` (the default), ``'U'``, or ``'rU'``. Choosing
- ``'U'`` or ``'rU'`` will enable universal newline support in the read-only
- object. *pwd* is the password used for encrypted files. Calling :meth:`open`
- on a closed ZipFile will raise a :exc:`RuntimeError`.
+ the name of the file in the archive, or a :class:`ZipInfo` object. The *mode*
+ parameter, if included, must be one of the following: ``'r'`` (the default),
+ ``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable universal newline
+ support in the read-only object. *pwd* is the password used for encrypted files.
+ Calling :meth:`open` on a closed ZipFile will raise a :exc:`RuntimeError`.
.. note::
@@ -173,14 +173,20 @@ ZipFile Objects
create a new file object that will be held by the ZipExtFile, allowing it to
operate independently of the ZipFile.
+ .. note::
+
+ The :meth:`open`, :meth:`read` and :meth:`extract` methods can take a filename
+ or a :class:`ZipInfo` object. You will appreciate this when trying to read a
+ ZIP file that contains members with duplicate names.
+
.. method:: ZipFile.extract(member[, path[, pwd]])
- Extract a member from the archive to the current working directory, using its
- full name. Its file information is extracted as accurately as possible.
- *path* specifies a different directory to extract to. *member* can be a
- filename or a :class:`ZipInfo` object. *pwd* is the password used for
- encrypted files.
+ Extract a member from the archive to the current working directory; *member*
+ must be its full name or a :class:`ZipInfo` object). Its file information is
+ extracted as accurately as possible. *path* specifies a different directory
+ to extract to. *member* can be a filename or a :class:`ZipInfo` object.
+ *pwd* is the password used for encrypted files.
.. method:: ZipFile.extractall([path[, members[, pwd]]])
@@ -203,9 +209,10 @@ ZipFile Objects
.. method:: ZipFile.read(name[, pwd])
- Return the bytes of the file in the archive. The archive must be open for read
- or append. *pwd* is the password used for encrypted files and, if specified, it
- will override the default password set with :meth:`setpassword`. Calling
+ Return the bytes of the file *name* in the archive. *name* is the name of the
+ file in the archive, or a :class:`ZipInfo` object. The archive must be open for
+ read or append. *pwd* is the password used for encrypted files and, if specified,
+ it will override the default password set with :meth:`setpassword`. Calling
:meth:`read` on a closed ZipFile will raise a :exc:`RuntimeError`.