traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #16025: Minor corrections to the zipfile documentation. 

Patch by Serhiy Storchaka.
This commit is contained in:
Andrew Svetlov 2012-10-06 18:01:05 +03:00
parent 2699c9d248
commit 8c4419304d
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Doc/library/zipfile.rst
View File

@ -53,7 +53,7 @@ The module defines the following items:
.. class:: ZipInfo([filename[, date_time]])
Class used to represent information about a member of an archive. Instances
of this class are returned by the :meth:`getinfo` and :meth:`infolist`
of this class are returned by the :meth:`.getinfo` and :meth:`.infolist`
methods of :class:`ZipFile` objects. Most users of the :mod:`zipfile` module
will not need to create these, but only use those created by this
module. *filename* should be the full name of the archive member, and
@ -78,7 +78,7 @@ The module defines the following items:
.. data:: ZIP_DEFLATED
The numeric constant for the usual ZIP compression method. This requires the
zlib module. No other compression methods are currently supported.
:mod:`zlib` module. No other compression methods are currently supported.
.. seealso::
@ -125,7 +125,7 @@ ZipFile Objects
.. versionchanged:: 2.7.1
If the file is created with mode ``'a'`` or ``'w'`` and then
:meth:`close`\ d without adding any files to the archive, the appropriate
:meth:`closed <close>` without adding any files to the archive, the appropriate
ZIP structures for an empty archive will be written to the file.
ZipFile is also a context manager and therefore supports the
@ -175,7 +175,7 @@ ZipFile Objects
``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable
:term:`universal newline <universal newlines>`
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`.
Calling :meth:`.open` on a closed ZipFile will raise a :exc:`RuntimeError`.
.. note::
@ -196,7 +196,7 @@ ZipFile Objects
.. note::
The :meth:`open`, :meth:`read` and :meth:`extract` methods can take a filename
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.
@ -313,7 +313,7 @@ ZipFile Objects
:class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`.
.. versionchanged:: 2.7
The *compression_type* argument.
The *compress_type* argument.
The following data attributes are also available:
@ -329,7 +329,7 @@ The following data attributes are also available:
The comment text associated with the ZIP file. If assigning a comment to a
:class:`ZipFile` instance created with mode 'a' or 'w', this should be a
string no longer than 65535 bytes. Comments longer than this will be
truncated in the written archive when :meth:`ZipFile.close` is called.
truncated in the written archive when :meth:`.close` is called.
.. _pyzipfile-objects:
@ -369,8 +369,8 @@ The :class:`PyZipFile` constructor takes the same parameters as the
ZipInfo Objects
---------------
Instances of the :class:`ZipInfo` class are returned by the :meth:`getinfo` and
:meth:`infolist` methods of :class:`ZipFile` objects. Each object stores
Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` and
:meth:`.infolist` methods of :class:`ZipFile` objects. Each object stores
information about a single member of the ZIP archive.
Instances have the following attributes: