gh-59150: Add table of runnable modules #93410
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -112,6 +112,79 @@ source. | ||
| python -m timeit -s 'setup here' 'benchmarked code here' | ||
| python -m timeit -h # for details | ||
|
|
||
| Other modules include | ||
|
There was a problem hiding this comment. I have to agree with @rhettinger that this is not the right place to document this. There was a problem hiding this comment. Would you say that such a list should be on some other page instead, or that it shouldn't be on the official docs at all? There was a problem hiding this comment. I feel that it doesn't make sense for such a list to exist. What would you do with such a list? It's like making a list of all UNIX commands that have a There was a problem hiding this comment.
Who is a target audience of the tools? Currently the documentation is dedicated to Python programmers and CPython plugin authors. The most of tools, however, seems to be for more broad audience like sysadmin users. Should we force them to sift through a sizable There was a problem hiding this comment. That's as good an argument against inluding this list as any, because half the commands supported here are of no use to sysadmin users (unless they are also Python programmers). If you want to post this list (or something like it) in a blog or on realpython.com, feel free, but the Python docs are for Python programmers. |
||
|
|
||
| .. list-table:: | ||
|
|
||
| * - :mod:`ast` | ||
| - Process Python Abstract Syntax Trees | ||
|
|
||
| * - :mod:`asyncio` | ||
| - Launch a natively async REPL | ||
|
|
||
| * - :mod:`compileall` | ||
| - 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 | ||
|
|
||
| * - :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` | ||
| - 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:: | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IDLE is primarily an application, and secondly a module for use by IDLE extension writers. So I wouldn’t change this heading!