From e0f9c1e8f4e1bc98fe610e2e95bed46c0cfb2ff9 Mon Sep 17 00:00:00 2001 From: slateny <46876382+slateny@users.noreply.github.com> Date: Wed, 1 Jun 2022 01:31:31 -0700 Subject: [PATCH 1/2] Add table of runnable modules --- Doc/using/cmdline.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 07c05a94b99f98..9c055e1fb73ff5 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -112,6 +112,34 @@ source. python -m timeit -s 'setup here' 'benchmarked code here' python -m timeit -h # for details + Other modules include + + .. list-table:: + + * - :mod:`compileall` + - Precompiling Python source modules to bytecode + + * - :mod:`pickle` + - Display the contents of pickles saved as files + + * - :mod:`pickletools` + - Analyse the contents of pickles saved as files + + * - :mod:`site` + - Display details of Python's configuration + + * - :mod:`sysconfig` + - Display additional details of Python's configuration + + * - :mod:`test` + - Execute Python's own regression test suite + + * - :mod:`timeit` + - Microbenchmarking for small Python snippets + + * - :mod:`unittest` + - Find and execute unit tests + .. audit-event:: cpython.run_module module-name cmdoption-m .. seealso:: From 8a4b25d04bec5a3f1ff5f8eddba8c42fa2aeb5a5 Mon Sep 17 00:00:00 2001 From: slateny <46876382+slateny@users.noreply.github.com> Date: Wed, 1 Jun 2022 02:14:48 -0700 Subject: [PATCH 2/2] Add more modules, add module link to idlelib --- Doc/library/idle.rst | 6 ++++-- Doc/using/cmdline.rst | 49 +++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 51 insertions(+), 4 deletions(-) diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index d6021042c61166..ec4c3e4c49b1dc 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -1,7 +1,9 @@ .. _idle: -IDLE -==== +:mod:`idlelib` --- IDLE +======================= + +.. module:: idlelib .. moduleauthor:: Guido van Rossum diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 9c055e1fb73ff5..43c94676f795cb 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -116,8 +116,26 @@ source. .. list-table:: + * - :mod:`ast` + - Process Python Abstract Syntax Trees + + * - :mod:`asyncio` + - Launch a natively async REPL + * - :mod:`compileall` - - Precompiling Python source modules to bytecode + - Precompile Python source modules to bytecode + + * - :mod:`doctest` + - Run :func:`doctest.testmod` on a module + + * - :mod:`http.server` + - Create a server that serves files in the current directory + + * - :mod:`idlelib` + - Open IDLE + + * - :mod:`json.tool` + - Validate and pretty-print JSON objects * - :mod:`pickle` - Display the contents of pickles saved as files @@ -125,21 +143,48 @@ source. * - :mod:`pickletools` - Analyse the contents of pickles saved as files + * - :mod:`profile` + - Profile Python programs + * - :mod:`site` - Display details of Python's configuration * - :mod:`sysconfig` - Display additional details of Python's configuration + * - :mod:`tarfile` + - Interact with tar archives + * - :mod:`test` - Execute Python's own regression test suite * - :mod:`timeit` - - Microbenchmarking for small Python snippets + - Microbenchmark small Python snippets + + * - :mod:`tkinter` + - Open a Tk interface to verify proper installation + + * - :mod:`tokenize` + - Tokenize Python source code + + * - :mod:`trace` + - Trace program execution * - :mod:`unittest` - Find and execute unit tests + * - :mod:`webbrowser` + - Open a page in a new browser window or tab + + * - :mod:`xmlrpc.client` + - Launch demo XMLRPC client + + * - :mod:`xmlrpc.server` + - Launch demo XMLRPC server + + * - :mod:`zipapp` + - Manage Python zip files + .. audit-event:: cpython.run_module module-name cmdoption-m .. seealso::