Commit 8c441930 authored by Andrew Svetlov's avatar Andrew Svetlov

Issue #16025: Minor corrections to the zipfile documentation.

Patch by Serhiy Storchaka.
parent 2699c9d2
...@@ -53,7 +53,7 @@ The module defines the following items: ...@@ -53,7 +53,7 @@ The module defines the following items:
.. class:: ZipInfo([filename[, date_time]]) .. class:: ZipInfo([filename[, date_time]])
Class used to represent information about a member of an archive. Instances 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 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 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 module. *filename* should be the full name of the archive member, and
...@@ -78,7 +78,7 @@ The module defines the following items: ...@@ -78,7 +78,7 @@ The module defines the following items:
.. data:: ZIP_DEFLATED .. data:: ZIP_DEFLATED
The numeric constant for the usual ZIP compression method. This requires the 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:: .. seealso::
...@@ -125,7 +125,7 @@ ZipFile Objects ...@@ -125,7 +125,7 @@ ZipFile Objects
.. versionchanged:: 2.7.1 .. versionchanged:: 2.7.1
If the file is created with mode ``'a'`` or ``'w'`` and then 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. ZIP structures for an empty archive will be written to the file.
ZipFile is also a context manager and therefore supports the ZipFile is also a context manager and therefore supports the
...@@ -175,7 +175,7 @@ ZipFile Objects ...@@ -175,7 +175,7 @@ ZipFile Objects
``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable ``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable
:term:`universal newline <universal newlines>` :term:`universal newline <universal newlines>`
support in the read-only object. *pwd* is the password used for encrypted files. 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:: .. note::
...@@ -196,7 +196,7 @@ ZipFile Objects ...@@ -196,7 +196,7 @@ ZipFile Objects
.. note:: .. 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 or a :class:`ZipInfo` object. You will appreciate this when trying to read a
ZIP file that contains members with duplicate names. ZIP file that contains members with duplicate names.
...@@ -313,7 +313,7 @@ ZipFile Objects ...@@ -313,7 +313,7 @@ ZipFile Objects
:class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`. :class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`.
.. versionchanged:: 2.7 .. versionchanged:: 2.7
The *compression_type* argument. The *compress_type* argument.
The following data attributes are also available: The following data attributes are also available:
...@@ -329,7 +329,7 @@ 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 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 :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 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: .. _pyzipfile-objects:
...@@ -369,8 +369,8 @@ The :class:`PyZipFile` constructor takes the same parameters as the ...@@ -369,8 +369,8 @@ The :class:`PyZipFile` constructor takes the same parameters as the
ZipInfo Objects ZipInfo Objects
--------------- ---------------
Instances of the :class:`ZipInfo` class are returned by the :meth:`getinfo` and Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` and
:meth:`infolist` methods of :class:`ZipFile` objects. Each object stores :meth:`.infolist` methods of :class:`ZipFile` objects. Each object stores
information about a single member of the ZIP archive. information about a single member of the ZIP archive.
Instances have the following attributes: Instances have the following attributes:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment