Skip to content
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

Mention the usage of Python's builtin readline module in the documentation #1634

Merged
merged 6 commits into from
Nov 7, 2021
Merged

Mention the usage of Python's builtin readline module in the documentation #1634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3949754
Add the sphinx.ext.intersphinx plugin
schneiderfelipe Oct 31, 2021
3844ae8
Link to Python's builtin input()
schneiderfelipe Oct 31, 2021
8f9131c
Distinguish input() method from function
schneiderfelipe Oct 31, 2021
eac0767
Mention Python's buitin readline module in the docs
schneiderfelipe Oct 31, 2021
313ee3f
Cross-link the console API from prompts
schneiderfelipe Oct 31, 2021
747e55b
Cross-link Python's builtin input() and readline from Console.input()
schneiderfelipe Oct 31, 2021
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
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"sphinx_copybutton",
]
Expand Down
4 changes: 3 additions & 1 deletion docs/source/console.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,12 +238,14 @@ The :meth:`~rich.console.Console.print` method has a boolean ``crop`` argument.
Input
-----

The console class has an :meth:`~rich.console.Console.input` which works in the same way as Python's builtin ``input()`` method, but can use anything that Rich can print as a prompt. For example, here's a colorful prompt with an emoji::
The console class has an :meth:`~rich.console.Console.input` method which works in the same way as Python's builtin :func:`input` function, but can use anything that Rich can print as a prompt. For example, here's a colorful prompt with an emoji::

from rich.console import Console
console = Console()
console.input("What is [i]your[/i] [bold red]name[/]? :smiley: ")

If Python's builtin :mod:`readline` module is previously loaded, elaborate line editing and history features will be available.

Exporting
---------

Expand Down
2 changes: 1 addition & 1 deletion docs/source/prompt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Prompt
======

Rich has a number of :class:`~rich.prompt.Prompt` classes which ask a user for input and loop until a valid response is received. Here's a simple example::
Rich has a number of :class:`~rich.prompt.Prompt` classes which ask a user for input and loop until a valid response is received (they all use the :ref:`Console API<Input>` internally). Here's a simple example::

>>> from rich.prompt import Prompt
>>> name = Prompt.ask("Enter your name")
Expand Down
2 changes: 2 additions & 0 deletions rich/console.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1919,6 +1919,8 @@ def input(
) -> str:
"""Displays a prompt and waits for input from the user. The prompt may contain color / style.

It works in the same way as Python's builtin :func:`input` function and provides elaborate line editing and history features if Python's builtin :mod:`readline` module is previously loaded.

Args:
prompt (Union[str, Text]): Text to render in the prompt.
markup (bool, optional): Enable console markup (requires a str prompt). Defaults to True.
Expand Down