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 : zipfile.html

<!DOCTYPE html>

<title>zipfile — Work with ZIP archives &#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="tarfile — Read and write tar archive files" href="tarfile.html" />
 <link rel="prev" title="lzma — Compression using the LZMA algorithm" href="lzma.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/zipfile.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">zipfile</code> — Work with ZIP archives</a><ul>
<li><a class="reference internal" href="#zipfile-objects">ZipFile Objects</a></li>
<li><a class="reference internal" href="#path-objects">Path Objects</a></li>
<li><a class="reference internal" href="#pyzipfile-objects">PyZipFile Objects</a></li>
<li><a class="reference internal" href="#zipinfo-objects">ZipInfo Objects</a></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="#decompression-pitfalls">Decompression pitfalls</a><ul>
<li><a class="reference internal" href="#from-file-itself">From file itself</a></li>
<li><a class="reference internal" href="#file-system-limitations">File System limitations</a></li>
<li><a class="reference internal" href="#resources-limitations">Resources limitations</a></li>
<li><a class="reference internal" href="#interruption">Interruption</a></li>
<li><a class="reference internal" href="#default-behaviors-of-extraction">Default behaviors of extraction</a></li>
</ul>
</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="tarfile.html" title="tarfile — Read and write tar archive files"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="lzma.html" title="lzma — Compression using the LZMA algorithm"
 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">zipfile</code> — Work with ZIP archives</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-zipfile">
<h1><a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> — Work with ZIP archives<a class="headerlink" href="#module-zipfile" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/zipfile.py">Lib/zipfile.py</a>
<hr class="docutils" />
The ZIP file format is a common archive and compression standard. This module
provides tools to create, read, write, append, and list a ZIP file. Any
advanced use of this module will require an understanding of the format, as
defined in <a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a>.
This module does not currently handle multi-disk ZIP files.
It can handle ZIP files that use the ZIP64 extensions
(that is ZIP files that are more than 4 GiB in size). It supports
decryption of encrypted files in ZIP archives, but it currently cannot
create an encrypted file. Decryption is extremely slow as it is
implemented in native Python rather than C.
The module defines the following items:
<dl class="py exception">
<dt class="sig sig-object py" id="zipfile.BadZipFile">
exception zipfile.BadZipFile<a class="headerlink" href="#zipfile.BadZipFile" title="Permalink to this definition">¶</a></dt>
<dd>The error raised for bad ZIP files.
<div class="versionadded">
New in version 3.2.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="zipfile.BadZipfile">
exception zipfile.BadZipfile<a class="headerlink" href="#zipfile.BadZipfile" title="Permalink to this definition">¶</a></dt>
<dd>Alias of <a class="reference internal" href="#zipfile.BadZipFile" title="zipfile.BadZipFile"><code class="xref py py-exc docutils literal notranslate">BadZipFile</code></a>, for compatibility with older Python versions.
<div class="deprecated">
Deprecated since version 3.2.
</div>
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="zipfile.LargeZipFile">
exception zipfile.LargeZipFile<a class="headerlink" href="#zipfile.LargeZipFile" title="Permalink to this definition">¶</a></dt>
<dd>The error raised when a ZIP file would require ZIP64 functionality but that has
not been enabled.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py">
class zipfile.Path</dt>
<dd>Class that implements a subset of the interface provided by
<a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate">pathlib.Path</code></a>, including the full
<code class="xref py py-class docutils literal notranslate">importlib.resources.abc.Traversable</code> interface.
<div class="versionadded">
New in version 3.8.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zipfile.ZipInfo">
class zipfile.ZipInfo(filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))<a class="headerlink" href="#zipfile.ZipInfo" title="Permalink to this definition">¶</a></dt>
<dd>Class used to represent information about a member of an archive. Instances
of this class are returned by the <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> and <a class="reference internal" href="#zipfile.ZipFile.infolist" title="zipfile.ZipFile.infolist"><code class="xref py py-meth docutils literal notranslate">infolist()</code></a>
methods of <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects. Most users of the <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> module
will not need to create these, but only use those created by this
module. filename should be the full name of the archive member, and
date_time should be a tuple containing six fields which describe the time
of the last modification to the file; the fields are described in section
<a class="reference internal" href="#zipinfo-objects">ZipInfo Objects</a>.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="zipfile.is_zipfile">
zipfile.is_zipfile(filename)<a class="headerlink" href="#zipfile.is_zipfile" title="Permalink to this definition">¶</a></dt>
<dd>Returns <code class="docutils literal notranslate">True</code> if filename is a valid ZIP file based on its magic number,
otherwise returns <code class="docutils literal notranslate">False</code>. filename may be a file or file-like object too.
<div class="versionchanged">
Changed in version 3.1: Support for file and file-like objects.
</div>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_STORED">
zipfile.ZIP_STORED<a class="headerlink" href="#zipfile.ZIP_STORED" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for an uncompressed archive member.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_DEFLATED">
zipfile.ZIP_DEFLATED<a class="headerlink" href="#zipfile.ZIP_DEFLATED" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for the usual ZIP compression method. This requires the
<a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_BZIP2">
zipfile.ZIP_BZIP2<a class="headerlink" href="#zipfile.ZIP_BZIP2" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for the BZIP2 compression method. This requires the
<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> module.
<div class="versionadded">
New in version 3.3.
</div>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_LZMA">
zipfile.ZIP_LZMA<a class="headerlink" href="#zipfile.ZIP_LZMA" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for the LZMA compression method. This requires the
<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> module.
<div class="versionadded">
New in version 3.3.
</div>
<div class="admonition note">
Note
The ZIP file format specification has included support for bzip2 compression
since 2001, and for LZMA compression since 2006. However, some tools
(including older Python releases) do not support these compression
methods, and may either refuse to process the ZIP file altogether,
or fail to extract individual files.
</div>
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a></dt><dd>Documentation on the ZIP file format by Phil Katz, the creator of the format and
algorithms used.
</dd>
<dt><a class="reference external" href="http://www.info-zip.org/">Info-ZIP Home Page</a></dt><dd>Information about the Info-ZIP project’s ZIP archive programs and development
libraries.
</dd>
</dl>
</div>
<section id="zipfile-objects">
<h2>ZipFile Objects<a class="headerlink" href="#zipfile-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zipfile.ZipFile">
class zipfile.ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True)<a class="headerlink" href="#zipfile.ZipFile" title="Permalink to this definition">¶</a></dt>
<dd>Open a ZIP file, where file can be a path to a file (a string), a
file-like object or a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
The mode parameter should be <code class="docutils literal notranslate">'r'</code> to read an existing
file, <code class="docutils literal notranslate">'w'</code> to truncate and write a new file, <code class="docutils literal notranslate">'a'</code> to append to an
existing file, or <code class="docutils literal notranslate">'x'</code> to exclusively create and write a new file.
If mode is <code class="docutils literal notranslate">'x'</code> and file refers to an existing file,
a <a class="reference internal" href="exceptions.html#FileExistsError" title="FileExistsError"><code class="xref py py-exc docutils literal notranslate">FileExistsError</code></a> will be raised.
If mode is <code class="docutils literal notranslate">'a'</code> and file refers to an existing ZIP
file, then additional files are added to it. If file does not refer to a
ZIP file, then a new ZIP archive is appended to the file. This is meant for
adding a ZIP archive to another file (such as <code class="file docutils literal notranslate">python.exe</code>). If
mode is <code class="docutils literal notranslate">'a'</code> and the file does not exist at all, it is created.
If mode is <code class="docutils literal notranslate">'r'</code> or <code class="docutils literal notranslate">'a'</code>, the file should be seekable.
compression is the ZIP compression method to use when writing the archive,
and should be <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>, <a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a>,
<a class="reference internal" href="#zipfile.ZIP_BZIP2" title="zipfile.ZIP_BZIP2"><code class="xref py py-const docutils literal notranslate">ZIP_BZIP2</code></a> or <a class="reference internal" href="#zipfile.ZIP_LZMA" title="zipfile.ZIP_LZMA"><code class="xref py py-const docutils literal notranslate">ZIP_LZMA</code></a>; unrecognized
values will cause <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a> to be raised. If
<a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a>, <a class="reference internal" href="#zipfile.ZIP_BZIP2" title="zipfile.ZIP_BZIP2"><code class="xref py py-const docutils literal notranslate">ZIP_BZIP2</code></a> or <a class="reference internal" href="#zipfile.ZIP_LZMA" title="zipfile.ZIP_LZMA"><code class="xref py py-const docutils literal notranslate">ZIP_LZMA</code></a> is specified
but the corresponding module (<a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</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> or <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>) is not
available, <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> is raised. The default is <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>.
If allowZip64 is <code class="docutils literal notranslate">True</code> (the default) zipfile will create ZIP files that
use the ZIP64 extensions when the zipfile is larger than 4 GiB. If it is
<code class="docutils literal notranslate">false</code> <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> will raise an exception when the ZIP file would
require ZIP64 extensions.
The compresslevel parameter controls the compression level to use when
writing files to the archive.
When using <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a> or <a class="reference internal" href="#zipfile.ZIP_LZMA" title="zipfile.ZIP_LZMA"><code class="xref py py-const docutils literal notranslate">ZIP_LZMA</code></a> it has no effect.
When using <a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a> integers <code class="docutils literal notranslate">0</code> through <code class="docutils literal notranslate">9</code> are accepted
(see <a class="reference internal" href="zlib.html#zlib.compressobj" title="zlib.compressobj"><code class="xref py py-class docutils literal notranslate">zlib</code></a> for more information).
When using <a class="reference internal" href="#zipfile.ZIP_BZIP2" title="zipfile.ZIP_BZIP2"><code class="xref py py-const docutils literal notranslate">ZIP_BZIP2</code></a> integers <code class="docutils literal notranslate">1</code> through <code class="docutils literal notranslate">9</code> are accepted
(see <a class="reference internal" href="bz2.html#bz2.BZ2File" title="bz2.BZ2File"><code class="xref py py-class docutils literal notranslate">bz2</code></a> for more information).
The strict_timestamps argument, when set to <code class="docutils literal notranslate">False</code>, allows to
zip files older than 1980-01-01 at the cost of setting the
timestamp to 1980-01-01.
Similar behavior occurs with files newer than 2107-12-31,
the timestamp is also set to the limit.
If the file is created with mode <code class="docutils literal notranslate">'w'</code>, <code class="docutils literal notranslate">'x'</code> or <code class="docutils literal notranslate">'a'</code> and then
<a class="reference internal" href="#zipfile.ZipFile.close" title="zipfile.ZipFile.close"><code class="xref py py-meth docutils literal notranslate">closed</code></a> without adding any files to the archive, the appropriate
ZIP structures for an empty archive will be written to the file.
ZipFile is also a context manager and therefore supports the
<a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement. In the example, myzip is closed after the
<code class="xref std std-keyword docutils literal notranslate">with</code> statement’s suite is finished—even if an exception occurs:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with ZipFile(&#39;spam.zip&#39;, &#39;w&#39;) as myzip:
 myzip.write(&#39;eggs.txt&#39;)
</pre></div>
</div>
<div class="versionadded">
New in version 3.2: Added the ability to use <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> as a context manager.
</div>
<div class="versionchanged">
Changed in version 3.3: Added support for <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">bzip2</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> compression.
</div>
<div class="versionchanged">
Changed in version 3.4: ZIP64 extensions are enabled by default.
</div>
<div class="versionchanged">
Changed in version 3.5: Added support for writing to unseekable streams.
Added support for the <code class="docutils literal notranslate">'x'</code> mode.
</div>
<div class="versionchanged">
Changed in version 3.6: Previously, a plain <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised for unrecognized
compression values.
</div>
<div class="versionchanged">
Changed in version 3.6.2: The file 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.7: Add the compresslevel parameter.
</div>
<div class="versionadded">
New in version 3.8: The strict_timestamps keyword-only argument
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.close">
ZipFile.close()<a class="headerlink" href="#zipfile.ZipFile.close" title="Permalink to this definition">¶</a></dt>
<dd>Close the archive file. You must call <a class="reference internal" href="#zipfile.ZipFile.close" title="zipfile.ZipFile.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> before exiting your program
or essential records will not be written.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.getinfo">
ZipFile.getinfo(name)<a class="headerlink" href="#zipfile.ZipFile.getinfo" title="Permalink to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object with information about the archive member
name. Calling <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> for a name not currently contained in the
archive will raise a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.infolist">
ZipFile.infolist()<a class="headerlink" href="#zipfile.ZipFile.infolist" title="Permalink to this definition">¶</a></dt>
<dd>Return a list containing a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object for each member of the
archive. The objects are in the same order as their entries in the actual ZIP
file on disk if an existing archive was opened.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.namelist">
ZipFile.namelist()<a class="headerlink" href="#zipfile.ZipFile.namelist" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of archive members by name.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.open">
ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False)<a class="headerlink" href="#zipfile.ZipFile.open" title="Permalink to this definition">¶</a></dt>
<dd>Access a member of the archive as a binary file-like object. name
can be either the name of a file within the archive or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a>
object. The mode parameter, if included, must be <code class="docutils literal notranslate">'r'</code> (the default)
or <code class="docutils literal notranslate">'w'</code>. pwd is the password used to decrypt encrypted ZIP files as a
<a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
<a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> is also a context manager and therefore supports 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>with ZipFile(&#39;spam.zip&#39;) as myzip:
 with myzip.open(&#39;eggs.txt&#39;) as myfile:
 print(myfile.read())
</pre></div>
</div>
With mode <code class="docutils literal notranslate">'r'</code> the file-like object
(<code class="docutils literal notranslate">ZipExtFile</code>) is read-only and provides the following methods:
<a class="reference internal" href="io.html#io.BufferedIOBase.read" title="io.BufferedIOBase.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a>, <a class="reference internal" href="io.html#io.IOBase.readline" title="io.IOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a>,
<a class="reference internal" href="io.html#io.IOBase.readlines" title="io.IOBase.readlines"><code class="xref py py-meth docutils literal notranslate">readlines()</code></a>, <a class="reference internal" href="io.html#io.IOBase.seek" title="io.IOBase.seek"><code class="xref py py-meth docutils literal notranslate">seek()</code></a>,
<a class="reference internal" href="io.html#io.IOBase.tell" title="io.IOBase.tell"><code class="xref py py-meth docutils literal notranslate">tell()</code></a>, <a class="reference internal" href="stdtypes.html#container.__iter__" title="container.__iter__"><code class="xref py py-meth docutils literal notranslate">__iter__()</code></a>, <a class="reference internal" href="stdtypes.html#iterator.__next__" title="iterator.__next__"><code class="xref py py-meth docutils literal notranslate">__next__()</code></a>.
These objects can operate independently of the ZipFile.
With <code class="docutils literal notranslate">mode='w'</code>, a writable file handle is returned, which supports the
<a class="reference internal" href="io.html#io.BufferedIOBase.write" title="io.BufferedIOBase.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> method. While a writable file handle is open,
attempting to read or write other files in the ZIP file will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>.
When writing a file, if the file size is not known in advance but may exceed
2 GiB, pass <code class="docutils literal notranslate">force_zip64=True</code> to ensure that the header format is
capable of supporting large files. If the file size is known in advance,
construct a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object with <a class="reference internal" href="#zipfile.ZipInfo.file_size" title="zipfile.ZipInfo.file_size"><code class="xref py py-attr docutils literal notranslate">file_size</code></a> set, and
use that as the name parameter.
<div class="admonition note">
Note
The <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a>, <a class="reference internal" href="#zipfile.ZipFile.read" title="zipfile.ZipFile.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> and <a class="reference internal" href="#zipfile.ZipFile.extract" title="zipfile.ZipFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> methods can take a filename
or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object. You will appreciate this when trying to read a
ZIP file that contains members with duplicate names.
</div>
<div class="versionchanged">
Changed in version 3.6: Removed support of <code class="docutils literal notranslate">mode='U'</code>. Use <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> for reading
compressed text files in <a class="reference internal" href="../glossary.html#term-universal-newlines">universal newlines</a> mode.
</div>
<div class="versionchanged">
Changed in version 3.6: <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">ZipFile.open()</code></a> can now be used to write files into the archive with the
<code class="docutils literal notranslate">mode='w'</code> option.
</div>
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> on a closed ZipFile will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>.
Previously, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.extract">
ZipFile.extract(member, path=None, pwd=None)<a class="headerlink" href="#zipfile.ZipFile.extract" title="Permalink to this definition">¶</a></dt>
<dd>Extract a member from the archive to the current working directory; member
must be its full name or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object. Its file information is
extracted as accurately as possible. path specifies a different directory
to extract to. member can be a filename or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object.
pwd is the password used for encrypted files as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
Returns the normalized path created (a directory or new file).
<div class="admonition note">
Note
If a member filename is an absolute path, a drive/UNC sharepoint and
leading (back)slashes will be stripped, e.g.: <code class="docutils literal notranslate">///foo/bar</code> becomes
<code class="docutils literal notranslate">foo/bar</code> on Unix, and <code class="docutils literal notranslate">C:\foo\bar</code> becomes <code class="docutils literal notranslate">foo\bar</code> on Windows.
And all <code class="docutils literal notranslate">&quot;..&quot;</code> components in a member filename will be removed, e.g.:
<code class="docutils literal notranslate">../../foo../../ba..r</code> becomes <code class="docutils literal notranslate">foo../ba..r</code>. On Windows illegal
characters (<code class="docutils literal notranslate">:</code>, <code class="docutils literal notranslate">&lt;</code>, <code class="docutils literal notranslate">&gt;</code>, <code class="docutils literal notranslate">|</code>, <code class="docutils literal notranslate">&quot;</code>, <code class="docutils literal notranslate">?</code>, and <code class="docutils literal notranslate">*</code>)
replaced by underscore (<code class="docutils literal notranslate">_</code>).
</div>
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.extract" title="zipfile.ZipFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> on a closed ZipFile will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. Previously, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
<div class="versionchanged">
Changed in version 3.6.2: The path 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="zipfile.ZipFile.extractall">
ZipFile.extractall(path=None, members=None, pwd=None)<a class="headerlink" href="#zipfile.ZipFile.extractall" title="Permalink to this definition">¶</a></dt>
<dd>Extract all members from the archive to the current working directory. path
specifies a different directory to extract to. members is optional and must
be a subset of the list returned by <a class="reference internal" href="#zipfile.ZipFile.namelist" title="zipfile.ZipFile.namelist"><code class="xref py py-meth docutils literal notranslate">namelist()</code></a>. pwd is the password
used for encrypted files as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
<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>. This module attempts to prevent that.
See <a class="reference internal" href="#zipfile.ZipFile.extract" title="zipfile.ZipFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> note.
</div>
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.extractall" title="zipfile.ZipFile.extractall"><code class="xref py py-meth docutils literal notranslate">extractall()</code></a> on a closed ZipFile will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. Previously, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
<div class="versionchanged">
Changed in version 3.6.2: The path 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="zipfile.ZipFile.printdir">
ZipFile.printdir()<a class="headerlink" href="#zipfile.ZipFile.printdir" title="Permalink to this definition">¶</a></dt>
<dd>Print a table of contents for the archive to <code class="docutils literal notranslate">sys.stdout</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.setpassword">
ZipFile.setpassword(pwd)<a class="headerlink" href="#zipfile.ZipFile.setpassword" title="Permalink to this definition">¶</a></dt>
<dd>Set pwd (a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object) as default password to extract encrypted files.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.read">
ZipFile.read(name, pwd=None)<a class="headerlink" href="#zipfile.ZipFile.read" title="Permalink to this definition">¶</a></dt>
<dd>Return the bytes of the file name in the archive. name is the name of the
file in the archive, or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object. The archive must be open for
read or append. pwd is the password used for encrypted files as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a>
object and, if specified, overrides the default password set with <a class="reference internal" href="#zipfile.ZipFile.setpassword" title="zipfile.ZipFile.setpassword"><code class="xref py py-meth docutils literal notranslate">setpassword()</code></a>.
Calling <a class="reference internal" href="#zipfile.ZipFile.read" title="zipfile.ZipFile.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> on a ZipFile that uses a compression method other than
<a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>, <a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a>, <a class="reference internal" href="#zipfile.ZIP_BZIP2" title="zipfile.ZIP_BZIP2"><code class="xref py py-const docutils literal notranslate">ZIP_BZIP2</code></a> or
<a class="reference internal" href="#zipfile.ZIP_LZMA" title="zipfile.ZIP_LZMA"><code class="xref py py-const docutils literal notranslate">ZIP_LZMA</code></a> will raise a <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. An error will also
be raised if the corresponding compression module is not available.
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.read" title="zipfile.ZipFile.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> on a closed ZipFile will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>.
Previously, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.testzip">
ZipFile.testzip()<a class="headerlink" href="#zipfile.ZipFile.testzip" title="Permalink to this definition">¶</a></dt>
<dd>Read all the files in the archive and check their CRC’s and file headers.
Return the name of the first bad file, or else return <code class="docutils literal notranslate">None</code>.
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.testzip" title="zipfile.ZipFile.testzip"><code class="xref py py-meth docutils literal notranslate">testzip()</code></a> on a closed ZipFile will raise a
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. Previously, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.write">
ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)<a class="headerlink" href="#zipfile.ZipFile.write" title="Permalink to this definition">¶</a></dt>
<dd>Write the file named filename to the archive, giving it the archive name
arcname (by default, this will be the same as filename, but without a drive
letter and with leading path separators removed). If given, compress_type
overrides the value given for the compression parameter to the constructor for
the new entry. Similarly, compresslevel will override the constructor if
given.
The archive must be open with mode <code class="docutils literal notranslate">'w'</code>, <code class="docutils literal notranslate">'x'</code> or <code class="docutils literal notranslate">'a'</code>.
<div class="admonition note">
Note
Archive names should be relative to the archive root, that is, they should not
start with a path separator.
</div>
<div class="admonition note">
Note
If <code class="docutils literal notranslate">arcname</code> (or <code class="docutils literal notranslate">filename</code>, if <code class="docutils literal notranslate">arcname</code> is not given) contains a null
byte, the name of the file in the archive will be truncated at the null byte.
</div>
<div class="admonition note">
Note
A leading slash in the filename may lead to the archive being impossible to
open in some zip programs on Windows systems.
</div>
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.write" title="zipfile.ZipFile.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> on a ZipFile created with mode <code class="docutils literal notranslate">'r'</code> or
a closed ZipFile will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. Previously,
a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.writestr">
ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)<a class="headerlink" href="#zipfile.ZipFile.writestr" title="Permalink to this definition">¶</a></dt>
<dd>Write a file into the archive. The contents is data, which may be either
a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> or a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> instance; if it is a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>,
it is encoded as UTF-8 first. zinfo_or_arcname is either the file
name it will be given in the archive, or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance. If it’s
an instance, at least the filename, date, and time must be given. If it’s a
name, the date and time is set to the current date and time.
The archive must be opened with mode <code class="docutils literal notranslate">'w'</code>, <code class="docutils literal notranslate">'x'</code> or <code class="docutils literal notranslate">'a'</code>.
If given, compress_type overrides the value given for the compression
parameter to the constructor for the new entry, or in the zinfo_or_arcname
(if that is a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance). Similarly, compresslevel will
override the constructor if given.
<div class="admonition note">
Note
When passing a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance as the zinfo_or_arcname parameter,
the compression method used will be that specified in the compress_type
member of the given <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance. By default, the
<a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> constructor sets this member to <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>.
</div>
<div class="versionchanged">
Changed in version 3.2: The compress_type argument.
</div>
<div class="versionchanged">
Changed in version 3.6: Calling <a class="reference internal" href="#zipfile.ZipFile.writestr" title="zipfile.ZipFile.writestr"><code class="xref py py-meth docutils literal notranslate">writestr()</code></a> on a ZipFile created with mode <code class="docutils literal notranslate">'r'</code> or
a closed ZipFile will raise a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>. Previously,
a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> was raised.
</div>
</dd></dl>

The following data attributes are also available:
<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipFile.filename">
ZipFile.filename<a class="headerlink" href="#zipfile.ZipFile.filename" title="Permalink to this definition">¶</a></dt>
<dd>Name of the ZIP file.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipFile.debug">
ZipFile.debug<a class="headerlink" href="#zipfile.ZipFile.debug" title="Permalink to this definition">¶</a></dt>
<dd>The level of debug output to use. This may be set from <code class="docutils literal notranslate">0</code> (the default, no
output) to <code class="docutils literal notranslate">3</code> (the most output). Debugging information is written to
<code class="docutils literal notranslate">sys.stdout</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipFile.comment">
ZipFile.comment<a class="headerlink" href="#zipfile.ZipFile.comment" title="Permalink to this definition">¶</a></dt>
<dd>The comment associated with the ZIP file as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
If assigning a comment to a
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> instance created with mode <code class="docutils literal notranslate">'w'</code>, <code class="docutils literal notranslate">'x'</code> or <code class="docutils literal notranslate">'a'</code>,
it should be no longer than 65535 bytes. Comments longer than this will be
truncated.
</dd></dl>

</section>
<section id="path-objects">
<h2>Path Objects<a class="headerlink" href="#path-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zipfile.Path">
class zipfile.Path(root, at='')<a class="headerlink" href="#zipfile.Path" title="Permalink to this definition">¶</a></dt>
<dd>Construct a Path object from a <code class="docutils literal notranslate">root</code> zipfile (which may be a
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> instance or <code class="docutils literal notranslate">file</code> suitable for passing to
the <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> constructor).
<code class="docutils literal notranslate">at</code> specifies the location of this Path within the zipfile,
e.g. ‘dir/file.txt’, ‘dir/’, or ‘’. Defaults to the empty string,
indicating the root.
</dd></dl>

Path objects expose the following features of <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-mod docutils literal notranslate">pathlib.Path</code></a>
objects:
Path objects are traversable using the <code class="docutils literal notranslate">/</code> operator or <code class="docutils literal notranslate">joinpath</code>.
<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.Path.name">
Path.name<a class="headerlink" href="#zipfile.Path.name" title="Permalink to this definition">¶</a></dt>
<dd>The final path component.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.open">
Path.open(mode='r', *, pwd, **)<a class="headerlink" href="#zipfile.Path.open" title="Permalink to this definition">¶</a></dt>
<dd>Invoke <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">ZipFile.open()</code></a> on the current path.
Allows opening for read or write, text or binary
through supported modes: ‘r’, ‘w’, ‘rb’, ‘wb’.
Positional and keyword arguments are passed through to
<a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> when opened as text and
ignored otherwise.
<code class="docutils literal notranslate">pwd</code> is the <code class="docutils literal notranslate">pwd</code> parameter to
<a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">ZipFile.open()</code></a>.
<div class="versionchanged">
Changed in version 3.9: Added support for text and binary modes for open. Default
mode is now text.
</div>
<div class="versionchanged">
Changed in version 3.10.10: The <code class="docutils literal notranslate">encoding</code> parameter can be supplied as a positional argument
without causing a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>. As it could in 3.9. Code needing to
be compatible with unpatched 3.10 and 3.11 versions must pass all
<a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> arguments, <code class="docutils literal notranslate">encoding</code> included, as keywords.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.iterdir">
Path.iterdir()<a class="headerlink" href="#zipfile.Path.iterdir" title="Permalink to this definition">¶</a></dt>
<dd>Enumerate the children of the current directory.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.is_dir">
Path.is_dir()<a class="headerlink" href="#zipfile.Path.is_dir" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the current context references a directory.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.is_file">
Path.is_file()<a class="headerlink" href="#zipfile.Path.is_file" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the current context references a file.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.exists">
Path.exists()<a class="headerlink" href="#zipfile.Path.exists" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if the current context references a file or
directory in the zip file.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.read_text">
Path.read_text(*, **)<a class="headerlink" href="#zipfile.Path.read_text" title="Permalink to this definition">¶</a></dt>
<dd>Read the current file as unicode text. Positional and
keyword arguments are passed through to
<a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> (except <code class="docutils literal notranslate">buffer</code>, which is
implied by the context).
<div class="versionchanged">
Changed in version 3.10.10: The <code class="docutils literal notranslate">encoding</code> parameter can be supplied as a positional argument
without causing a <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>. As it could in 3.9. Code needing to
be compatible with unpatched 3.10 and 3.11 versions must pass all
<a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate">io.TextIOWrapper</code></a> arguments, <code class="docutils literal notranslate">encoding</code> included, as keywords.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.read_bytes">
Path.read_bytes()<a class="headerlink" href="#zipfile.Path.read_bytes" title="Permalink to this definition">¶</a></dt>
<dd>Read the current file as bytes.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.Path.joinpath">
Path.joinpath(*other)<a class="headerlink" href="#zipfile.Path.joinpath" title="Permalink to this definition">¶</a></dt>
<dd>Return a new Path object with each of the other arguments
joined. The following are equivalent:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Path(...).joinpath(&#39;child&#39;).joinpath(&#39;grandchild&#39;)
&gt;&gt;&gt; Path(...).joinpath(&#39;child&#39;, &#39;grandchild&#39;)
&gt;&gt;&gt; Path(...) / &#39;child&#39; / &#39;grandchild&#39;
</pre></div>
</div>
<div class="versionchanged">
Changed in version 3.10: Prior to 3.10, <code class="docutils literal notranslate">joinpath</code> was undocumented and accepted
exactly one parameter.
</div>
</dd></dl>

</section>
<section id="pyzipfile-objects">
<h2>PyZipFile Objects<a class="headerlink" href="#pyzipfile-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#zipfile.PyZipFile" title="zipfile.PyZipFile"><code class="xref py py-class docutils literal notranslate">PyZipFile</code></a> constructor takes the same parameters as the
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> constructor, and one additional parameter, optimize.
<dl class="py class">
<dt class="sig sig-object py" id="zipfile.PyZipFile">
class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=- 1)<a class="headerlink" href="#zipfile.PyZipFile" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.2: The optimize parameter.
</div>
<div class="versionchanged">
Changed in version 3.4: ZIP64 extensions are enabled by default.
</div>
Instances have one method in addition to those of <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects:
<dl class="py method">
<dt class="sig sig-object py" id="zipfile.PyZipFile.writepy">
writepy(pathname, basename='', filterfunc=None)<a class="headerlink" href="#zipfile.PyZipFile.writepy" title="Permalink to this definition">¶</a></dt>
<dd>Search for files <code class="file docutils literal notranslate">*.py</code> and add the corresponding file to the
archive.
If the optimize parameter to <a class="reference internal" href="#zipfile.PyZipFile" title="zipfile.PyZipFile"><code class="xref py py-class docutils literal notranslate">PyZipFile</code></a> was not given or <code class="docutils literal notranslate">-1</code>,
the corresponding file is a <code class="file docutils literal notranslate">*.pyc</code> file, compiling if necessary.
If the optimize parameter to <a class="reference internal" href="#zipfile.PyZipFile" title="zipfile.PyZipFile"><code class="xref py py-class docutils literal notranslate">PyZipFile</code></a> was <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code> or
<code class="docutils literal notranslate">2</code>, only files with that optimization level (see <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate">compile()</code></a>) are
added to the archive, compiling if necessary.
If pathname is a file, the filename must end with <code class="file docutils literal notranslate">.py</code>, and
just the (corresponding <code class="file docutils literal notranslate">*.pyc</code>) file is added at the top level
(no path information). If pathname is a file that does not end with
<code class="file docutils literal notranslate">.py</code>, a <a class="reference internal" href="exceptions.html#RuntimeError" title="RuntimeError"><code class="xref py py-exc docutils literal notranslate">RuntimeError</code></a> will be raised. If it is a directory,
and the directory is not a package directory, then all the files
<code class="file docutils literal notranslate">*.pyc</code> are added at the top level. If the directory is a
package directory, then all <code class="file docutils literal notranslate">*.pyc</code> are added under the package
name as a file path, and if any subdirectories are package directories,
all of these are added recursively in sorted order.
basename is intended for internal use only.
filterfunc, if given, must be a function taking a single string
argument. It will be passed each path (including each individual full
file path) before it is added to the archive. If filterfunc returns a
false value, the path will not be added, and if it is a directory its
contents will be ignored. For example, if our test files are all either
in <code class="docutils literal notranslate">test</code> directories or start with the string <code class="docutils literal notranslate">test_</code>, we can use a
filterfunc to exclude them:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; zf = PyZipFile(&#39;myprog.zip&#39;)
&gt;&gt;&gt; def notests(s):
... fn = os.path.basename(s)
... return (not (fn == &#39;test&#39; or fn.startswith(&#39;test_&#39;)))
&gt;&gt;&gt; zf.writepy(&#39;myprog&#39;, filterfunc=notests)
</pre></div>
</div>
The <a class="reference internal" href="#zipfile.PyZipFile.writepy" title="zipfile.PyZipFile.writepy"><code class="xref py py-meth docutils literal notranslate">writepy()</code></a> method makes archives with file names like
this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>string.pyc # Top level name
test/__init__.pyc # Package directory
test/testall.pyc # Module test.testall
test/bogus/__init__.pyc # Subpackage directory
test/bogus/myfile.pyc # Submodule test.bogus.myfile
</pre></div>
</div>
<div class="versionadded">
New in version 3.4: The filterfunc parameter.
</div>
<div class="versionchanged">
Changed in version 3.6.2: The pathname 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.7: Recursion sorts directory entries.
</div>
</dd></dl>

</dd></dl>

</section>
<section id="zipinfo-objects">
<h2>ZipInfo Objects<a class="headerlink" href="#zipinfo-objects" title="Permalink to this headline">¶</a></h2>
Instances of the <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> class are returned by the <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> and
<a class="reference internal" href="#zipfile.ZipFile.infolist" title="zipfile.ZipFile.infolist"><code class="xref py py-meth docutils literal notranslate">infolist()</code></a> methods of <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects. Each object stores
information about a single member of the ZIP archive.
There is one classmethod to make a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance for a filesystem
file:
<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipInfo.from_file">
classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)<a class="headerlink" href="#zipfile.ZipInfo.from_file" title="Permalink to this definition">¶</a></dt>
<dd>Construct a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance for a file on the filesystem, in
preparation for adding it to a zip file.
filename should be the path to a file or directory on the filesystem.
If arcname is specified, it is used as the name within the archive.
If arcname is not specified, the name will be the same as filename, but
with any drive letter and leading path separators removed.
The strict_timestamps argument, when set to <code class="docutils literal notranslate">False</code>, allows to
zip files older than 1980-01-01 at the cost of setting the
timestamp to 1980-01-01.
Similar behavior occurs with files newer than 2107-12-31,
the timestamp is also set to the limit.
<div class="versionadded">
New in version 3.6.
</div>
<div class="versionchanged">
Changed in version 3.6.2: The filename parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>.
</div>
<div class="versionadded">
New in version 3.8: The strict_timestamps keyword-only argument
</div>
</dd></dl>

Instances have the following methods and attributes:
<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipInfo.is_dir">
ZipInfo.is_dir()<a class="headerlink" href="#zipfile.ZipInfo.is_dir" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if this archive member is a directory.
This uses the entry’s name: directories should always end with <code class="docutils literal notranslate">/</code>.
<div class="versionadded">
New in version 3.6.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.filename">
ZipInfo.filename<a class="headerlink" href="#zipfile.ZipInfo.filename" title="Permalink to this definition">¶</a></dt>
<dd>Name of the file in the archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.date_time">
ZipInfo.date_time<a class="headerlink" href="#zipfile.ZipInfo.date_time" title="Permalink to this definition">¶</a></dt>
<dd>The time and date of the last modification to the archive member. This is a
tuple of six values:
<table class="docutils align-default">
<colgroup>
<col style="width: 21%" />
<col style="width: 79%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Index</th>
<th class="head">Value</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">0</code></td>
<td>Year (&gt;= 1980)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">1</code></td>
<td>Month (one-based)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">2</code></td>
<td>Day of month (one-based)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">3</code></td>
<td>Hours (zero-based)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">4</code></td>
<td>Minutes (zero-based)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">5</code></td>
<td>Seconds (zero-based)</td>
</tr>
</tbody>
</table>
<div class="admonition note">
Note
The ZIP file format does not support timestamps before 1980.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.compress_type">
ZipInfo.compress_type<a class="headerlink" href="#zipfile.ZipInfo.compress_type" title="Permalink to this definition">¶</a></dt>
<dd>Type of compression for the archive member.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.comment">
ZipInfo.comment<a class="headerlink" href="#zipfile.ZipInfo.comment" title="Permalink to this definition">¶</a></dt>
<dd>Comment for the individual archive member as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.extra">
ZipInfo.extra<a class="headerlink" href="#zipfile.ZipInfo.extra" title="Permalink to this definition">¶</a></dt>
<dd>Expansion field data. The <a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a> contains
some comments on the internal structure of the data contained in this
<a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.create_system">
ZipInfo.create_system<a class="headerlink" href="#zipfile.ZipInfo.create_system" title="Permalink to this definition">¶</a></dt>
<dd>System which created ZIP archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.create_version">
ZipInfo.create_version<a class="headerlink" href="#zipfile.ZipInfo.create_version" title="Permalink to this definition">¶</a></dt>
<dd>PKZIP version which created ZIP archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.extract_version">
ZipInfo.extract_version<a class="headerlink" href="#zipfile.ZipInfo.extract_version" title="Permalink to this definition">¶</a></dt>
<dd>PKZIP version needed to extract archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.reserved">
ZipInfo.reserved<a class="headerlink" href="#zipfile.ZipInfo.reserved" title="Permalink to this definition">¶</a></dt>
<dd>Must be zero.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.flag_bits">
ZipInfo.flag_bits<a class="headerlink" href="#zipfile.ZipInfo.flag_bits" title="Permalink to this definition">¶</a></dt>
<dd>ZIP flag bits.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.volume">
ZipInfo.volume<a class="headerlink" href="#zipfile.ZipInfo.volume" title="Permalink to this definition">¶</a></dt>
<dd>Volume number of file header.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.internal_attr">
ZipInfo.internal_attr<a class="headerlink" href="#zipfile.ZipInfo.internal_attr" title="Permalink to this definition">¶</a></dt>
<dd>Internal attributes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.external_attr">
ZipInfo.external_attr<a class="headerlink" href="#zipfile.ZipInfo.external_attr" title="Permalink to this definition">¶</a></dt>
<dd>External file attributes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.header_offset">
ZipInfo.header_offset<a class="headerlink" href="#zipfile.ZipInfo.header_offset" title="Permalink to this definition">¶</a></dt>
<dd>Byte offset to the file header.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.CRC">
ZipInfo.CRC<a class="headerlink" href="#zipfile.ZipInfo.CRC" title="Permalink to this definition">¶</a></dt>
<dd>CRC-32 of the uncompressed file.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.compress_size">
ZipInfo.compress_size<a class="headerlink" href="#zipfile.ZipInfo.compress_size" title="Permalink to this definition">¶</a></dt>
<dd>Size of the compressed data.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.file_size">
ZipInfo.file_size<a class="headerlink" href="#zipfile.ZipInfo.file_size" title="Permalink to this definition">¶</a></dt>
<dd>Size of the uncompressed file.
</dd></dl>

</section>
<section id="command-line-interface">
<h2>Command-Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> module provides a simple command-line interface to interact
with ZIP archives.
If you want to create a new ZIP archive, specify its name after the <a class="reference internal" href="#cmdoption-zipfile-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 zipfile -c monty.zip 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 zipfile -c monty.zip life-of-brian_1979/
</pre></div>
</div>
If you want to extract a ZIP archive into the specified directory, use
the <a class="reference internal" href="#cmdoption-zipfile-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 zipfile -e monty.zip target-dir/
</pre></div>
</div>
For a list of the files in a ZIP archive, use the <a class="reference internal" href="#cmdoption-zipfile-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 zipfile -l monty.zip
</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-zipfile-l">
-l &lt;zipfile&gt;<a class="headerlink" href="#cmdoption-zipfile-l" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-zipfile-list">
--list &lt;zipfile&gt;<a class="headerlink" href="#cmdoption-zipfile-list" title="Permalink to this definition">¶</a></dt>
<dd>List files in a zipfile.
</dd></dl>

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

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-zipfile-e">
-e &lt;zipfile&gt; &lt;output_dir&gt;<a class="headerlink" href="#cmdoption-zipfile-e" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-zipfile-extract">
--extract &lt;zipfile&gt; &lt;output_dir&gt;<a class="headerlink" href="#cmdoption-zipfile-extract" title="Permalink to this definition">¶</a></dt>
<dd>Extract zipfile into target directory.
</dd></dl>

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

</section>
</section>
<section id="decompression-pitfalls">
<h2>Decompression pitfalls<a class="headerlink" href="#decompression-pitfalls" title="Permalink to this headline">¶</a></h2>
The extraction in zipfile module might fail due to some pitfalls listed below.
<section id="from-file-itself">
<h3>From file itself<a class="headerlink" href="#from-file-itself" title="Permalink to this headline">¶</a></h3>
Decompression may fail due to incorrect password / CRC checksum / ZIP format or
unsupported compression method / decryption.
</section>
<section id="file-system-limitations">
<h3>File System limitations<a class="headerlink" href="#file-system-limitations" title="Permalink to this headline">¶</a></h3>
Exceeding limitations on different file systems can cause decompression failed.
Such as allowable characters in the directory entries, length of the file name,
length of the pathname, size of a single file, and number of files, etc.
</section>
<section id="resources-limitations">
<h3>Resources limitations<a class="headerlink" href="#resources-limitations" title="Permalink to this headline">¶</a></h3>
The lack of memory or disk volume would lead to decompression
failed. For example, decompression bombs (aka <a class="reference external" href="https://en.wikipedia.org/wiki/Zip_bomb">ZIP bomb</a>)
apply to zipfile library that can cause disk volume exhaustion.
</section>
<section id="interruption">
<h3>Interruption<a class="headerlink" href="#interruption" title="Permalink to this headline">¶</a></h3>
Interruption during the decompression, such as pressing control-C or killing the
decompression process may result in incomplete decompression of the archive.
</section>
<section id="default-behaviors-of-extraction">
<h3>Default behaviors of extraction<a class="headerlink" href="#default-behaviors-of-extraction" title="Permalink to this headline">¶</a></h3>
Not knowing the default extraction behaviors
can cause unexpected decompression results.
For example, when extracting the same archive twice,
it overwrites files without asking.
</section>
</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">zipfile</code> — Work with ZIP archives</a><ul>
<li><a class="reference internal" href="#zipfile-objects">ZipFile Objects</a></li>
<li><a class="reference internal" href="#path-objects">Path Objects</a></li>
<li><a class="reference internal" href="#pyzipfile-objects">PyZipFile Objects</a></li>
<li><a class="reference internal" href="#zipinfo-objects">ZipInfo Objects</a></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="#decompression-pitfalls">Decompression pitfalls</a><ul>
<li><a class="reference internal" href="#from-file-itself">From file itself</a></li>
<li><a class="reference internal" href="#file-system-limitations">File System limitations</a></li>
<li><a class="reference internal" href="#resources-limitations">Resources limitations</a></li>
<li><a class="reference internal" href="#interruption">Interruption</a></li>
<li><a class="reference internal" href="#default-behaviors-of-extraction">Default behaviors of extraction</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="lzma.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">lzma</code> — Compression using the LZMA algorithm</a>
 <h4>Next topic</h4>
 <a href="tarfile.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</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/zipfile.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="tarfile.html" title="tarfile — Read and write tar archive files"
 >next</a> |</li>
 <li class="right" >
 <a href="lzma.html" title="lzma — Compression using the LZMA algorithm"
 >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">zipfile</code> — Work with ZIP archives</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 : zipfile.html