Skip to content

Document disabling validation in a prompt session #2161

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
JackyHsu-X wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document disabling validation in a prompt session #2161

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
24 changes: 24 additions & 0 deletions docs/pages/asking_for_input.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,30 @@ not by returning a boolean.
cursor position is not possible this way.


Changing validation in a session
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A :class:`~prompt_toolkit.shortcuts.PromptSession` remembers the validator passed
to :meth:`~prompt_toolkit.shortcuts.PromptSession.prompt` for subsequent prompts.
Passing ``validator=None`` keeps the current validator; it does not disable
validation. Pass a :class:`~prompt_toolkit.validation.DummyValidator` to accept
any input, including an empty string:

.. code:: python

from prompt_toolkit import PromptSession
from prompt_toolkit.validation import DummyValidator, Validator

session = PromptSession()
required = Validator.from_callable(bool, error_message="Please enter a value")

name = session.prompt("Name (required): ", validator=required)
nickname = session.prompt("Nickname (optional): ", validator=DummyValidator())

The ``DummyValidator`` also remains active for subsequent prompts. Pass the
original validator again when validation is needed.


History
-------

Expand Down
Loading