summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2007-11-05 19:43:04 (GMT)
committerGuido van Rossum <guido@python.org>2007-11-05 19:43:04 (GMT)
commit7767711f543b39a5a5e2e377e0eee33a0e50f700 (patch)
tree67a05ffaba8f500e48ccf16d451a7999576ea5da /Doc/library
parentc4cb3b8aa14540f730f82f64add243d6ba8b6fcd (diff)
downloadcpython-7767711f543b39a5a5e2e377e0eee33a0e50f700.zip
cpython-7767711f543b39a5a5e2e377e0eee33a0e50f700.tar.gz
cpython-7767711f543b39a5a5e2e377e0eee33a0e50f700.tar.bz2
Merged revisions 58817-58861 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r58822 | brett.cannon | 2007-11-02 23:47:02 -0700 (Fri, 02 Nov 2007) | 2 lines Add a missing quotation mark. ........ r58840 | skip.montanaro | 2007-11-04 07:56:52 -0800 (Sun, 04 Nov 2007) | 2 lines Note change to get_dialect semantics in 2.5. Will backport to 2.5. ........ r58844 | georg.brandl | 2007-11-04 09:43:49 -0800 (Sun, 04 Nov 2007) | 2 lines Fix syntax for versionchanged markup. ........ r58850 | gregory.p.smith | 2007-11-04 18:32:26 -0800 (Sun, 04 Nov 2007) | 9 lines Fixes bug 477182 on pybsddb.sf.net. DB objects now load the flags and pay attention to them when opening an existing database. This means that d[] behaves properly even on databases previously created with DB_DUP or DB_DUPSORT flags to allow duplicate keys. http://sourceforge.net/tracker/index.php?func=detail&aid=477182&group_id=13900&atid=113900 Do not backport, this bugfix could be considered an API change. ........ r58851 | gregory.p.smith | 2007-11-04 18:56:31 -0800 (Sun, 04 Nov 2007) | 3 lines Add the bsddb.db.DBEnv.lock_id_free method. Improve test_lock's tempdir creation and cleanup. ........ r58852 | gregory.p.smith | 2007-11-05 01:06:28 -0800 (Mon, 05 Nov 2007) | 3 lines * db->get_types is only available in BerkeleyDB >= 4.2 * get compiling with older versions of python again for a stand alone release. ........ r58853 | gregory.p.smith | 2007-11-05 01:07:40 -0800 (Mon, 05 Nov 2007) | 2 lines * db->get_flags is only available in BerkeleyDB >= 4.2 ........ r58854 | mark.summerfield | 2007-11-05 01:22:48 -0800 (Mon, 05 Nov 2007) | 3 lines Added cross-references between the various archive file formats. ........ r58857 | mark.summerfield | 2007-11-05 06:38:50 -0800 (Mon, 05 Nov 2007) | 5 lines Clarified the fact that you can have comments for individual archive members even though comments to the archive itself aren't currently supported. ........
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/bz2.rst9
-rw-r--r--Doc/library/csv.rst4
-rw-r--r--Doc/library/gzip.rst3
-rw-r--r--Doc/library/tarfile.rst7
-rw-r--r--Doc/library/zipfile.rst20
-rw-r--r--Doc/library/zlib.rst4
6 files changed, 33 insertions, 14 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index 73fd450..ff3c773 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -12,7 +12,10 @@ This module provides a comprehensive interface for the bz2 compression library.
It implements a complete file interface, one-shot (de)compression functions, and
types for sequential (de)compression.
-Here is a resume of the features offered by the bz2 module:
+For other archive formats, see the :mod:`gzip`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
+Here is a summary of the features offered by the bz2 module:
* :class:`BZ2File` class implements a complete file interface, including
:meth:`readline`, :meth:`readlines`, :meth:`writelines`, :meth:`seek`, etc;
@@ -30,9 +33,7 @@ Here is a resume of the features offered by the bz2 module:
* One-shot (de)compression supported by :func:`compress` and :func:`decompress`
functions;
-* Thread safety uses individual locking mechanism;
-
-* Complete inline documentation;
+* Thread safety uses individual locking mechanism.
(De)compression of files
diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
index 598dc50..5e1bd1e 100644
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -124,6 +124,10 @@ The :mod:`csv` module defines the following functions:
Return the dialect associated with *name*. An :exc:`Error` is raised if *name*
is not a registered dialect name.
+ .. versionchanged:: 2.5
+ This function now returns an immutable :class:`Dialect`. Previously an
+ instance of the requested dialect was returned. Users could modify the
+ underlying class, changing the behavior of active readers and writers.
.. function:: list_dialects()
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
index 5978031..d298f88 100644
--- a/Doc/library/gzip.rst
+++ b/Doc/library/gzip.rst
@@ -15,6 +15,9 @@ formats which can be decompressed by the :program:`gzip` and :program:`gunzip`
programs, such as those produced by :program:`compress` and :program:`pack`,
are not supported by this module.
+For other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
The module defines the following items:
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 4aabd81..7893ccd 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -11,10 +11,13 @@
.. sectionauthor:: Lars Gustäbel <lars@gustaebel.de>
-The :mod:`tarfile` module makes it possible to read and create tar archives.
+The :mod:`tarfile` module makes it possible to read and write tar
+archives, including those using gzip or bz2 compression.
+(`.zip` files can be read and written using the :mod:`zipfile` module.)
+
Some facts and figures:
-* reads and writes :mod:`gzip` and :mod:`bzip2` compressed archives.
+* reads and writes :mod:`gzip` and :mod:`bz2` compressed archives.
* read/write support for the POSIX.1-1988 (ustar) format.
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 92a4526..6c946f8 100644
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -16,14 +16,18 @@ advanced use of this module will require an understanding of the format, as
defined in `PKZIP Application Note
<http://www.pkware.com/business_and_developers/developer/appnote/>`_.
-This module does not currently handle ZIP files which have appended comments, or
-multi-disk ZIP files. It can handle ZIP files that use the ZIP64 extensions
-(that is ZIP files that are more than 4 GByte in size). It supports decryption
-of encrypted files in ZIP archives, but it cannot currently create an encrypted
-file.
-
-The available attributes of this module are:
-
+This module does not currently handle multi-disk ZIP files, or ZIP files
+which have appended comments (although it correctly handles comments
+added to individual archive members---for which see the :ref:`zipinfo-objects`
+documentation). It can handle ZIP files that use the ZIP64 extensions
+(that is ZIP files that are more than 4 GByte in size). It supports
+decryption of encrypted files in ZIP archives, but it currently cannot
+create an encrypted file.
+
+For other archive formats, see the :mod:`bz2`, :mod:`gzip`, and
+:mod:`tarfile` modules.
+
+The module defines the following items:
.. exception:: BadZipfile
diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
index 3f051a7..449394c 100644
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -19,6 +19,10 @@ order. This documentation doesn't attempt to cover all of the permutations;
consult the zlib manual at http://www.zlib.net/manual.html for authoritative
information.
+For reading and writing ``.gz`` files see the :mod:`gzip` module. For
+other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
The available exception and functions in this module are: