Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : tarfile.html

<!DOCTYPE html>

<title>tarfile — Read and write tar archive files &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="File Formats" href="fileformats.html" />
 <link rel="prev" title="zipfile — Work with ZIP archives" href="zipfile.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/tarfile.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</a><ul>
<li><a class="reference internal" href="#tarfile-objects">TarFile Objects</a></li>
<li><a class="reference internal" href="#tarinfo-objects">TarInfo Objects</a></li>
<li><a class="reference internal" href="#extraction-filters">Extraction filters</a><ul>
<li><a class="reference internal" href="#default-named-filters">Default named filters</a></li>
<li><a class="reference internal" href="#filter-errors">Filter errors</a></li>
<li><a class="reference internal" href="#hints-for-further-verification">Hints for further verification</a></li>
<li><a class="reference internal" href="#supporting-older-python-versions">Supporting older Python versions</a></li>
<li><a class="reference internal" href="#stateful-extraction-filter-example">Stateful extraction filter example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#command-line-interface">Command-Line Interface</a><ul>
<li><a class="reference internal" href="#command-line-options">Command-line options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#supported-tar-formats">Supported tar formats</a></li>
<li><a class="reference internal" href="#unicode-issues">Unicode issues</a></li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="fileformats.html" title="File Formats"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="zipfile.html" title="zipfile — Work with ZIP archives"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="archiving.html" accesskey="U">Data Compression and Archiving</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-tarfile">
<h1><a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> — Read and write tar archive files<a class="headerlink" href="#module-tarfile" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/tarfile.py">Lib/tarfile.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module makes it possible to read and write tar
archives, including those using gzip, bz2 and lzma compression.
Use the <a class="reference internal" href="zipfile.html#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> module to read or write <code class="file docutils literal notranslate">.zip</code> files, or the
higher-level functions in <a class="reference internal" href="shutil.html#archiving-operations">shutil</a>.
Some facts and figures:
<ul class="simple">
<li>reads and writes <a class="reference internal" href="gzip.html#module-gzip" title="gzip: Interfaces for gzip compression and decompression using file objects."><code class="xref py py-mod docutils literal notranslate">gzip</code></a>, <a class="reference internal" href="bz2.html#module-bz2" title="bz2: Interfaces for bzip2 compression and decompression."><code class="xref py py-mod docutils literal notranslate">bz2</code></a> and <a class="reference internal" href="lzma.html#module-lzma" title="lzma: A Python wrapper for the liblzma compression library."><code class="xref py py-mod docutils literal notranslate">lzma</code></a> compressed archives
if the respective modules are available.</li>
<li>read/write support for the POSIX.1-1988 (ustar) format.</li>
<li>read/write support for the GNU tar format including longname and longlink
extensions, read-only support for all variants of the sparse extension
including restoration of sparse files.</li>
<li>read/write support for the POSIX.1-2001 (pax) format.</li>
<li>handles directories, regular files, hardlinks, symbolic links, fifos,
character devices and block devices and is able to acquire and restore file
information like timestamp, access permissions and owner.</li>
</ul>
<div class="versionchanged">
Changed in version 3.3: Added support for <a class="reference internal" href="lzma.html#module-lzma" title="lzma: A Python wrapper for the liblzma compression library."><code class="xref py py-mod docutils literal notranslate">lzma</code></a> compression.
</div>
<dl class="py function">
<dt class="sig sig-object py" id="tarfile.open">
tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)<a class="headerlink" href="#tarfile.open" title="Permalink to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> object for the pathname name. For detailed
information on <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> objects and the keyword arguments that are
allowed, see <a class="reference internal" href="#tarfile-objects">TarFile Objects</a>.
mode has to be a string of the form <code class="docutils literal notranslate">'filemode[:compression]'</code>, it defaults
to <code class="docutils literal notranslate">'r'</code>. Here is a full list of mode combinations:
<table class="docutils align-default">
<colgroup>
<col style="width: 29%" />
<col style="width: 71%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">mode</th>
<th class="head">action</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">'r' or 'r:*'</code></td>
<td>Open for reading with transparent
compression (recommended).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'r:'</code></td>
<td>Open for reading exclusively without
compression.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'r:gz'</code></td>
<td>Open for reading with gzip compression.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'r:bz2'</code></td>
<td>Open for reading with bzip2 compression.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'r:xz'</code></td>
<td>Open for reading with lzma compression.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'x'</code> or
<code class="docutils literal notranslate">'x:'</code></td>
<td>Create a tarfile exclusively without
compression.
Raise an <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> exception
if it already exists.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'x:gz'</code></td>
<td>Create a tarfile with gzip compression.
Raise an <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> exception
if it already exists.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'x:bz2'</code></td>
<td>Create a tarfile with bzip2 compression.
Raise an <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> exception
if it already exists.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'x:xz'</code></td>
<td>Create a tarfile with lzma compression.
Raise an <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> exception
if it already exists.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'a' or 'a:'</code></td>
<td>Open for appending with no compression. The
file is created if it does not exist.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'w' or 'w:'</code></td>
<td>Open for uncompressed writing.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'w:gz'</code></td>
<td>Open for gzip compressed writing.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'w:bz2'</code></td>
<td>Open for bzip2 compressed writing.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'w:xz'</code></td>
<td>Open for lzma compressed writing.</td>
</tr>
</tbody>
</table>
Note that <code class="docutils literal notranslate">'a:gz'</code>, <code class="docutils literal notranslate">'a:bz2'</code> or <code class="docutils literal notranslate">'a:xz'</code> is not possible. If mode
is not suitable to open a certain (compressed) file for reading,
<a class="reference internal" href="#tarfile.ReadError" title="tarfile.ReadError"><code class="xref py py-exc docutils literal notranslate">ReadError</code></a> is raised. Use mode <code class="docutils literal notranslate">'r'</code> to avoid this. If a
compression method is not supported, <a class="reference internal" href="#tarfile.CompressionError" title="tarfile.CompressionError"><code class="xref py py-exc docutils literal notranslate">CompressionError</code></a> is raised.
If fileobj is specified, it is used as an alternative to a <a class="reference internal" href="../glossary.html#term-file-object">file object</a>
opened in binary mode for name. It is supposed to be at position 0.
For modes <code class="docutils literal notranslate">'w:gz'</code>, <code class="docutils literal notranslate">'r:gz'</code>, <code class="docutils literal notranslate">'w:bz2'</code>, <code class="docutils literal notranslate">'r:bz2'</code>, <code class="docutils literal notranslate">'x:gz'</code>,
<code class="docutils literal notranslate">'x:bz2'</code>, <a class="reference internal" href="#tarfile.open" title="tarfile.open"><code class="xref py py-func docutils literal notranslate">tarfile.open()</code></a> accepts the keyword argument
compresslevel (default <code class="docutils literal notranslate">9</code>) to specify the compression level of the file.
For modes <code class="docutils literal notranslate">'w:xz'</code> and <code class="docutils literal notranslate">'x:xz'</code>, <a class="reference internal" href="#tarfile.open" title="tarfile.open"><code class="xref py py-func docutils literal notranslate">tarfile.open()</code></a> accepts the
keyword argument preset to specify the compression level of the file.
For special purposes, there is a second format for mode:
<code class="docutils literal notranslate">'filemode|[compression]'</code>. <a class="reference internal" href="#tarfile.open" title="tarfile.open"><code class="xref py py-func docutils literal notranslate">tarfile.open()</code></a> will return a <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a>
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
<code class="xref py py-meth docutils literal notranslate">read()</code> or <code class="xref py py-meth docutils literal notranslate">write()</code> method (depending on the mode). bufsize
specifies the blocksize and defaults to <code class="docutils literal notranslate">20 * 512</code> bytes. Use this variant
in combination with e.g. <code class="docutils literal notranslate">sys.stdin</code>, a socket <a class="reference internal" href="../glossary.html#term-file-object">file object</a> or a tape
device. However, such a <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> object is limited in that it does
not allow random access, see <a class="reference internal" href="#tar-examples">Examples</a>. The currently
possible modes:
<table class="docutils align-default">
<colgroup>
<col style="width: 23%" />
<col style="width: 77%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Mode</th>
<th class="head">Action</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">'r|*'</code></td>
<td>Open a stream of tar blocks for reading
with transparent compression.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'r|'</code></td>
<td>Open a stream of uncompressed tar blocks
for reading.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'r|gz'</code></td>
<td>Open a gzip compressed stream for
reading.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'r|bz2'</code></td>
<td>Open a bzip2 compressed stream for
reading.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'r|xz'</code></td>
<td>Open an lzma compressed stream for
reading.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'w|'</code></td>
<td>Open an uncompressed stream for writing.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'w|gz'</code></td>
<td>Open a gzip compressed stream for
writing.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">'w|bz2'</code></td>
<td>Open a bzip2 compressed stream for
writing.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">'w|xz'</code></td>
<td>Open an lzma compressed stream for
writing.</td>
</tr>
</tbody>
</table>
<div class="versionchanged">
Changed in version 3.5: The <code class="docutils literal notranslate">'x'</code> (exclusive creation) mode was added.
</div>
<div class="versionchanged">
Changed in version 3.6: The name parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py">
class tarfile.TarFile</dt>
<dd>Class for reading and writing tar archives. Do not use this class directly:
use <a class="reference internal" href="#tarfile.open" title="tarfile.open"><code class="xref py py-func docutils literal notranslate">tarfile.open()</code></a> instead. See <a class="reference internal" href="#tarfile-objects">TarFile Objects</a>.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tarfile.is_tarfile">
tarfile.is_tarfile(name)<a class="headerlink" href="#tarfile.is_tarfile" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if name is a tar archive file, that the <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a>
module can read. name may be a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>, file, or file-like object.
<div class="versionchanged">
Changed in version 3.9: Support for file and file-like objects.
</div>
</dd></dl>

The <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module defines the following exceptions:
<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.TarError">
exception tarfile.TarError<a class="headerlink" href="#tarfile.TarError" title="Permalink to this definition">¶</a></dt>
<dd>Base class for all <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> exceptions.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.ReadError">
exception tarfile.ReadError<a class="headerlink" href="#tarfile.ReadError" title="Permalink to this definition">¶</a></dt>
<dd>Is raised when a tar archive is opened, that either cannot be handled by the
<a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module or is somehow invalid.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.CompressionError">
exception tarfile.CompressionError<a class="headerlink" href="#tarfile.CompressionError" title="Permalink to this definition">¶</a></dt>
<dd>Is raised when a compression method is not supported or when the data cannot be
decoded properly.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.StreamError">
exception tarfile.StreamError<a class="headerlink" href="#tarfile.StreamError" title="Permalink to this definition">¶</a></dt>
<dd>Is raised for the limitations that are typical for stream-like <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a>
objects.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.ExtractError">
exception tarfile.ExtractError<a class="headerlink" href="#tarfile.ExtractError" title="Permalink to this definition">¶</a></dt>
<dd>Is raised for non-fatal errors when using <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">TarFile.extract()</code></a>, but only if
<a class="reference internal" href="#tarfile.TarFile.errorlevel" title="tarfile.TarFile.errorlevel"><code class="xref py py-attr docutils literal notranslate">TarFile.errorlevel</code></a><code class="docutils literal notranslate">== 2</code>.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.HeaderError">
exception tarfile.HeaderError<a class="headerlink" href="#tarfile.HeaderError" title="Permalink to this definition">¶</a></dt>
<dd>Is raised by <a class="reference internal" href="#tarfile.TarInfo.frombuf" title="tarfile.TarInfo.frombuf"><code class="xref py py-meth docutils literal notranslate">TarInfo.frombuf()</code></a> if the buffer it gets is invalid.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.FilterError">
exception tarfile.FilterError<a class="headerlink" href="#tarfile.FilterError" title="Permalink to this definition">¶</a></dt>
<dd>Base class for members <a class="reference internal" href="#tarfile-extraction-refuse">refused</a> by
filters.
<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.FilterError.tarinfo">
tarinfo<a class="headerlink" href="#tarfile.FilterError.tarinfo" title="Permalink to this definition">¶</a></dt>
<dd>Information about the member that the filter refused to extract,
as <a class="reference internal" href="#tarinfo-objects">TarInfo</a>.
</dd></dl>

</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.AbsolutePathError">
exception tarfile.AbsolutePathError<a class="headerlink" href="#tarfile.AbsolutePathError" title="Permalink to this definition">¶</a></dt>
<dd>Raised to refuse extracting a member with an absolute path.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.OutsideDestinationError">
exception tarfile.OutsideDestinationError<a class="headerlink" href="#tarfile.OutsideDestinationError" title="Permalink to this definition">¶</a></dt>
<dd>Raised to refuse extracting a member outside the destination directory.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.SpecialFileError">
exception tarfile.SpecialFileError<a class="headerlink" href="#tarfile.SpecialFileError" title="Permalink to this definition">¶</a></dt>
<dd>Raised to refuse extracting a special file (e.g. a device or pipe).
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.AbsoluteLinkError">
exception tarfile.AbsoluteLinkError<a class="headerlink" href="#tarfile.AbsoluteLinkError" title="Permalink to this definition">¶</a></dt>
<dd>Raised to refuse extracting a symbolic link with an absolute path.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="tarfile.LinkOutsideDestinationError">
exception tarfile.LinkOutsideDestinationError<a class="headerlink" href="#tarfile.LinkOutsideDestinationError" title="Permalink to this definition">¶</a></dt>
<dd>Raised to refuse extracting a symbolic link pointing outside the destination
directory.
</dd></dl>

The following constants are available at the module level:
<dl class="py data">
<dt class="sig sig-object py" id="tarfile.ENCODING">
tarfile.ENCODING<a class="headerlink" href="#tarfile.ENCODING" title="Permalink to this definition">¶</a></dt>
<dd>The default character encoding: <code class="docutils literal notranslate">'utf-8'</code> on Windows, the value returned by
<a class="reference internal" href="sys.html#sys.getfilesystemencoding" title="sys.getfilesystemencoding"><code class="xref py py-func docutils literal notranslate">sys.getfilesystemencoding()</code></a> otherwise.
</dd></dl>

Each of the following constants defines a tar archive format that the
<a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module is able to create. See section <a class="reference internal" href="#tar-formats">Supported tar formats</a> for
details.
<dl class="py data">
<dt class="sig sig-object py" id="tarfile.USTAR_FORMAT">
tarfile.USTAR_FORMAT<a class="headerlink" href="#tarfile.USTAR_FORMAT" title="Permalink to this definition">¶</a></dt>
<dd>POSIX.1-1988 (ustar) format.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="tarfile.GNU_FORMAT">
tarfile.GNU_FORMAT<a class="headerlink" href="#tarfile.GNU_FORMAT" title="Permalink to this definition">¶</a></dt>
<dd>GNU tar format.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="tarfile.PAX_FORMAT">
tarfile.PAX_FORMAT<a class="headerlink" href="#tarfile.PAX_FORMAT" title="Permalink to this definition">¶</a></dt>
<dd>POSIX.1-2001 (pax) format.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="tarfile.DEFAULT_FORMAT">
tarfile.DEFAULT_FORMAT<a class="headerlink" href="#tarfile.DEFAULT_FORMAT" title="Permalink to this definition">¶</a></dt>
<dd>The default format for creating archives. This is currently <a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a>.
<div class="versionchanged">
Changed in version 3.8: The default format for new archives was changed to
<a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a> from <a class="reference internal" href="#tarfile.GNU_FORMAT" title="tarfile.GNU_FORMAT"><code class="xref py py-const docutils literal notranslate">GNU_FORMAT</code></a>.
</div>
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt>Module <a class="reference internal" href="zipfile.html#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a></dt><dd>Documentation of the <a class="reference internal" href="zipfile.html#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> standard module.
</dd>
<dt><a class="reference internal" href="shutil.html#archiving-operations">Archiving operations</a></dt><dd>Documentation of the higher-level archiving facilities provided by the
standard <a class="reference internal" href="shutil.html#module-shutil" title="shutil: High-level file operations, including copying."><code class="xref py py-mod docutils literal notranslate">shutil</code></a> module.
</dd>
<dt><a class="reference external" href="https://www.gnu.org/software/tar/manual/html_node/Standard.html">GNU tar manual, Basic Tar Format</a></dt><dd>Documentation for tar archive files, including GNU tar extensions.
</dd>
</dl>
</div>
<section id="tarfile-objects">
<h2>TarFile Objects<a class="headerlink" href="#tarfile-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> object provides an interface to a tar archive. A tar
archive is a sequence of blocks. An archive member (a stored file) is made up of
a header block followed by data blocks. It is possible to store a file in a tar
archive several times. Each archive member is represented by a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a>
object, see <a class="reference internal" href="#tarinfo-objects">TarInfo Objects</a> for details.
A <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> object can be used as a context manager in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statement. It will automatically be closed when the block is completed. Please
note that in the event of an exception an archive opened for writing will not
be finalized; only the internally used file object will be closed. See the
<a class="reference internal" href="#tar-examples">Examples</a> section for a use case.
<div class="versionadded">
New in version 3.2: Added support for the context management protocol.
</div>
<dl class="py class">
<dt class="sig sig-object py" id="tarfile.TarFile">
class tarfile.TarFile(name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=1)<a class="headerlink" href="#tarfile.TarFile" title="Permalink to this definition">¶</a></dt>
<dd>All following arguments are optional and can be accessed as instance attributes
as well.
name is the pathname of the archive. name may be a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
It can be omitted if fileobj is given.
In this case, the file object’s <code class="xref py py-attr docutils literal notranslate">name</code> attribute is used if it exists.
mode is either <code class="docutils literal notranslate">'r'</code> to read from an existing archive, <code class="docutils literal notranslate">'a'</code> to append
data to an existing file, <code class="docutils literal notranslate">'w'</code> to create a new file overwriting an existing
one, or <code class="docutils literal notranslate">'x'</code> to create a new file only if it does not already exist.
If fileobj is given, it is used for reading or writing data. If it can be
determined, mode is overridden by fileobj’s mode. fileobj will be used
from position 0.
<div class="admonition note">
Note
fileobj is not closed, when <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> is closed.
</div>
format controls the archive format for writing. It must be one of the constants
<a class="reference internal" href="#tarfile.USTAR_FORMAT" title="tarfile.USTAR_FORMAT"><code class="xref py py-const docutils literal notranslate">USTAR_FORMAT</code></a>, <a class="reference internal" href="#tarfile.GNU_FORMAT" title="tarfile.GNU_FORMAT"><code class="xref py py-const docutils literal notranslate">GNU_FORMAT</code></a> or <a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a> that are
defined at module level. When reading, format will be automatically detected, even
if different formats are present in a single archive.
The tarinfo argument can be used to replace the default <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> class
with a different one.
If dereference is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>, add symbolic and hard links to the archive. If it
is <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>, add the content of the target files to the archive. This has no
effect on systems that do not support symbolic links.
If ignore_zeros is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>, treat an empty block as the end of the archive.
If it is <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>, skip empty (and invalid) blocks and try to get as many members
as possible. This is only useful for reading concatenated or damaged archives.
debug can be set from <code class="docutils literal notranslate">0</code> (no debug messages) up to <code class="docutils literal notranslate">3</code> (all debug
messages). The messages are written to <code class="docutils literal notranslate">sys.stderr</code>.
errorlevel controls how extraction errors are handled,
see <code class="xref py py-attr docutils literal notranslate">the corresponding attribute</code>.
The encoding and errors arguments define the character encoding to be
used for reading or writing the archive and how conversion errors are going
to be handled. The default settings will work for most users.
See section <a class="reference internal" href="#tar-unicode">Unicode issues</a> for in-depth information.
The pax_headers argument is an optional dictionary of strings which
will be added as a pax global header if format is <a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a>.
<div class="versionchanged">
Changed in version 3.2: Use <code class="docutils literal notranslate">'surrogateescape'</code> as the default for the errors argument.
</div>
<div class="versionchanged">
Changed in version 3.5: The <code class="docutils literal notranslate">'x'</code> (exclusive creation) mode was added.
</div>
<div class="versionchanged">
Changed in version 3.6: The name parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.open">
classmethod TarFile.open(...)<a class="headerlink" href="#tarfile.TarFile.open" title="Permalink to this definition">¶</a></dt>
<dd>Alternative constructor. The <a class="reference internal" href="#tarfile.open" title="tarfile.open"><code class="xref py py-func docutils literal notranslate">tarfile.open()</code></a> function is actually a
shortcut to this classmethod.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.getmember">
TarFile.getmember(name)<a class="headerlink" href="#tarfile.TarFile.getmember" title="Permalink to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object for member name. If name can not be found
in the archive, <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a> is raised.
<div class="admonition note">
Note
If a member occurs more than once in the archive, its last occurrence is assumed
to be the most up-to-date version.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.getmembers">
TarFile.getmembers()<a class="headerlink" href="#tarfile.TarFile.getmembers" title="Permalink to this definition">¶</a></dt>
<dd>Return the members of the archive as a list of <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> objects. The
list has the same order as the members in the archive.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.getnames">
TarFile.getnames()<a class="headerlink" href="#tarfile.TarFile.getnames" title="Permalink to this definition">¶</a></dt>
<dd>Return the members as a list of their names. It has the same order as the list
returned by <a class="reference internal" href="#tarfile.TarFile.getmembers" title="tarfile.TarFile.getmembers"><code class="xref py py-meth docutils literal notranslate">getmembers()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.list">
TarFile.list(verbose=True, *, members=None)<a class="headerlink" href="#tarfile.TarFile.list" title="Permalink to this definition">¶</a></dt>
<dd>Print a table of contents to <code class="docutils literal notranslate">sys.stdout</code>. If verbose is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>,
only the names of the members are printed. If it is <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>, output
similar to that of ls -l is produced. If optional members is
given, it must be a subset of the list returned by <a class="reference internal" href="#tarfile.TarFile.getmembers" title="tarfile.TarFile.getmembers"><code class="xref py py-meth docutils literal notranslate">getmembers()</code></a>.
<div class="versionchanged">
Changed in version 3.5: Added the members parameter.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.next">
TarFile.next()<a class="headerlink" href="#tarfile.TarFile.next" title="Permalink to this definition">¶</a></dt>
<dd>Return the next member of the archive as a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object, when
<a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> is opened for reading. Return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> if there is no more
available.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.extractall">
TarFile.extractall(path='.', members=None, *, numeric_owner=False, filter=None)<a class="headerlink" href="#tarfile.TarFile.extractall" title="Permalink to this definition">¶</a></dt>
<dd>Extract all members from the archive to the current working directory or
directory path. If optional members is given, it must be a subset of the
list returned by <a class="reference internal" href="#tarfile.TarFile.getmembers" title="tarfile.TarFile.getmembers"><code class="xref py py-meth docutils literal notranslate">getmembers()</code></a>. Directory information like owner,
modification time and permissions are set after all members have been extracted.
This is done to work around two problems: A directory’s modification time is
reset each time a file is created in it. And, if a directory’s permissions do
not allow writing, extracting files to it will fail.
If numeric_owner is <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a>, the uid and gid numbers from the tarfile
are used to set the owner/group for the extracted files. Otherwise, the named
values from the tarfile are used.
The filter argument, which was added in Python 3.10.12, specifies how
<code class="docutils literal notranslate">members</code> are modified or rejected before extraction.
See <a class="reference internal" href="#tarfile-extraction-filter">Extraction filters</a> for details.
It is recommended to set this explicitly depending on which tar features
you need to support.
<div class="admonition warning">
Warning
Never extract archives from untrusted sources without prior inspection.
It is possible that files are created outside of path, e.g. members
that have absolute filenames starting with <code class="docutils literal notranslate">&quot;/&quot;</code> or filenames with two
dots <code class="docutils literal notranslate">&quot;..&quot;</code>.
Set <code class="docutils literal notranslate">filter='data'</code> to prevent the most dangerous security issues,
and read the <a class="reference internal" href="#tarfile-extraction-filter">Extraction filters</a> section for details.
</div>
<div class="versionchanged">
Changed in version 3.5: Added the numeric_owner parameter.
</div>
<div class="versionchanged">
Changed in version 3.6: The path parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
<div class="versionchanged">
Changed in version 3.10.12: Added the filter parameter.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.extract">
TarFile.extract(member, path='', set_attrs=True, *, numeric_owner=False, filter=None)<a class="headerlink" href="#tarfile.TarFile.extract" title="Permalink to this definition">¶</a></dt>
<dd>Extract a member from the archive to the current working directory, using its
full name. Its file information is extracted as accurately as possible. member
may be a filename or a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object. You can specify a different
directory using path. path may be a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
File attributes (owner, mtime, mode) are set unless set_attrs is false.
The numeric_owner and filter arguments are the same as
for <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>.
<div class="admonition note">
Note
The <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> method does not take care of several extraction issues.
In most cases you should consider using the <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a> method.
</div>
<div class="admonition warning">
Warning
See the warning for <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>.
Set <code class="docutils literal notranslate">filter='data'</code> to prevent the most dangerous security issues,
and read the <a class="reference internal" href="#tarfile-extraction-filter">Extraction filters</a> section for details.
</div>
<div class="versionchanged">
Changed in version 3.2: Added the set_attrs parameter.
</div>
<div class="versionchanged">
Changed in version 3.5: Added the numeric_owner parameter.
</div>
<div class="versionchanged">
Changed in version 3.6: The path parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
<div class="versionchanged">
Changed in version 3.10.12: Added the filter parameter.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.extractfile">
TarFile.extractfile(member)<a class="headerlink" href="#tarfile.TarFile.extractfile" title="Permalink to this definition">¶</a></dt>
<dd>Extract a member from the archive as a file object. member may be
a filename or a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object. If member is a regular file or
a link, an <a class="reference internal" href="io.html#io.BufferedReader" title="io.BufferedReader"><code class="xref py py-class docutils literal notranslate">io.BufferedReader</code></a> object is returned. For all other
existing members, <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> is returned. If member does not appear
in the archive, <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a> is raised.
<div class="versionchanged">
Changed in version 3.3: Return an <a class="reference internal" href="io.html#io.BufferedReader" title="io.BufferedReader"><code class="xref py py-class docutils literal notranslate">io.BufferedReader</code></a> object.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarFile.errorlevel">
TarFile.errorlevel: <a class="reference internal" href="functions.html#int" title="int">int</a><a class="headerlink" href="#tarfile.TarFile.errorlevel" title="Permalink to this definition">¶</a></dt>
<dd>If errorlevel is <code class="docutils literal notranslate">0</code>, errors are ignored when using <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">TarFile.extract()</code></a>
and <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">TarFile.extractall()</code></a>.
Nevertheless, they appear as error messages in the debug output when
debug is greater than 0.
If <code class="docutils literal notranslate">1</code> (the default), all fatal errors are raised as <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> or
<a class="reference internal" href="#tarfile.FilterError" title="tarfile.FilterError"><code class="xref py py-exc docutils literal notranslate">FilterError</code></a> exceptions. If <code class="docutils literal notranslate">2</code>, all non-fatal errors are raised
as <a class="reference internal" href="#tarfile.TarError" title="tarfile.TarError"><code class="xref py py-exc docutils literal notranslate">TarError</code></a> exceptions as well.
Some exceptions, e.g. ones caused by wrong argument types or data
corruption, are always raised.
Custom <a class="reference internal" href="#tarfile-extraction-filter">extraction filters</a>
should raise <a class="reference internal" href="#tarfile.FilterError" title="tarfile.FilterError"><code class="xref py py-exc docutils literal notranslate">FilterError</code></a> for fatal errors
and <a class="reference internal" href="#tarfile.ExtractError" title="tarfile.ExtractError"><code class="xref py py-exc docutils literal notranslate">ExtractError</code></a> for non-fatal ones.
Note that when an exception is raised, the archive may be partially
extracted. It is the user’s responsibility to clean up.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarFile.extraction_filter">
TarFile.extraction_filter<a class="headerlink" href="#tarfile.TarFile.extraction_filter" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.12.
</div>
The <a class="reference internal" href="#tarfile-extraction-filter">extraction filter</a> used
as a default for the filter argument of <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a>
and <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>.
The attribute may be <code class="docutils literal notranslate">None</code> or a callable.
String names are not allowed for this attribute, unlike the filter
argument to <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a>.
If <code class="docutils literal notranslate">extraction_filter</code> is <code class="docutils literal notranslate">None</code> (the default),
calling an extraction method without a filter argument will
use the <a class="reference internal" href="#tarfile.fully_trusted_filter" title="tarfile.fully_trusted_filter"><code class="xref py py-func docutils literal notranslate">fully_trusted</code></a> filter for
compatibility with previous Python versions.
In Python 3.12+, leaving <code class="docutils literal notranslate">extraction_filter=None</code> will emit a
<code class="docutils literal notranslate">DeprecationWarning</code>.
In Python 3.14+, leaving <code class="docutils literal notranslate">extraction_filter=None</code> will cause
extraction methods to use the <a class="reference internal" href="#tarfile.data_filter" title="tarfile.data_filter"><code class="xref py py-func docutils literal notranslate">data</code></a> filter by default.
The attribute may be set on instances or overridden in subclasses.
It also is possible to set it on the <code class="docutils literal notranslate">TarFile</code> class itself to set a
global default, although, since it affects all uses of tarfile,
it is best practice to only do so in top-level applications or
<a class="reference internal" href="site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate">site configuration</code></a>.
To set a global default this way, a filter function needs to be wrapped in
<a class="reference internal" href="functions.html#staticmethod" title="staticmethod"><code class="xref py py-func docutils literal notranslate">staticmethod()</code></a> to prevent injection of a <code class="docutils literal notranslate">self</code> argument.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.add">
TarFile.add(name, arcname=None, recursive=True, *, filter=None)<a class="headerlink" href="#tarfile.TarFile.add" title="Permalink to this definition">¶</a></dt>
<dd>Add the file name to the archive. name may be any type of file
(directory, fifo, symbolic link, etc.). If given, arcname specifies an
alternative name for the file in the archive. Directories are added
recursively by default. This can be avoided by setting recursive to
<a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate">False</code></a>. Recursion adds entries in sorted order.
If filter is given, it
should be a function that takes a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object argument and
returns the changed <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object. If it instead returns
<a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> the <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object will be excluded from the
archive. See <a class="reference internal" href="#tar-examples">Examples</a> for an example.
<div class="versionchanged">
Changed in version 3.2: Added the filter parameter.
</div>
<div class="versionchanged">
Changed in version 3.7: Recursion adds entries in sorted order.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.addfile">
TarFile.addfile(tarinfo, fileobj=None)<a class="headerlink" href="#tarfile.TarFile.addfile" title="Permalink to this definition">¶</a></dt>
<dd>Add the <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object tarinfo to the archive. If fileobj is given,
it should be a <a class="reference internal" href="../glossary.html#term-binary-file">binary file</a>, and
<code class="docutils literal notranslate">tarinfo.size</code> bytes are read from it and added to the archive. You can
create <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> objects directly, or by using <a class="reference internal" href="#tarfile.TarFile.gettarinfo" title="tarfile.TarFile.gettarinfo"><code class="xref py py-meth docutils literal notranslate">gettarinfo()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.gettarinfo">
TarFile.gettarinfo(name=None, arcname=None, fileobj=None)<a class="headerlink" href="#tarfile.TarFile.gettarinfo" title="Permalink to this definition">¶</a></dt>
<dd>Create a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object from the result of <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate">os.stat()</code></a> or
equivalent on an existing file. The file is either named by name, or
specified as a <a class="reference internal" href="../glossary.html#term-file-object">file object</a> fileobj with a file descriptor.
name may be a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>. If
given, arcname specifies an alternative name for the file in the
archive, otherwise, the name is taken from fileobj’s
<a class="reference internal" href="io.html#io.FileIO.name" title="io.FileIO.name"><code class="xref py py-attr docutils literal notranslate">name</code></a> attribute, or the name argument. The name
should be a text string.
You can modify
some of the <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a>’s attributes before you add it using <a class="reference internal" href="#tarfile.TarFile.addfile" title="tarfile.TarFile.addfile"><code class="xref py py-meth docutils literal notranslate">addfile()</code></a>.
If the file object is not an ordinary file object positioned at the
beginning of the file, attributes such as <a class="reference internal" href="#tarfile.TarInfo.size" title="tarfile.TarInfo.size"><code class="xref py py-attr docutils literal notranslate">size</code></a> may need
modifying. This is the case for objects such as <a class="reference internal" href="gzip.html#gzip.GzipFile" title="gzip.GzipFile"><code class="xref py py-class docutils literal notranslate">GzipFile</code></a>.
The <a class="reference internal" href="#tarfile.TarInfo.name" title="tarfile.TarInfo.name"><code class="xref py py-attr docutils literal notranslate">name</code></a> may also be modified, in which case arcname
could be a dummy string.
<div class="versionchanged">
Changed in version 3.6: The name parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarFile.close">
TarFile.close()<a class="headerlink" href="#tarfile.TarFile.close" title="Permalink to this definition">¶</a></dt>
<dd>Close the <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a>. In write mode, two finishing zero blocks are
appended to the archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarFile.pax_headers">
TarFile.pax_headers<a class="headerlink" href="#tarfile.TarFile.pax_headers" title="Permalink to this definition">¶</a></dt>
<dd>A dictionary containing key-value pairs of pax global headers.
</dd></dl>

</section>
<section id="tarinfo-objects">
<h2>TarInfo Objects<a class="headerlink" href="#tarinfo-objects" title="Permalink to this headline">¶</a></h2>
A <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object represents one member in a <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a>. Aside
from storing all required attributes of a file (like file type, size, time,
permissions, owner etc.), it provides some useful methods to determine its type.
It does not contain the file’s data itself.
<a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> objects are returned by <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a>’s methods
<a class="reference internal" href="#tarfile.TarFile.getmember" title="tarfile.TarFile.getmember"><code class="xref py py-meth docutils literal notranslate">getmember()</code></a>, <a class="reference internal" href="#tarfile.TarFile.getmembers" title="tarfile.TarFile.getmembers"><code class="xref py py-meth docutils literal notranslate">getmembers()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.gettarinfo" title="tarfile.TarFile.gettarinfo"><code class="xref py py-meth docutils literal notranslate">gettarinfo()</code></a>.
Modifying the objects returned by <code class="xref py py-meth docutils literal notranslate">getmember()</code> or
<code class="xref py py-meth docutils literal notranslate">getmembers()</code> will affect all subsequent
operations on the archive.
For cases where this is unwanted, you can use <a class="reference internal" href="copy.html#module-copy" title="copy: Shallow and deep copy operations."><code class="xref py py-mod docutils literal notranslate">copy.copy()</code></a> or
call the <code class="xref py py-meth docutils literal notranslate">replace()</code> method to create a modified copy in one step.
Several attributes can be set to <code class="docutils literal notranslate">None</code> to indicate that a piece of metadata
is unused or unknown.
Different <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> methods handle <code class="docutils literal notranslate">None</code> differently:
<ul class="simple">
<li>The <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> or <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a> methods will
ignore the corresponding metadata, leaving it set to a default.</li>
<li><a class="reference internal" href="#tarfile.TarFile.addfile" title="tarfile.TarFile.addfile"><code class="xref py py-meth docutils literal notranslate">addfile()</code></a> will fail.</li>
<li><a class="reference internal" href="#tarfile.TarFile.list" title="tarfile.TarFile.list"><code class="xref py py-meth docutils literal notranslate">list()</code></a> will print a placeholder string.</li>
</ul>
<div class="versionchanged">
Changed in version 3.10.12: Added <code class="xref py py-meth docutils literal notranslate">replace()</code> and handling of <code class="docutils literal notranslate">None</code>.
</div>
<dl class="py class">
<dt class="sig sig-object py" id="tarfile.TarInfo">
class tarfile.TarInfo(name='')<a class="headerlink" href="#tarfile.TarInfo" title="Permalink to this definition">¶</a></dt>
<dd>Create a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.frombuf">
classmethod TarInfo.frombuf(buf, encoding, errors)<a class="headerlink" href="#tarfile.TarInfo.frombuf" title="Permalink to this definition">¶</a></dt>
<dd>Create and return a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object from string buffer buf.
Raises <a class="reference internal" href="#tarfile.HeaderError" title="tarfile.HeaderError"><code class="xref py py-exc docutils literal notranslate">HeaderError</code></a> if the buffer is invalid.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.fromtarfile">
classmethod TarInfo.fromtarfile(tarfile)<a class="headerlink" href="#tarfile.TarInfo.fromtarfile" title="Permalink to this definition">¶</a></dt>
<dd>Read the next member from the <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> object tarfile and return it as
a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.tobuf">
TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')<a class="headerlink" href="#tarfile.TarInfo.tobuf" title="Permalink to this definition">¶</a></dt>
<dd>Create a string buffer from a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object. For information on the
arguments see the constructor of the <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> class.
<div class="versionchanged">
Changed in version 3.2: Use <code class="docutils literal notranslate">'surrogateescape'</code> as the default for the errors argument.
</div>
</dd></dl>

A <code class="docutils literal notranslate">TarInfo</code> object has the following public data attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.name">
TarInfo.name: <a class="reference internal" href="stdtypes.html#str" title="str">str</a><a class="headerlink" href="#tarfile.TarInfo.name" title="Permalink to this definition">¶</a></dt>
<dd>Name of the archive member.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.size">
TarInfo.size: <a class="reference internal" href="functions.html#int" title="int">int</a><a class="headerlink" href="#tarfile.TarInfo.size" title="Permalink to this definition">¶</a></dt>
<dd>Size in bytes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.mtime">
TarInfo.mtime: <a class="reference internal" href="functions.html#int" title="int">int</a> | <a class="reference internal" href="functions.html#float" title="float">float</a><a class="headerlink" href="#tarfile.TarInfo.mtime" title="Permalink to this definition">¶</a></dt>
<dd>Time of last modification in seconds since the <a class="reference internal" href="time.html#epoch">epoch</a>,
as in <a class="reference internal" href="os.html#os.stat_result.st_mtime" title="os.stat_result.st_mtime"><code class="xref py py-attr docutils literal notranslate">os.stat_result.st_mtime</code></a>.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.mode">
TarInfo.mode: <a class="reference internal" href="functions.html#int" title="int">int</a><a class="headerlink" href="#tarfile.TarInfo.mode" title="Permalink to this definition">¶</a></dt>
<dd>Permission bits, as for <a class="reference internal" href="os.html#os.chmod" title="os.chmod"><code class="xref py py-func docutils literal notranslate">os.chmod()</code></a>.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.type">
TarInfo.type<a class="headerlink" href="#tarfile.TarInfo.type" title="Permalink to this definition">¶</a></dt>
<dd>File type. type is usually one of these constants: <code class="xref py py-const docutils literal notranslate">REGTYPE</code>,
<code class="xref py py-const docutils literal notranslate">AREGTYPE</code>, <code class="xref py py-const docutils literal notranslate">LNKTYPE</code>, <code class="xref py py-const docutils literal notranslate">SYMTYPE</code>, <code class="xref py py-const docutils literal notranslate">DIRTYPE</code>,
<code class="xref py py-const docutils literal notranslate">FIFOTYPE</code>, <code class="xref py py-const docutils literal notranslate">CONTTYPE</code>, <code class="xref py py-const docutils literal notranslate">CHRTYPE</code>, <code class="xref py py-const docutils literal notranslate">BLKTYPE</code>,
<code class="xref py py-const docutils literal notranslate">GNUTYPE_SPARSE</code>. To determine the type of a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object
more conveniently, use the <code class="docutils literal notranslate">is*()</code> methods below.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.linkname">
TarInfo.linkname: <a class="reference internal" href="stdtypes.html#str" title="str">str</a><a class="headerlink" href="#tarfile.TarInfo.linkname" title="Permalink to this definition">¶</a></dt>
<dd>Name of the target file name, which is only present in <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> objects
of type <code class="xref py py-const docutils literal notranslate">LNKTYPE</code> and <code class="xref py py-const docutils literal notranslate">SYMTYPE</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.uid">
TarInfo.uid: <a class="reference internal" href="functions.html#int" title="int">int</a><a class="headerlink" href="#tarfile.TarInfo.uid" title="Permalink to this definition">¶</a></dt>
<dd>User ID of the user who originally stored this member.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.gid">
TarInfo.gid: <a class="reference internal" href="functions.html#int" title="int">int</a><a class="headerlink" href="#tarfile.TarInfo.gid" title="Permalink to this definition">¶</a></dt>
<dd>Group ID of the user who originally stored this member.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.uname">
TarInfo.uname: <a class="reference internal" href="stdtypes.html#str" title="str">str</a><a class="headerlink" href="#tarfile.TarInfo.uname" title="Permalink to this definition">¶</a></dt>
<dd>User name.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.gname">
TarInfo.gname: <a class="reference internal" href="stdtypes.html#str" title="str">str</a><a class="headerlink" href="#tarfile.TarInfo.gname" title="Permalink to this definition">¶</a></dt>
<dd>Group name.
<div class="versionchanged">
Changed in version 3.10.12: Can be set to <code class="docutils literal notranslate">None</code> for <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> and
<a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>, causing extraction to skip applying this
attribute.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="tarfile.TarInfo.pax_headers">
TarInfo.pax_headers: <a class="reference internal" href="stdtypes.html#dict" title="dict">dict</a><a class="headerlink" href="#tarfile.TarInfo.pax_headers" title="Permalink to this definition">¶</a></dt>
<dd>A dictionary containing key-value pairs of an associated pax extended header.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py">
TarInfo.replace(name=..., mtime=..., mode=..., linkname=...,</dt>
<dt class="sig sig-object py">
uid=..., gid=..., uname=..., gname=...,</dt>
<dt class="sig sig-object py">
deep=True)</dt>
<dd><div class="versionadded">
New in version 3.10.12.
</div>
Return a new copy of the <code class="xref py py-class docutils literal notranslate">TarInfo</code> object with the given attributes
changed. For example, to return a <code class="docutils literal notranslate">TarInfo</code> with the group name set to
<code class="docutils literal notranslate">'staff'</code>, use:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>new_tarinfo = old_tarinfo.replace(gname=&#39;staff&#39;)
</pre></div>
</div>
By default, a deep copy is made.
If deep is false, the copy is shallow, i.e. <code class="docutils literal notranslate">pax_headers</code>
and any custom attributes are shared with the original <code class="docutils literal notranslate">TarInfo</code> object.
</dd></dl>

A <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object also provides some convenient query methods:
<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isfile">
TarInfo.isfile()<a class="headerlink" href="#tarfile.TarInfo.isfile" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if the <code class="xref py py-class docutils literal notranslate">Tarinfo</code> object is a regular file.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isreg">
TarInfo.isreg()<a class="headerlink" href="#tarfile.TarInfo.isreg" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#tarfile.TarInfo.isfile" title="tarfile.TarInfo.isfile"><code class="xref py py-meth docutils literal notranslate">isfile()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isdir">
TarInfo.isdir()<a class="headerlink" href="#tarfile.TarInfo.isdir" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a directory.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.issym">
TarInfo.issym()<a class="headerlink" href="#tarfile.TarInfo.issym" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a symbolic link.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.islnk">
TarInfo.islnk()<a class="headerlink" href="#tarfile.TarInfo.islnk" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a hard link.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.ischr">
TarInfo.ischr()<a class="headerlink" href="#tarfile.TarInfo.ischr" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a character device.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isblk">
TarInfo.isblk()<a class="headerlink" href="#tarfile.TarInfo.isblk" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a block device.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isfifo">
TarInfo.isfifo()<a class="headerlink" href="#tarfile.TarInfo.isfifo" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is a FIFO.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="tarfile.TarInfo.isdev">
TarInfo.isdev()<a class="headerlink" href="#tarfile.TarInfo.isdev" title="Permalink to this definition">¶</a></dt>
<dd>Return <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate">True</code></a> if it is one of character device, block device or FIFO.
</dd></dl>

</section>
<section id="extraction-filters">
<h2>Extraction filters<a class="headerlink" href="#extraction-filters" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 3.10.12.
</div>
The tar format is designed to capture all details of a UNIX-like filesystem,
which makes it very powerful.
Unfortunately, the features make it easy to create tar files that have
unintended – and possibly malicious – effects when extracted.
For example, extracting a tar file can overwrite arbitrary files in various
ways (e.g. by using absolute paths, <code class="docutils literal notranslate">..</code> path components, or symlinks that
affect later members).
In most cases, the full functionality is not needed.
Therefore, tarfile supports extraction filters: a mechanism to limit
functionality, and thus mitigate some of the security issues.
<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0706">PEP 706</a></dt><dd>Contains further motivation and rationale behind the design.
</dd>
</dl>
</div>
The filter argument to <a class="reference internal" href="#tarfile.TarFile.extract" title="tarfile.TarFile.extract"><code class="xref py py-meth docutils literal notranslate">TarFile.extract()</code></a> or <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a>
can be:
<ul>
<li>the string <code class="docutils literal notranslate">'fully_trusted'</code>: Honor all metadata as specified in the
archive.
Should be used if the user trusts the archive completely, or implements
their own complex verification.</li>
<li>the string <code class="docutils literal notranslate">'tar'</code>: Honor most tar-specific features (i.e. features of
UNIX-like filesystems), but block features that are very likely to be
surprising or malicious. See <a class="reference internal" href="#tarfile.tar_filter" title="tarfile.tar_filter"><code class="xref py py-func docutils literal notranslate">tar_filter()</code></a> for details.</li>
<li>the string <code class="docutils literal notranslate">'data'</code>: Ignore or block most features specific to UNIX-like
filesystems. Intended for extracting cross-platform data archives.
See <a class="reference internal" href="#tarfile.data_filter" title="tarfile.data_filter"><code class="xref py py-func docutils literal notranslate">data_filter()</code></a> for details.</li>
<li><code class="docutils literal notranslate">None</code> (default): Use <a class="reference internal" href="#tarfile.TarFile.extraction_filter" title="tarfile.TarFile.extraction_filter"><code class="xref py py-attr docutils literal notranslate">TarFile.extraction_filter</code></a>.
If that is also <code class="docutils literal notranslate">None</code> (the default), the <code class="docutils literal notranslate">'fully_trusted'</code>
filter will be used (for compatibility with earlier versions of Python).
In Python 3.12, the default will emit a <code class="docutils literal notranslate">DeprecationWarning</code>.
In Python 3.14, the <code class="docutils literal notranslate">'data'</code> filter will become the default instead.
It’s possible to switch earlier; see <a class="reference internal" href="#tarfile.TarFile.extraction_filter" title="tarfile.TarFile.extraction_filter"><code class="xref py py-attr docutils literal notranslate">TarFile.extraction_filter</code></a>.
</li>
<li>A callable which will be called for each extracted member with a
<a class="reference internal" href="#tarinfo-objects">TarInfo</a> describing the member and the destination
path to where the archive is extracted (i.e. the same path is used for all
members):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>filter(/, member: TarInfo, path: str) -&gt; TarInfo | None
</pre></div>
</div>
The callable is called just before each member is extracted, so it can
take the current state of the disk into account.
It can:
<ul class="simple">
<li>return a <a class="reference internal" href="#tarfile.TarInfo" title="tarfile.TarInfo"><code class="xref py py-class docutils literal notranslate">TarInfo</code></a> object which will be used instead of the metadata
in the archive, or</li>
<li>return <code class="docutils literal notranslate">None</code>, in which case the member will be skipped, or</li>
<li>raise an exception to abort the operation or skip the member,
depending on <a class="reference internal" href="#tarfile.TarFile.errorlevel" title="tarfile.TarFile.errorlevel"><code class="xref py py-attr docutils literal notranslate">errorlevel</code></a>.
Note that when extraction is aborted, <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a> may leave
the archive partially extracted. It does not attempt to clean up.</li>
</ul>
</li>
</ul>
<section id="default-named-filters">
<h3>Default named filters<a class="headerlink" href="#default-named-filters" title="Permalink to this headline">¶</a></h3>
The pre-defined, named filters are available as functions, so they can be
reused in custom filters:
<dl class="py function">
<dt class="sig sig-object py" id="tarfile.fully_trusted_filter">
tarfile.fully_trusted_filter(/, member, path)<a class="headerlink" href="#tarfile.fully_trusted_filter" title="Permalink to this definition">¶</a></dt>
<dd>Return member unchanged.
This implements the <code class="docutils literal notranslate">'fully_trusted'</code> filter.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tarfile.tar_filter">
tarfile.tar_filter(/, member, path)<a class="headerlink" href="#tarfile.tar_filter" title="Permalink to this definition">¶</a></dt>
<dd>Implements the <code class="docutils literal notranslate">'tar'</code> filter.
<ul class="simple">
<li>Strip leading slashes (<code class="docutils literal notranslate">/</code> and <a class="reference internal" href="os.html#os.sep" title="os.sep"><code class="xref py py-attr docutils literal notranslate">os.sep</code></a>) from filenames.</li>
<li><a class="reference internal" href="#tarfile-extraction-refuse">Refuse</a> to extract files with absolute
paths (in case the name is absolute
even after stripping slashes, e.g. <code class="docutils literal notranslate">C:/foo</code> on Windows).
This raises <a class="reference internal" href="#tarfile.AbsolutePathError" title="tarfile.AbsolutePathError"><code class="xref py py-class docutils literal notranslate">AbsolutePathError</code></a>.</li>
<li><a class="reference internal" href="#tarfile-extraction-refuse">Refuse</a> to extract files whose absolute
path (after following symlinks) would end up outside the destination.
This raises <a class="reference internal" href="#tarfile.OutsideDestinationError" title="tarfile.OutsideDestinationError"><code class="xref py py-class docutils literal notranslate">OutsideDestinationError</code></a>.</li>
<li>Clear high mode bits (setuid, setgid, sticky) and group/other write bits
(<code class="xref py py-attr docutils literal notranslate">S_IWOTH</code>).</li>
</ul>
Return the modified <code class="docutils literal notranslate">TarInfo</code> member.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="tarfile.data_filter">
tarfile.data_filter(/, member, path)<a class="headerlink" href="#tarfile.data_filter" title="Permalink to this definition">¶</a></dt>
<dd>Implements the <code class="docutils literal notranslate">'data'</code> filter.
In addition to what <code class="docutils literal notranslate">tar_filter</code> does:
<ul>
<li><a class="reference internal" href="#tarfile-extraction-refuse">Refuse</a> to extract links (hard or soft)
that link to absolute paths, or ones that link outside the destination.
This raises <a class="reference internal" href="#tarfile.AbsoluteLinkError" title="tarfile.AbsoluteLinkError"><code class="xref py py-class docutils literal notranslate">AbsoluteLinkError</code></a> or
<a class="reference internal" href="#tarfile.LinkOutsideDestinationError" title="tarfile.LinkOutsideDestinationError"><code class="xref py py-class docutils literal notranslate">LinkOutsideDestinationError</code></a>.
Note that such files are refused even on platforms that do not support
symbolic links.
</li>
<li><a class="reference internal" href="#tarfile-extraction-refuse">Refuse</a> to extract device files
(including pipes).
This raises <a class="reference internal" href="#tarfile.SpecialFileError" title="tarfile.SpecialFileError"><code class="xref py py-class docutils literal notranslate">SpecialFileError</code></a>.</li>
<li>For regular files, including hard links:
<ul class="simple">
<li>Set the owner read and write permissions
(<code class="xref py py-attr docutils literal notranslate">S_IWUSR</code>).</li>
<li>Remove the group &amp; other executable permission
(<code class="xref py py-attr docutils literal notranslate">S_IXOTH</code>)
if the owner doesn’t have it (<a class="reference internal" href="stat.html#stat.S_IXUSR" title="stat.S_IXUSR"><code class="xref py py-attr docutils literal notranslate">S_IXUSR</code></a>).</li>
</ul>
</li>
<li>For other files (directories), set <code class="docutils literal notranslate">mode</code> to <code class="docutils literal notranslate">None</code>, so
that extraction methods skip applying permission bits.</li>
<li>Set user and group info (<code class="docutils literal notranslate">uid</code>, <code class="docutils literal notranslate">gid</code>, <code class="docutils literal notranslate">uname</code>, <code class="docutils literal notranslate">gname</code>)
to <code class="docutils literal notranslate">None</code>, so that extraction methods skip setting it.</li>
</ul>
Return the modified <code class="docutils literal notranslate">TarInfo</code> member.
</dd></dl>

</section>
<section id="filter-errors">
<h3>Filter errors<a class="headerlink" href="#filter-errors" title="Permalink to this headline">¶</a></h3>
When a filter refuses to extract a file, it will raise an appropriate exception,
a subclass of <a class="reference internal" href="#tarfile.FilterError" title="tarfile.FilterError"><code class="xref py py-class docutils literal notranslate">FilterError</code></a>.
This will abort the extraction if <a class="reference internal" href="#tarfile.TarFile.errorlevel" title="tarfile.TarFile.errorlevel"><code class="xref py py-attr docutils literal notranslate">TarFile.errorlevel</code></a> is 1 or more.
With <code class="docutils literal notranslate">errorlevel=0</code> the error will be logged and the member will be skipped,
but extraction will continue.
</section>
<section id="hints-for-further-verification">
<h3>Hints for further verification<a class="headerlink" href="#hints-for-further-verification" title="Permalink to this headline">¶</a></h3>
Even with <code class="docutils literal notranslate">filter='data'</code>, tarfile is not suited for extracting untrusted
files without prior inspection.
Among other issues, the pre-defined filters do not prevent denial-of-service
attacks. Users should do additional checks.
Here is an incomplete list of things to consider:
<ul class="simple">
<li>Extract to a <a class="reference internal" href="tempfile.html#tempfile.mkdtemp" title="tempfile.mkdtemp"><code class="xref py py-func docutils literal notranslate">new temporary directory</code></a>
to prevent e.g. exploiting pre-existing links, and to make it easier to
clean up after a failed extraction.</li>
<li>When working with untrusted data, use external (e.g. OS-level) limits on
disk, memory and CPU usage.</li>
<li>Check filenames against an allow-list of characters
(to filter out control characters, confusables, foreign path separators,
etc.).</li>
<li>Check that filenames have expected extensions (discouraging files that
execute when you “click on them”, or extension-less files like Windows special device names).</li>
<li>Limit the number of extracted files, total size of extracted data,
filename length (including symlink length), and size of individual files.</li>
<li>Check for files that would be shadowed on case-insensitive filesystems.</li>
</ul>
Also note that:
<ul class="simple">
<li>Tar files may contain multiple versions of the same file.
Later ones are expected to overwrite any earlier ones.
This feature is crucial to allow updating tape archives, but can be abused
maliciously.</li>
<li>tarfile does not protect against issues with “live” data,
e.g. an attacker tinkering with the destination (or source) directory while
extraction (or archiving) is in progress.</li>
</ul>
</section>
<section id="supporting-older-python-versions">
<h3>Supporting older Python versions<a class="headerlink" href="#supporting-older-python-versions" title="Permalink to this headline">¶</a></h3>
Extraction filters were added to Python 3.12, and are backported to older
versions as security updates.
To check whether the feature is available, use e.g.
<code class="docutils literal notranslate">hasattr(tarfile, 'data_filter')</code> rather than checking the Python version.
The following examples show how to support Python versions with and without
the feature.
Note that setting <code class="docutils literal notranslate">extraction_filter</code> will affect any subsequent operations.
<ul>
<li>Fully trusted archive:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>my_tarfile.extraction_filter = (lambda member, path: member)
my_tarfile.extractall()
</pre></div>
</div>
</li>
<li>Use the <code class="docutils literal notranslate">'data'</code> filter if available, but revert to Python 3.11 behavior
(<code class="docutils literal notranslate">'fully_trusted'</code>) if this feature is not available:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>my_tarfile.extraction_filter = getattr(tarfile, &#39;data_filter&#39;,
 (lambda member, path: member))
my_tarfile.extractall()
</pre></div>
</div>
</li>
<li>Use the <code class="docutils literal notranslate">'data'</code> filter; fail if it is not available:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>my_tarfile.extractall(filter=tarfile.data_filter)
</pre></div>
</div>
or:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>my_tarfile.extraction_filter = tarfile.data_filter
my_tarfile.extractall()
</pre></div>
</div>
</li>
<li>Use the <code class="docutils literal notranslate">'data'</code> filter; warn if it is not available:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>if hasattr(tarfile, &#39;data_filter&#39;):
 my_tarfile.extractall(filter=&#39;data&#39;)
else:
 # remove this when no longer needed
 warn_the_user(&#39;Extracting may be unsafe; consider updating Python&#39;)
 my_tarfile.extractall()
</pre></div>
</div>
</li>
</ul>
</section>
<section id="stateful-extraction-filter-example">
<h3>Stateful extraction filter example<a class="headerlink" href="#stateful-extraction-filter-example" title="Permalink to this headline">¶</a></h3>
While tarfile’s extraction methods take a simple filter callable,
custom filters may be more complex objects with an internal state.
It may be useful to write these as context managers, to be used like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with StatefulFilter() as filter_func:
 tar.extractall(path, filter=filter_func)
</pre></div>
</div>
Such a filter can be written as, for example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class StatefulFilter:
 def __init__(self):
 self.file_count = 0

def __enter__(self):
 return self

def __call__(self, member, path):
 self.file_count += 1
 return member

def __exit__(self, *exc_info):
 print(f&#39;{self.file_count} files extracted&#39;)
</pre></div>
</div>
</section>
</section>
<section id="command-line-interface">
<h2>Command-Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 3.4.
</div>
The <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module provides a simple command-line interface to interact
with tar archives.
If you want to create a new tar archive, specify its name after the <a class="reference internal" href="#cmdoption-tarfile-c"><code class="xref std std-option docutils literal notranslate">-c</code></a>
option and then list the filename(s) that should be included:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -c monty.tar spam.txt eggs.txt
</pre></div>
</div>
Passing a directory is also acceptable:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -c monty.tar life-of-brian_1979/
</pre></div>
</div>
If you want to extract a tar archive into the current directory, use
the <a class="reference internal" href="#cmdoption-tarfile-e"><code class="xref std std-option docutils literal notranslate">-e</code></a> option:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -e monty.tar
</pre></div>
</div>
You can also extract a tar archive into a different directory by passing the
directory’s name:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -e monty.tar other-dir/
</pre></div>
</div>
For a list of the files in a tar archive, use the <a class="reference internal" href="#cmdoption-tarfile-l"><code class="xref std std-option docutils literal notranslate">-l</code></a> option:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m tarfile -l monty.tar
</pre></div>
</div>
<section id="command-line-options">
<h3>Command-line options<a class="headerlink" href="#command-line-options" title="Permalink to this headline">¶</a></h3>
<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-l">
-l &lt;tarfile&gt;<a class="headerlink" href="#cmdoption-tarfile-l" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-tarfile-list">
--list &lt;tarfile&gt;<a class="headerlink" href="#cmdoption-tarfile-list" title="Permalink to this definition">¶</a></dt>
<dd>List files in a tarfile.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-c">
-c &lt;tarfile&gt; &lt;source1&gt; ... &lt;sourceN&gt;<a class="headerlink" href="#cmdoption-tarfile-c" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-tarfile-create">
--create &lt;tarfile&gt; &lt;source1&gt; ... &lt;sourceN&gt;<a class="headerlink" href="#cmdoption-tarfile-create" title="Permalink to this definition">¶</a></dt>
<dd>Create tarfile from source files.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-e">
-e &lt;tarfile&gt; [&lt;output_dir&gt;]<a class="headerlink" href="#cmdoption-tarfile-e" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-tarfile-extract">
--extract &lt;tarfile&gt; [&lt;output_dir&gt;]<a class="headerlink" href="#cmdoption-tarfile-extract" title="Permalink to this definition">¶</a></dt>
<dd>Extract tarfile into the current directory if output_dir is not specified.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-t">
-t &lt;tarfile&gt;<a class="headerlink" href="#cmdoption-tarfile-t" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-tarfile-test">
--test &lt;tarfile&gt;<a class="headerlink" href="#cmdoption-tarfile-test" title="Permalink to this definition">¶</a></dt>
<dd>Test whether the tarfile is valid or not.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-v">
-v, --verbose<a class="headerlink" href="#cmdoption-tarfile-v" title="Permalink to this definition">¶</a></dt>
<dd>Verbose output.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-tarfile-filter">
--filter &lt;filtername&gt;<a class="headerlink" href="#cmdoption-tarfile-filter" title="Permalink to this definition">¶</a></dt>
<dd>Specifies the filter for <code class="docutils literal notranslate">--extract</code>.
See <a class="reference internal" href="#tarfile-extraction-filter">Extraction filters</a> for details.
Only string names are accepted (that is, <code class="docutils literal notranslate">fully_trusted</code>, <code class="docutils literal notranslate">tar</code>,
and <code class="docutils literal notranslate">data</code>).
<div class="versionadded">
New in version 3.10.12.
</div>
</dd></dl>

</section>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
How to extract an entire tar archive to the current working directory:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import tarfile
tar = tarfile.open(&quot;sample.tar.gz&quot;)
tar.extractall()
tar.close()
</pre></div>
</div>
How to extract a subset of a tar archive with <a class="reference internal" href="#tarfile.TarFile.extractall" title="tarfile.TarFile.extractall"><code class="xref py py-meth docutils literal notranslate">TarFile.extractall()</code></a> using
a generator function instead of a list:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import os
import tarfile

def py_files(members):
 for tarinfo in members:
 if os.path.splitext(tarinfo.name)[1] == &quot;.py&quot;:
 yield tarinfo

tar = tarfile.open(&quot;sample.tar.gz&quot;)
tar.extractall(members=py_files(tar))
tar.close()
</pre></div>
</div>
How to create an uncompressed tar archive from a list of filenames:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import tarfile
tar = tarfile.open(&quot;sample.tar&quot;, &quot;w&quot;)
for name in [&quot;foo&quot;, &quot;bar&quot;, &quot;quux&quot;]:
 tar.add(name)
tar.close()
</pre></div>
</div>
The same example using the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import tarfile
with tarfile.open(&quot;sample.tar&quot;, &quot;w&quot;) as tar:
 for name in [&quot;foo&quot;, &quot;bar&quot;, &quot;quux&quot;]:
 tar.add(name)
</pre></div>
</div>
How to read a gzip compressed tar archive and display some member information:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import tarfile
tar = tarfile.open(&quot;sample.tar.gz&quot;, &quot;r:gz&quot;)
for tarinfo in tar:
 print(tarinfo.name, &quot;is&quot;, tarinfo.size, &quot;bytes in size and is &quot;, end=&quot;&quot;)
 if tarinfo.isreg():
 print(&quot;a regular file.&quot;)
 elif tarinfo.isdir():
 print(&quot;a directory.&quot;)
 else:
 print(&quot;something else.&quot;)
tar.close()
</pre></div>
</div>
How to create an archive and reset the user information using the filter
parameter in <a class="reference internal" href="#tarfile.TarFile.add" title="tarfile.TarFile.add"><code class="xref py py-meth docutils literal notranslate">TarFile.add()</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import tarfile
def reset(tarinfo):
 tarinfo.uid = tarinfo.gid = 0
 tarinfo.uname = tarinfo.gname = &quot;root&quot;
 return tarinfo
tar = tarfile.open(&quot;sample.tar.gz&quot;, &quot;w:gz&quot;)
tar.add(&quot;foo&quot;, filter=reset)
tar.close()
</pre></div>
</div>
</section>
<section id="supported-tar-formats">
<h2>Supported tar formats<a class="headerlink" href="#supported-tar-formats" title="Permalink to this headline">¶</a></h2>
There are three tar formats that can be created with the <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> module:
<ul>
<li>The POSIX.1-1988 ustar format (<a class="reference internal" href="#tarfile.USTAR_FORMAT" title="tarfile.USTAR_FORMAT"><code class="xref py py-const docutils literal notranslate">USTAR_FORMAT</code></a>). It supports filenames
up to a length of at best 256 characters and linknames up to 100 characters.
The maximum file size is 8 GiB. This is an old and limited but widely
supported format.</li>
<li>The GNU tar format (<a class="reference internal" href="#tarfile.GNU_FORMAT" title="tarfile.GNU_FORMAT"><code class="xref py py-const docutils literal notranslate">GNU_FORMAT</code></a>). It supports long filenames and
linknames, files bigger than 8 GiB and sparse files. It is the de facto
standard on GNU/Linux systems. <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> fully supports the GNU tar
extensions for long names, sparse file support is read-only.</li>
<li>The POSIX.1-2001 pax format (<a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a>). It is the most flexible
format with virtually no limits. It supports long filenames and linknames, large
files and stores pathnames in a portable way. Modern tar implementations,
including GNU tar, bsdtar/libarchive and star, fully support extended pax
features; some old or unmaintained libraries may not, but should treat
pax archives as if they were in the universally supported ustar format.
It is the current default format for new archives.
It extends the existing ustar format with extra headers for information
that cannot be stored otherwise. There are two flavours of pax headers:
Extended headers only affect the subsequent file header, global
headers are valid for the complete archive and affect all following files.
All the data in a pax header is encoded in UTF-8 for portability reasons.
</li>
</ul>
There are some more variants of the tar format which can be read, but not
created:
<ul class="simple">
<li>The ancient V7 format. This is the first tar format from Unix Seventh Edition,
storing only regular files and directories. Names must not be longer than 100
characters, there is no user/group name information. Some archives have
miscalculated header checksums in case of fields with non-ASCII characters.</li>
<li>The SunOS tar extended format. This format is a variant of the POSIX.1-2001
pax format, but is not compatible.</li>
</ul>
</section>
<section id="unicode-issues">
<h2>Unicode issues<a class="headerlink" href="#unicode-issues" title="Permalink to this headline">¶</a></h2>
The tar format was originally conceived to make backups on tape drives with the
main focus on preserving file system information. Nowadays tar archives are
commonly used for file distribution and exchanging archives over networks. One
problem of the original format (which is the basis of all other formats) is
that there is no concept of supporting different character encodings. For
example, an ordinary tar archive created on a UTF-8 system cannot be read
correctly on a Latin-1 system if it contains non-ASCII characters. Textual
metadata (like filenames, linknames, user/group names) will appear damaged.
Unfortunately, there is no way to autodetect the encoding of an archive. The
pax format was designed to solve this problem. It stores non-ASCII metadata
using the universal character encoding UTF-8.
The details of character conversion in <a class="reference internal" href="#module-tarfile" title="tarfile: Read and write tar-format archive files."><code class="xref py py-mod docutils literal notranslate">tarfile</code></a> are controlled by the
encoding and errors keyword arguments of the <a class="reference internal" href="#tarfile.TarFile" title="tarfile.TarFile"><code class="xref py py-class docutils literal notranslate">TarFile</code></a> class.
encoding defines the character encoding to use for the metadata in the
archive. The default value is <a class="reference internal" href="sys.html#sys.getfilesystemencoding" title="sys.getfilesystemencoding"><code class="xref py py-func docutils literal notranslate">sys.getfilesystemencoding()</code></a> or <code class="docutils literal notranslate">'ascii'</code>
as a fallback. Depending on whether the archive is read or written, the
metadata must be either decoded or encoded. If encoding is not set
appropriately, this conversion may fail.
The errors argument defines how characters are treated that cannot be
converted. Possible values are listed in section <a class="reference internal" href="codecs.html#error-handlers">Error Handlers</a>.
The default scheme is <code class="docutils literal notranslate">'surrogateescape'</code> which Python also uses for its
file system calls, see <a class="reference internal" href="os.html#os-filenames">File Names, Command Line Arguments, and Environment Variables</a>.
For <a class="reference internal" href="#tarfile.PAX_FORMAT" title="tarfile.PAX_FORMAT"><code class="xref py py-const docutils literal notranslate">PAX_FORMAT</code></a> archives (the default), encoding is generally not needed
because all the metadata is stored using UTF-8. encoding is only used in
the rare cases when binary pax headers are decoded or when strings with
surrogate characters are stored.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</a><ul>
<li><a class="reference internal" href="#tarfile-objects">TarFile Objects</a></li>
<li><a class="reference internal" href="#tarinfo-objects">TarInfo Objects</a></li>
<li><a class="reference internal" href="#extraction-filters">Extraction filters</a><ul>
<li><a class="reference internal" href="#default-named-filters">Default named filters</a></li>
<li><a class="reference internal" href="#filter-errors">Filter errors</a></li>
<li><a class="reference internal" href="#hints-for-further-verification">Hints for further verification</a></li>
<li><a class="reference internal" href="#supporting-older-python-versions">Supporting older Python versions</a></li>
<li><a class="reference internal" href="#stateful-extraction-filter-example">Stateful extraction filter example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#command-line-interface">Command-Line Interface</a><ul>
<li><a class="reference internal" href="#command-line-options">Command-line options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#supported-tar-formats">Supported tar formats</a></li>
<li><a class="reference internal" href="#unicode-issues">Unicode issues</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="zipfile.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">zipfile</code> — Work with ZIP archives</a>
 <h4>Next topic</h4>
 <a href="fileformats.html"
 title="next chapter">File Formats</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/tarfile.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="fileformats.html" title="File Formats"
 >next</a> |</li>
 <li class="right" >
 <a href="zipfile.html" title="zipfile — Work with ZIP archives"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="archiving.html" >Data Compression and Archiving</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : tarfile.html