summaryrefslogtreecommitdiffstats
path: root/Doc/library/tarfile.rst
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-12-18 06:57:45 (GMT)
committerGitHub <noreply@github.com>2023-12-18 06:57:45 (GMT)
commitf428c4dafbfa2425ea056e7f2ed2ea45fa90be87 (patch)
tree7da924ce3df4a213230b1384cbb9d5dd1ecc6f41 /Doc/library/tarfile.rst
parent2b93f5224216d10f8119373e72b5c2b3984e0af6 (diff)
downloadcpython-f428c4dafbfa2425ea056e7f2ed2ea45fa90be87.zip
cpython-f428c4dafbfa2425ea056e7f2ed2ea45fa90be87.tar.gz
cpython-f428c4dafbfa2425ea056e7f2ed2ea45fa90be87.tar.bz2
gh-101100: Fix Sphinx warnings in library/tarfile.rst (#113237)
Fix Sphinx warnings in library/tarfile.rst
Diffstat (limited to 'Doc/library/tarfile.rst')
-rw-r--r--Doc/library/tarfile.rst67
1 files changed, 56 insertions, 11 deletions
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 3e5723a..f4e83d6 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -116,7 +116,7 @@ Some facts and figures:
``'filemode|[compression]'``. :func:`tarfile.open` will return a :class:`TarFile`
object that processes its data as a stream of blocks. No random seeking will
be done on the file. If given, *fileobj* may be any object that has a
- :meth:`read` or :meth:`write` method (depending on the *mode*). *bufsize*
+ :meth:`~io.TextIOBase.read` or :meth:`~io.TextIOBase.write` method (depending on the *mode*). *bufsize*
specifies the blocksize and defaults to ``20 * 512`` bytes. Use this variant
in combination with e.g. ``sys.stdin``, a socket :term:`file object` or a tape
device. However, such a :class:`TarFile` object is limited in that it does
@@ -255,6 +255,51 @@ The following constants are available at the module level:
The default character encoding: ``'utf-8'`` on Windows, the value returned by
:func:`sys.getfilesystemencoding` otherwise.
+.. data:: REGTYPE
+ AREGTYPE
+
+ A regular file :attr:`~TarInfo.type`.
+
+.. data:: LNKTYPE
+
+ A link (inside tarfile) :attr:`~TarInfo.type`.
+
+.. data:: SYMTYPE
+
+ A symbolic link :attr:`~TarInfo.type`.
+
+.. data:: CHRTYPE
+
+ A character special device :attr:`~TarInfo.type`.
+
+.. data:: BLKTYPE
+
+ A block special device :attr:`~TarInfo.type`.
+
+.. data:: DIRTYPE
+
+ A directory :attr:`~TarInfo.type`.
+
+.. data:: FIFOTYPE
+
+ A FIFO special device :attr:`~TarInfo.type`.
+
+.. data:: CONTTYPE
+
+ A contiguous file :attr:`~TarInfo.type`.
+
+.. data:: GNUTYPE_LONGNAME
+
+ A GNU tar longname :attr:`~TarInfo.type`.
+
+.. data:: GNUTYPE_LONGLINK
+
+ A GNU tar longlink :attr:`~TarInfo.type`.
+
+.. data:: GNUTYPE_SPARSE
+
+ A GNU tar sparse file :attr:`~TarInfo.type`.
+
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
@@ -325,7 +370,7 @@ be finalized; only the internally used file object will be closed. See the
*name* is the pathname of the archive. *name* may be a :term:`path-like object`.
It can be omitted if *fileobj* is given.
- In this case, the file object's :attr:`name` attribute is used if it exists.
+ In this case, the file object's :attr:`!name` attribute is used if it exists.
*mode* is either ``'r'`` to read from an existing archive, ``'a'`` to append
data to an existing file, ``'w'`` to create a new file overwriting an existing
@@ -359,7 +404,7 @@ be finalized; only the internally used file object will be closed. See the
messages). The messages are written to ``sys.stderr``.
*errorlevel* controls how extraction errors are handled,
- see :attr:`the corresponding attribute <~TarFile.errorlevel>`.
+ see :attr:`the corresponding attribute <TarFile.errorlevel>`.
The *encoding* and *errors* arguments define the character encoding to be
used for reading or writing the archive and how conversion errors are going
@@ -645,8 +690,8 @@ It does *not* contain the file's data itself.
:meth:`~TarFile.getmember`, :meth:`~TarFile.getmembers` and
:meth:`~TarFile.gettarinfo`.
-Modifying the objects returned by :meth:`~!TarFile.getmember` or
-:meth:`~!TarFile.getmembers` will affect all subsequent
+Modifying the objects returned by :meth:`~TarFile.getmember` or
+:meth:`~TarFile.getmembers` will affect all subsequent
operations on the archive.
For cases where this is unwanted, you can use :mod:`copy.copy() <copy>` or
call the :meth:`~TarInfo.replace` method to create a modified copy in one step.
@@ -795,8 +840,8 @@ A ``TarInfo`` object has the following public data attributes:
A dictionary containing key-value pairs of an associated pax extended header.
-.. method:: TarInfo.replace(name=..., mtime=..., mode=..., linkname=...,
- uid=..., gid=..., uname=..., gname=...,
+.. method:: TarInfo.replace(name=..., mtime=..., mode=..., linkname=..., \
+ uid=..., gid=..., uname=..., gname=..., \
deep=True)
.. versionadded:: 3.12
@@ -816,7 +861,7 @@ A :class:`TarInfo` object also provides some convenient query methods:
.. method:: TarInfo.isfile()
- Return :const:`True` if the :class:`Tarinfo` object is a regular file.
+ Return :const:`True` if the :class:`TarInfo` object is a regular file.
.. method:: TarInfo.isreg()
@@ -952,7 +997,7 @@ reused in custom filters:
path (after following symlinks) would end up outside the destination.
This raises :class:`~tarfile.OutsideDestinationError`.
- Clear high mode bits (setuid, setgid, sticky) and group/other write bits
- (:const:`~stat.S_IWGRP`|:const:`~stat.S_IWOTH`).
+ (:const:`~stat.S_IWGRP` | :const:`~stat.S_IWOTH`).
Return the modified ``TarInfo`` member.
@@ -977,9 +1022,9 @@ reused in custom filters:
- For regular files, including hard links:
- Set the owner read and write permissions
- (:const:`~stat.S_IRUSR`|:const:`~stat.S_IWUSR`).
+ (:const:`~stat.S_IRUSR` | :const:`~stat.S_IWUSR`).
- Remove the group & other executable permission
- (:const:`~stat.S_IXGRP`|:const:`~stat.S_IXOTH`)
+ (:const:`~stat.S_IXGRP` | :const:`~stat.S_IXOTH`)
if the owner doesn’t have it (:const:`~stat.S_IXUSR`).
- For other files (directories), set ``mode`` to ``None``, so