mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge: #14056: Small improvements to the tarfile documentation.

This commit is contained in:
R David Murray 2014-10-03 20:19:09 -04:00
parent 91b62c4a8a bf92bceaaa
commit 84bf989cc2
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Doc/library/tarfile.rst
View File

@ -19,7 +19,8 @@ higher-level functions in :ref:`shutil <archiving-operations>`.
Some facts and figures: Some facts and figures:
* reads and writes :mod:`gzip`, :mod:`bz2` and :mod:`lzma` compressed archives. * reads and writes :mod:`gzip`, :mod:`bz2` and :mod:`lzma` compressed archives
if the respective modules are available.
* read/write support for the POSIX.1-1988 (ustar) format. * read/write support for the POSIX.1-1988 (ustar) format.
@ -176,6 +177,13 @@ The :mod:`tarfile` module defines the following exceptions:
Is raised by :meth:`TarInfo.frombuf` if the buffer it gets is invalid. Is raised by :meth:`TarInfo.frombuf` if the buffer it gets is invalid.
The following constants are available at the module level:
.. data:: ENCODING
The default character encoding: ``'utf-8'`` on Windows, the value returned by
:func:`sys.getfilesystemencoding` otherwise.
Each of the following constants defines a tar archive format that the Each of the following constants defines a tar archive format that the
:mod:`tarfile` module is able to create. See section :ref:`tar-formats` for :mod:`tarfile` module is able to create. See section :ref:`tar-formats` for
@ -202,20 +210,15 @@ details.
The default format for creating archives. This is currently :const:`GNU_FORMAT`. The default format for creating archives. This is currently :const:`GNU_FORMAT`.
The following variables are available on module level:
.. data:: ENCODING
The default character encoding: ``'utf-8'`` on Windows,
:func:`sys.getfilesystemencoding` otherwise.
.. seealso:: .. seealso::
Module :mod:`zipfile` Module :mod:`zipfile`
Documentation of the :mod:`zipfile` standard module. Documentation of the :mod:`zipfile` standard module.
:ref:`archiving-operations`
Documentation of the higher-level archiving facilities provided by the
standard :mod:`shutil` module.
`GNU tar manual, Basic Tar Format <http://www.gnu.org/software/tar/manual/html_node/Standard.html>`_ `GNU tar manual, Basic Tar Format <http://www.gnu.org/software/tar/manual/html_node/Standard.html>`_
Documentation for tar archive files, including GNU tar extensions. Documentation for tar archive files, including GNU tar extensions.