Lines Matching +full:symbolic +full:- +full:ref
1 :mod:`tarfile` --- Read and write tar archive files
5 :synopsis: Read and write tar-format archive files.
15 --------------
20 higher-level functions in :ref:`shutil <archiving-operations>`.
27 * read/write support for the POSIX.1-1988 (ustar) format.
30 extensions, read-only support for the *sparse* extension.
32 * read/write support for the POSIX.1-2001 (pax) format.
36 * handles directories, regular files, hardlinks, symbolic links, fifos,
45 allowed, see :ref:`tarfile-objects`.
50 +------------------+---------------------------------------------+
55 +------------------+---------------------------------------------+
58 +------------------+---------------------------------------------+
60 +------------------+---------------------------------------------+
62 +------------------+---------------------------------------------+
65 +------------------+---------------------------------------------+
67 +------------------+---------------------------------------------+
69 +------------------+---------------------------------------------+
71 +------------------+---------------------------------------------+
93 not allow random access, see :ref:`tar-examples`. The currently
96 +-------------+--------------------------------------------+
101 +-------------+--------------------------------------------+
104 +-------------+--------------------------------------------+
107 +-------------+--------------------------------------------+
110 +-------------+--------------------------------------------+
112 +-------------+--------------------------------------------+
115 +-------------+--------------------------------------------+
118 +-------------+--------------------------------------------+
124 better use :func:`tarfile.open` instead. See :ref:`tarfile-objects`.
135 Class for limited access to tar archives with a :mod:`zipfile`\ -like interface.
173 Is raised for the limitations that are typical for stream-like :class:`TarFile`
179 Is raised for *non-fatal* errors when using :meth:`TarFile.extract`, but only if
187 The default character encoding: ``'utf-8'`` on Windows, the value returned by
199 :mod:`tarfile` module is able to create. See section :ref:`tar-formats` for
205 POSIX.1-1988 (ustar) format.
215 POSIX.1-2001 (pax) format.
228 :ref:`archiving-operations`
229 Documentation of the higher-level archiving facilities provided by the
236 .. _tarfile-objects:
239 ---------------
245 object, see :ref:`tarinfo-objects` for details.
251 :ref:`tar-examples` section for a use case.
287 If *dereference* is :const:`False`, add symbolic and hard links to the archive. If it
289 effect on systems that do not support symbolic links.
301 :exc:`IOError` exceptions. If ``2``, all *non-fatal* errors are raised as
306 See section :ref:`tar-unicode` for in-depth information.
330 to be the most up-to-date version.
349 similar to that of :program:`ls -l` is produced.
399 or a :class:`TarInfo` object. If *member* is a regular file, a file-like object
400 is returned. If *member* is a link, a file-like object is constructed from the
405 The file-like object is read-only. It provides the methods
413 fifo, symbolic link, etc.). If given, *arcname* specifies an alternative name
421 object will be excluded from the archive. See :ref:`tar-examples` for an
487 A dictionary containing key-value pairs of pax global headers.
492 .. _tarinfo-objects:
495 ---------------
595 A dictionary containing key-value pairs of an associated pax extended header.
619 Return :const:`True` if it is a symbolic link.
647 .. _tar-examples:
650 --------
716 .. _tar-formats:
719 ---------------------
723 * The POSIX.1-1988 ustar format (:const:`USTAR_FORMAT`). It supports filenames
731 extensions for long names, sparse file support is read-only.
733 * The POSIX.1-2001 pax format (:const:`PAX_FORMAT`). It is the most flexible
742 the data in a pax header is encoded in *UTF-8* for portability reasons.
750 miscalculated header checksums in case of fields with non-ASCII characters.
752 * The SunOS tar extended format. This format is a variant of the POSIX.1-2001
755 .. _tar-unicode:
758 --------------
765 example, an ordinary tar archive created on a *UTF-8* system cannot be read
766 correctly on a *Latin-1* system if it contains non-ASCII characters. Names (i.e.
771 The pax format was designed to solve this problem. It stores non-ASCII names
772 using the universal character encoding *UTF-8*. When a pax archive is read,
773 these *UTF-8* names are converted to the encoding of the local file system.
783 input names that contain non-ASCII characters need to be decoded before being
784 stored as *UTF-8* strings. The other formats do not make use of *encoding*
785 unless unicode objects are used as input names. These are converted to 8-bit
790 :ref:`codec-base-classes`. In read mode, there is an additional scheme
791 ``'utf-8'`` which means that bad characters are replaced by their *UTF-8*