Issue #28513: Documented command-line interface of zipfile.

This commit is contained in:
Serhiy Storchaka 2016-11-02 12:11:32 +02:00
commit d8d9da04b7
2 changed files with 61 additions and 0 deletions

View File

@ -632,4 +632,60 @@ Instances have the following methods and attributes:
Size of the uncompressed file.
.. _zipfile-commandline:
.. program:: zipfile
Command-Line Interface
----------------------
The :mod:`zipfile` 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 :option:`-c`
option and then list the filename(s) that should be included:
.. code-block:: shell-session
$ python -m zipfile -c monty.zip spam.txt eggs.txt
Passing a directory is also acceptable:
.. code-block:: shell-session
$ python -m zipfile -c monty.zip life-of-brian_1979/
If you want to extract a ZIP archive into the specified directory, use
the :option:`-e` option:
.. code-block:: shell-session
$ python -m zipfile -e monty.zip target-dir/
For a list of the files in a ZIP archive, use the :option:`-l` option:
.. code-block:: shell-session
$ python -m zipfile -l monty.zip
Command-line options
~~~~~~~~~~~~~~~~~~~~
.. cmdoption:: -l <zipfile>
List files in a zipfile.
.. cmdoption:: -c <zipfile> <source1> ... <sourceN>
Create zipfile from source files.
.. cmdoption:: -e <zipfile> <output_dir>
Extract zipfile into target directory.
.. cmdoption:: -t <zipfile>
Test whether the zipfile is valid or not.
.. _PKZIP Application Note: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

View File

@ -16,6 +16,11 @@ Core and Builtins
Library
-------
Documentation
-------------
- Issue #28513: Documented command-line interface of zipfile.
What's New in Python 3.6.0 beta 3
=================================