8000 [3.11] gh-108826: Document `dis` module CLI and rename `_test` functi… · python/cpython@fd061a9 · GitHub
[go: up one dir, main page]
Skip to content

Commit fd061a9

Browse files
hugovkblurb-it[bot]chgnrdv
authored
[3.11] gh-108826: Document dis module CLI and rename _test function to main (#108827) (#110689)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Radislav Chugunov <52372310+chgnrdv@users.noreply.github.com>
1 parent ad50415 commit fd061a9

File tree

12 files changed

+97
-3
lines changed

12 files changed

+97
-3
lines changed

‎Doc/library/asyncio.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Additionally, there are **low-level** APIs for
5656
* :ref:`bridge <asyncio-futures>` callback-based libraries and code
5757
with async/await syntax.
5858

59+
.. _asyncio-cli:
60+
5961
You can experiment with an ``asyncio`` concurrent context in the REPL:
6062

6163
.. code-block:: pycon

‎Doc/library/cmdline.rst

Lines changed: 55 additions & 0 deletions
< E864 /tr>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
++++++++++++++++++++++++++++++++++++
2+
Modules command-line interface (CLI)
3+
++++++++++++++++++++++++++++++++++++
4+
5+
The following modules have a command-line interface.
6+
7+
* :ref:`ast <ast-cli>`
8+
* :ref:`asyncio <asyncio-cli>`
9+
* :mod:`base64`
10+
* :ref:`calendar <calendar-cli>`
11+
* :mod:`code`
12+
* :ref:`compileall <compileall-cli>`
13+
* :mod:`cProfile`: see :ref:`profile <profile-cli>`
14+
* :ref:`difflib <difflib-interface>`
15+
* :ref:`dis <dis-cli>`
16+
* :mod:`doctest`
17+
* :mod:`!encodings.rot_13`
18+
* :mod:`ensurepip`
19+
* :mod:`filecmp`
20+
* :mod:`fileinput`
21+
* :mod:`ftplib`
22+
* :ref:`gzip <gzip-cli>`
23+
* :ref:`http.server <http-server-cli>`
24+
* :mod:`!idlelib`
25+
* :ref:`inspect <inspect-module-cli>`
26+
* :ref:`json.tool <json-commandline>`
27+
* :mod:`mimetypes`
28+
* :mod:`pdb`
29+
* :mod:`pickle`
30+
* :ref:`pickletools <pickletools-cli>`
31+
* :mod:`platform`
32+
* :mod:`poplib`
33+
* :ref:`profile <profile-cli>`
34+
* :mod:`pstats`
35+
* :ref:`py_compile <py_compile-cli>`
36+
* :mod:`pyclbr`
37+
* :mod:`pydoc`
38+
* :mod:`quopri`
39+
* :mod:`runpy`
40+
* :ref:`site <site-commandline>`
41+
* :ref:`sysconfig <sysconfig-cli>`
42+
* :mod:`tabnanny`
43+
* :ref:`tarfile <tarfile-commandline>`
44+
* :mod:`!this`
45+
* :ref:`timeit <timeit-command-line-interface>`
46+
* :ref:`tokenize <tokenize-cli>`
47+
* :ref:`trace <trace-cli>`
48+
* :mod:`turtledemo`
49+
* :ref:`unittest <unittest-command-line-interface>`
50+
* :mod:`venv`
51+
* :mod:`webbrowser`
52+
* :ref:`zipapp <zipapp-command-line-interface>`
53+
* :ref:`zipfile <zipfile-commandline>`
54+
55+
See also the :ref:`Python command-line interface <using-on-general>`.

‎Doc/library/compileall.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ have write permission to the library directories.
1616

1717
.. include:: ../includes/wasm-notavail.rst
1818

19+
.. _compileall-cli:
20+
1921
Command-line use
2022
----------------
2123

‎Doc/library/dis.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,32 @@ the following command can be used to display the disassembly of
6464

6565
(The "2" is a line number).
6666

67+
.. _dis-cli:
68+
69+
Command-line interface
70+
----------------------
71+
72+
The :mod:`dis` module can be invoked as a script from the command line:
73+
74+
.. code-block:: sh
75+
76+
python -m dis [-h] [-C] [infile]
77+
78+
The following options are accepted:
79+
80+
.. program:: dis
81+
82+
.. cmdoption:: -h, --help
83+
84+
Display usage and exit.
85+
86+
.. cmdoption:: -C, --show-caches
87+
88+
Show inline caches.
89+
90+
If :file:`infile` is specified, its disassembled code will be written to stdout.
91+
Otherwise, disassembly is performed on compiled source code recieved from stdin.
92+
6793
Bytecode analysis
6894
-----------------
6995

‎Doc/library/gzip.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,8 @@ Example of how to GZIP compress a binary string::
246246

247247
.. program:: gzip
248248

249+
.. _gzip-cli:
250+
249251
Command Line Interface
250252
----------------------
251253

‎Doc/library/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,6 @@ the `Python Package Index <https://pypi.org>`_.
7373
language.rst
7474
windows.rst
7575
unix.rst
76+
cmdline.rst
7677
superseded.rst
7778
security_warnings.rst

‎Doc/library/pickletools.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ are useful for Python core developers who are working on the :mod:`pickle`;
1717
ordinary users of the :mod:`pickle` module probably won't find the
1818
:mod:`pickletools` module relevant.
1919

20+
.. _pickletools-cli:
21+
2022
Command line usage
2123
------------------
2224

‎Doc/library/profile.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ results to a file by specifying a filename to the :func:`run` function::
121121
The :class:`pstats.Stats` class reads profile results from a file and formats
122122
them in various ways.
123123

124+
.. _profile-cli:
125+
124126
The files :mod:`cProfile` and :mod:`profile` can also be invoked as a script to
125127
profile another script. For example::
126128

‎Doc/library/py_compile.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ byte-code cache files in the directory containing the source code.
125125
This option is useful when the ``.pycs`` are kept up to date by some
126126
system external to Python like a build system.
127127

128+
.. _py_compile-cli:
128129

129130
Command-Line Interface
130131
----------------------

‎Doc/library/sysconfig.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,7 @@ Other functions
278278

279279
Return the path of :file:`Makefile`.
280280

281+
.. _sysconfig-cli:
281282

282283
Using :mod:`sysconfig` as a script
283284
----------------------------------

‎Lib/dis.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -759,8 +759,7 @@ def dis(self):
759759
return output.getvalue()
760760

761761

762-
def _test():
763-
"""Simple test program to disassemble a file."""
762+
def main():
764763
import argparse
765764

766765
parser = argparse.ArgumentParser()
@@ -772,4 +771,4 @@ def _test():
772771
dis(code)
773772

774773
if __name__ == "__main__":
775-
_test()
774+
main()

‎Misc/NEWS.d/next/Documentation/2023-09-03-13-43-49.gh-issue-108826.KG7abS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
:mod:`dis` module command-line interface is now mentioned in documentation.

0 commit comments

Comments
 (0)
0