Skip to content

gh-58083: Expand the introduction of the cmd module #155738

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

Open
mangrisano wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

gh-58083: Expand the introduction of the cmd module #155738

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions Doc/library/cmd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ command interpreters. These are often useful for test harnesses, administrative
tools, and prototypes that will later be wrapped in a more sophisticated
interface.

A command interpreter built with :class:`Cmd` presents the user with an
interactive prompt, reads input one line at a time, and runs each command by
calling the method whose name matches it. For example, the ``help`` command is
handled by a ``do_help()`` method. Apart from the built-in ``help`` command,
the interpreter's behavior is defined by the ``do_*`` methods you add in your
own subclass.

.. class:: Cmd(completekey='tab', stdin=None, stdout=None)

A :class:`Cmd` instance or subclass instance is a line-oriented interpreter
Expand Down
Loading