gh-109435: Add Doc/library/cmdline.rst (#109436)

Document modules providing a command-line interface (CLI).
This commit is contained in:
Victor Stinner 2023-09-19 13:57:28 +02:00 committed by GitHub
parent afa7b0d743
commit 59f32a785f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 70 additions and 0 deletions

View file

@ -56,6 +56,8 @@ Additionally, there are **low-level** APIs for
* :ref:`bridge <asyncio-futures>` callback-based libraries and code
with async/await syntax.
.. _asyncio-cli:
You can experiment with an ``asyncio`` concurrent context in the REPL:
.. code-block:: pycon

57
Doc/library/cmdline.rst Normal file
View file

@ -0,0 +1,57 @@
++++++++++++++++++++++++++++++++++++
Modules command-line interface (CLI)
++++++++++++++++++++++++++++++++++++
The following modules have a command-line interface.
* :ref:`ast <ast-cli>`
* :ref:`asyncio <asyncio-cli>`
* :mod:`base64`
* :ref:`calendar <calendar-cli>`
* :mod:`code`
* :ref:`compileall <compileall-cli>`
* :mod:`cProfile`: see :ref:`profile <profile-cli>`
* :ref:`difflib <difflib-interface>`
* :mod:`dis`
* :mod:`doctest`
* :mod:`!encodings.rot_13`
* :mod:`ensurepip`
* :mod:`filecmp`
* :mod:`fileinput`
* :mod:`ftplib`
* :ref:`gzip <gzip-cli>`
* :ref:`http.server <http-server-cli>`
* :mod:`!idlelib`
* :ref:`inspect <inspect-module-cli>`
* :ref:`json.tool <json-commandline>`
* :mod:`mimetypes`
* :mod:`pdb`
* :mod:`pickle`
* :ref:`pickletools <pickletools-cli>`
* :mod:`platform`
* :mod:`poplib`
* :ref:`profile <profile-cli>`
* :mod:`pstats`
* :ref:`py_compile <py_compile-cli>`
* :mod:`pyclbr`
* :mod:`pydoc`
* :mod:`quopri`
* :mod:`runpy`
* :ref:`site <site-commandline>`
* :ref:`sqlite3 <sqlite3-cli>`
* :ref:`sysconfig <sysconfig-cli>`
* :mod:`tabnanny`
* :ref:`tarfile <tarfile-commandline>`
* :mod:`!this`
* :ref:`timeit <timeit-command-line-interface>`
* :ref:`tokenize <tokenize-cli>`
* :ref:`trace <trace-cli>`
* :mod:`turtledemo`
* :ref:`unittest <unittest-command-line-interface>`
* :ref:`uuid <uuid-cli>`
* :mod:`venv`
* :mod:`webbrowser`
* :ref:`zipapp <zipapp-command-line-interface>`
* :ref:`zipfile <zipfile-commandline>`
See also the :ref:`Python command-line interface <using-on-general>`.

View file

@ -16,6 +16,8 @@ have write permission to the library directories.
.. include:: ../includes/wasm-notavail.rst
.. _compileall-cli:
Command-line use
----------------

View file

@ -250,6 +250,8 @@ Example of how to GZIP compress a binary string::
.. program:: gzip
.. _gzip-cli:
Command Line Interface
----------------------

View file

@ -73,5 +73,6 @@ the `Python Package Index <https://pypi.org>`_.
language.rst
windows.rst
unix.rst
cmdline.rst
superseded.rst
security_warnings.rst

View file

@ -17,6 +17,8 @@ are useful for Python core developers who are working on the :mod:`pickle`;
ordinary users of the :mod:`pickle` module probably won't find the
:mod:`pickletools` module relevant.
.. _pickletools-cli:
Command line usage
------------------

View file

@ -121,6 +121,8 @@ results to a file by specifying a filename to the :func:`run` function::
The :class:`pstats.Stats` class reads profile results from a file and formats
them in various ways.
.. _profile-cli:
The files :mod:`cProfile` and :mod:`profile` can also be invoked as a script to
profile another script. For example::

View file

@ -125,6 +125,7 @@ byte-code cache files in the directory containing the source code.
This option is useful when the ``.pycs`` are kept up to date by some
system external to Python like a build system.
.. _py_compile-cli:
Command-Line Interface
----------------------

View file

@ -278,6 +278,7 @@ Other functions
Return the path of :file:`Makefile`.
.. _sysconfig-cli:
Using :mod:`sysconfig` as a script
----------------------------------