8000 gh-59150: Add table of runnable modules by slateny · Pull Request #93410 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-59150: Add table of runnable modules #93410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

gh-59150: Add table of runnable modules #93410

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0f9c1e
Add table of runnable modules
slateny Jun 1, 2022
8a4b25d
Add more modules, add module link to idlelib
slateny Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add table of runnable modules
  • Loading branch information
@slateny
slateny committed Jun 1, 2022
commit e0f9c1e8f4e1bc98fe610e2e95bed46c0cfb2ff9
28 changes: 28 additions & 0 deletions Doc/using/cmdline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,34 @@ source.
python -m timeit -s 'setup here' 'benchmarked code here'
python -m timeit -h # for details

Other modules include
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have to agree with @rhettinger that this is not the right place to document this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 -j flag.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's like making a list of all UNIX commands that have a -j flag.

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 man(3)-like docs while they, expecting just man(1), need nothing more than simple advertisement of available CLI tools to keep them on the belt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:`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::
Expand Down
0