failed WRONG_FIX wrong_fix · 12 tool calls · 167 s · Textualize/rich
Case insensitive prompt choices
## Type of changes
- [ ] Bug fix
- [x] New feature
- [ ] Documentation / docstrings
- [ ] Tests
- [ ] Other
## Checklist
- [x] I've run the latest [black](https://github.com/psf/black) with default args on new code.
- [x] I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
- [x] I've added tests for new code.
- [x] I accept that @willmcgugan may be pedantic in the code review.
## Description
Optional flag for `Prompt.ask` allowing case-insensitive responses. Just add `case_sensitive=False` to the command options:
```python
from rich.prompt import Prompt
name = Prompt.ask("Enter your name", choices=["Paul", "Jessica", "Duncan"], default="Paul", case_sensitive=False)
```
Now, it would accept "paul" or "Paul" as valid responses. Defaults to True, which is the usual result.
| # | Tool | Arguments | Result |
|---|---|---|---|
| 1 | run_command | {
"command": "grep -rn \"class Prompt\" rich | head -20"
} | {"status": "ok", "stdout": "rich/prompt.py:11:class PromptError(Exception):\nrich/prompt.py:30:class PromptBase(Generic[PromptType]):\nrich/prompt.py:286:class full{"status": "ok", "stdout": "rich/prompt.py:11:class PromptError(Exception):\nrich/prompt.py:30:class PromptBase(Generic[PromptType]):\nrich/prompt.py:286:class Prompt(PromptBase[str]):\n", "stderr": "", "exit_code": 0} |
| 2 | run_command | {
"command": "cat rich/prompt.py"
} | {"status": "ok", "stdout": "from typing import Any, Generic, List, Optional, TextIO, TypeVar, Union, overload\n\nfrom . import get_console\nfrom .console importfull{"status": "ok", "stdout": "from typing import Any, Generic, List, Optional, TextIO, TypeVar, Union, overload\n\nfrom . import get_console\nfrom .console import Console\nfrom .text import Text, TextType\n\nPromptType = TypeVar(\"PromptType\")\nDefaultType = TypeVar(\"DefaultType\")\n\n\nclass PromptError(Exception):\n \"\"\"Exception base class for prompt related errors.\"\"\"\n\n\nclass InvalidResponse(PromptError):\n \"\"\"Exception to indicate a response was invalid. Raise this within process_response() to indicate an error\n and provide an error message.\n\n Args:\n message (Union[str, Text]): Error message.\n \"\"\"\n\n def __init__(self, message: TextType) -> None:\n self.message = message\n\n def __rich__(self) -> TextType:\n return self.message\n\n\nclass PromptBase(Generic[PromptType]):\n \"\"\"Ask the user for input until a valid response is received. This is the base class, see one of\n the concrete classes for examples.\n\n Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n \"\"\"\n\n response_type: type = str\n\n validate_error_message = \"[prompt.invalid]Please enter a valid value\"\n illegal_choice_message = (\n \"[prompt.invalid.choice]Please select one of the available options\"\n )\n prompt_suffix = \": \"\n\n choices: Optional[List[str]] = None\n\n def __init__(\n self,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Opt |
| 3 | run_command | {
"command": "cat rich/prompt.py | tail -n +100"
} | {"status": "ok", "stdout": " show_default: bool = True,\n show_choices: bool = True,\n stream: Optional[TextIO] = None,\n ) -> PromptType:\n ...\n\n @classmethofull{"status": "ok", "stdout": " show_default: bool = True,\n show_choices: bool = True,\n stream: Optional[TextIO] = None,\n ) -> PromptType:\n ...\n\n @classmethod\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n default: Any = ...,\n stream: Optional[TextIO] = None,\n ) -> Any:\n \"\"\"Shortcut to construct and run a prompt loop and return the result.\n\n Example:\n >>> filename = Prompt.ask(\"Enter a filename\")\n\n Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.\n \"\"\"\n _prompt = cls(\n prompt,\n console=console,\n password=password,\n choices=choices,\n show_default=show_default,\n show_choices=show_choices,\n )\n return _prompt(default=default, stream=stream)\n\n def render_default(self, default: DefaultType) -> Text:\n \"\"\"Turn the supplied default in to a Text instance.\n\n Args:\n default (DefaultType): Default value.\n\n Returns:\n Text: Text containing rendering of default value.\n \"\"\"\n return Text(f\"({default})\", \"pr |
| 4 | run_command | {
"command": "cat rich/prompt.py | tail -n +150"
} | {"status": "ok", "stdout": " Text: Text containing rendering of default value.\n \"\"\"\n return Text(f\"({default})\", \"prompt.default\")\n\n def make_prompt(full{"status": "ok", "stdout": " Text: Text containing rendering of default value.\n \"\"\"\n return Text(f\"({default})\", \"prompt.default\")\n\n def make_prompt(self, default: DefaultType) -> Text:\n \"\"\"Make prompt text.\n\n Args:\n default (DefaultType): Default value.\n\n Returns:\n Text: Text to display in prompt.\n \"\"\"\n prompt = self.prompt.copy()\n prompt.end = \"\"\n\n if self.show_choices and self.choices:\n _choices = \"/\".join(self.choices)\n choices = f\"[{_choices}]\"\n prompt.append(\" \")\n prompt.append(choices, \"prompt.choices\")\n\n if (\n default != ...\n and self.show_default\n and isinstance(default, (str, self.response_type))\n ):\n prompt.append(\" \")\n _default = self.render_default(default)\n prompt.append(_default)\n\n prompt.append(self.prompt_suffix)\n\n return prompt\n\n @classmethod\n def get_input(\n cls,\n console: Console,\n prompt: TextType,\n password: bool,\n stream: Optional[TextIO] = None,\n ) -> str:\n \"\"\"Get input from user.\n\n Args:\n console (Console): Console instance.\n prompt (TextType): Prompt text.\n password (bool): Enable password entry.\n\n Returns:\n str: String from user.\n \"\"\"\n return console.input(prompt, password=password, stream=stream)\n\n def check_choice(self, value: str) -> bool:\n \"\"\"Check value is in the list of valid choices.\n\n Args:\n value (str): Value entered by user.\n\n Returns:\n bool: True if choice was valid, otherwise False.\n \"\"\"\n assert self.choices is not None\n return value.strip() in self.choices\n\n def process_response(self, value: str) -> Pro |
| 5 | run_command | {
"command": "cat rich/prompt.py | head -n 100"
} | {"status": "ok", "stdout": "from typing import Any, Generic, List, Optional, TextIO, TypeVar, Union, overload\n\nfrom . import get_console\nfrom .console importfull{"status": "ok", "stdout": "from typing import Any, Generic, List, Optional, TextIO, TypeVar, Union, overload\n\nfrom . import get_console\nfrom .console import Console\nfrom .text import Text, TextType\n\nPromptType = TypeVar(\"PromptType\")\nDefaultType = TypeVar(\"DefaultType\")\n\n\nclass PromptError(Exception):\n \"\"\"Exception base class for prompt related errors.\"\"\"\n\n\nclass InvalidResponse(PromptError):\n \"\"\"Exception to indicate a response was invalid. Raise this within process_response() to indicate an error\n and provide an error message.\n\n Args:\n message (Union[str, Text]): Error message.\n \"\"\"\n\n def __init__(self, message: TextType) -> None:\n self.message = message\n\n def __rich__(self) -> TextType:\n return self.message\n\n\nclass PromptBase(Generic[PromptType]):\n \"\"\"Ask the user for input until a valid response is received. This is the base class, see one of\n the concrete classes for examples.\n\n Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n \"\"\"\n\n response_type: type = str\n\n validate_error_message = \"[prompt.invalid]Please enter a valid value\"\n illegal_choice_message = (\n \"[prompt.invalid.choice]Please select one of the available options\"\n )\n prompt_suffix = \": \"\n\n choices: Optional[List[str]] = None\n\n def __init__(\n self,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Opt |
| 6 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.\n \"\"\",old_string:",
"Args": "prompt (TextType",
"optional)": "Show choices in prompt. Defaults to True.<|\"|>",
"], optional)": "A list of valid choices. Defaults to None.\n show_default (bool"
} | {'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is full{'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is IMPORTANT for you to provide all the mandatory parameters.'} |
| 7-8 ×2 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.\n \"\"\",old_string:",
"Args": "prompt (TextType",
"optional)": "Show choices in prompt. Defaults to True.\n \"\"\"<|\"|>",
"], optional)": "A list of valid choices. Defaults to None.\n show_default (bool"
} | {'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is full{'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is IMPORTANT for you to provide all the mandatory parameters.'} |
| 9 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.\n \"\"\",old_string:",
"Args": "prompt (TextType",
"optional)": "Show choices in prompt. Defaults to True.<|\"|>",
"], optional)": "A list of valid choices. Defaults to None.\n show_default (bool"
} | {'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is full{'error': 'Invoking `edit_file()` failed as the following mandatory input parameters are not present:\nold_string\nYou could retry calling this tool, but it is IMPORTANT for you to provide all the mandatory parameters.'} |
| 10 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " show_default: bool = True,\n show_choices: bool = True,\n case_sensitive: bool = True,\n ) -> None:\n self.console = console or get_console()\n self.prompt = (\n Text.from_markup(prompt, style=\"prompt\")\n if isinstance(prompt, str)\n else prompt\n )\n self.password = password\n if choices is not None:\n self.choices = choices\n self.show_default = show_default\n self.show_choices = show_choices\n self.case_sensitive = case_sensitive",
"old_string": " show_default: bool = True,\n show_choices: bool = True,\n ) -> None:\n self.console = console or get_console()\n self.prompt = (\n Text.from_markup(prompt, style=\"prompt\")\n if isinstance(prompt, str)\n else prompt\n )\n self.password = password\n if choices is not None:\n self.choices = choices\n self.show_default = show_default\n self.show_choices = show_choices"
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -59,6 +59,7 @@\n cfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -59,6 +59,7 @@\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n+ case_sensitive: bool = True,\n ) -> None:\n self.console = console or get_console()\n self.prompt = (\n@@ -71,6 +72,7 @@\n self.choices = choices\n self.show_default = show_default\n self.show_choices = show_choices\n+ self.case_sensitive = case_sensitive\n \n @classmethod\n @overload\n", "is_truncated": false} |
| 11 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " @classmethod\n @overload\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n case_sensitive: bool = True,\n default: DefaultType,\n stream: Optional[TextIO] = None,\n ) -> Union[DefaultType, PromptType]:\n ...",
"old_string": " @classmethod\n @overload\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n default: DefaultType,\n stream: Optional[TextIO] = None,\n ) -> Union[DefaultType, PromptType]:\n ..."
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -85,6 +85,7 @@\n cfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -85,6 +85,7 @@\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n+ case_sensitive: bool = True,\n default: DefaultType,\n stream: Optional[TextIO] = None,\n ) -> Union[DefaultType, PromptType]:\n", "is_truncated": false} |
| 12 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " @classmethod\n @overload\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n case_sensitive: bool = True,\n stream: Optional[TextIO] = None,\n ) -> PromptType:\n ...",
"old_string": " @classmethod\n @overload\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n stream: Optional[TextIO] = None,\n ) -> PromptType:\n ..."
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -102,6 +102,7 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -102,6 +102,7 @@\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n+ case_sensitive: bool = True,\n stream: Optional[TextIO] = None,\n ) -> PromptType:\n ...\n", "is_truncated": false} |
| 13 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " @classmethod\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n case_sensitive: bool = True,\n default: Any = ...,\n stream: Optional[TextIO] = None,\n ) -> Any:\n \"\"\"Shortcut to construct and run a prompt loop and return the result.\n\n Example:\n >>> filename = Prompt.ask(\"Enter a filename\")\n\n Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.\n stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.\n \"\"\"\n _prompt = cls(\n prompt,\n console=console,\n password=password,\n choices=choices,\n show_default=show_default,\n show_choices=show_choices,\n case_sensitive=case_sensitive,\n )\n return _prompt(default=default, stream=stream)",
"old_string": " @classmethod\n def ask(\n cls,\n prompt: TextType = \"\",\n *,\n console: Optional[Console] = None,\n password: bool = False,\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n default: Any = ...,\n stream: Optional[TextIO] = None,\n ) -> Any:\n \"\"\"Shortcut to construct and run a prompt loop and return the result.\n\n Example:\n >>> filename = Prompt.ask(\"Enter a filename\")\n\n Args:\n prompt (TextType, optional): Prompt text. Defaults to \"\".\n console (Console, optional): A Console instance or None to use global console. Defaults to None.\n password (bool, optional): Enable password input. Defaults to False.\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.\n \"\"\"\n _prompt = cls(\n prompt,\n console=console,\n password=password,\n choices=choices,\n show_default=show_default,\n show_choices=show_choices,\n )\n return _prompt(default=default, stream=stream)"
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -117,6 +117,7 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -117,6 +117,7 @@\n choices: Optional[List[str]] = None,\n show_default: bool = True,\n show_choices: bool = True,\n+ case_sensitive: bool = True,\n default: Any = ...,\n stream: Optional[TextIO] = None,\n ) -> Any:\n@@ -132,6 +133,7 @@\n choices (List[str], optional): A list of valid choices. Defaults to None.\n show_default (bool, optional): Show default in prompt. Defaults to True.\n show_choices (bool, optional): Show choices in prompt. Defaults to True.\n+ case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.\n stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.\n \"\"\"\n _prompt = cls(\n@@ -141,6 +143,7 @@\n choices=choices,\n show_default=show_default,\n show_choices=show_choices,\n+ case_sensitive=case_sensitive,\n )\n return _prompt(default=default, stream=stream)\n \n", "is_truncated": false} |
| 14 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " def check_choice(self, value: str) -> bool:\n \"\"\"Check value is in the list of valid choices.\n\n Args:\n value (str): Value entered by user.\n\n Returns:\n bool: True if choice was valid, otherwise False.\n \"\"\"\n assert self.choices is not None\n if self.case_sensitive:\n return value.strip() in self.choices\n return value.strip().lower() in [choice.lower() for choice in self.choices]",
"old_string": " def check_choice(self, value: str) -> bool:\n \"\"\"Check value is in the list of valid choices.\n\n Args:\n value (str): Value entered by user.\n\n Returns:\n bool: True if choice was valid, otherwise False.\n \"\"\"\n assert self.choices is not None\n return value.strip() in self.choices"
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -219,7 +219,9 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -219,7 +219,9 @@\n bool: True if choice was valid, otherwise False.\n \"\"\"\n assert self.choices is not None\n- return value.strip() in self.choices\n+ if self.case_sensitive:\n+ return value.strip() in self.choices\n+ return value.strip().lower() in [choice.lower() for choice in self.choices]\n \n def process_response(self, value: str) -> PromptType:\n \"\"\"Process response from user, convert to prompt type.\n", "is_truncated": false} |
| 15 | write_file | {
"content": "from rich.prompt import Prompt\n\ndef test_case_sensitive_prompt():\n # This is a bit tricky to test because Prompt.ask reads from stdin.\n # We can mock the input by passing a stream.\n import io\n \n # Case sensitive (default)\n stream = io.StringIO(\"paul\\n\")\n # Prompt.ask will call __call__ which calls get_input which uses console.input\n # console.input uses the stream if provided.\n # However, Prompt.ask doesn't pass the stream to the Prompt instance's __call__ \n # in a way that it's used for the first input if we are not careful.\n # Let's check Prompt.ask implementation:\n # return _prompt(default=default, stream=stream)\n # And __call__:\n # value = self.get_input(self.console, prompt, self.password, stream=stream)\n \n # Test case sensitive - should fail for \"paul\" if choices are [\"Paul\"]\n stream = io.StringIO(\"paul\\nPaul\\n\")\n # We expect it to loop until \"Paul\" is entered.\n # But we can't easily test the loop without a real console or mocking.\n # Let's test check_choice directly.\n \n prompt = Prompt(\"Name\", choices=[\"Paul\", \"Jessica\"])\n prompt.case_sensitive = True\n assert prompt.check_choice(\"Paul\") is True\n assert prompt.check_choice(\"paul\") is False\n \n prompt.case_sensitive = False\n assert prompt.check_choice(\"Paul\") is True\n assert prompt.check_choice(\"paul\") is True\n assert prompt.check_choice(\"PAUL\") is True\n assert prompt.check_choice(\"Jessica\") is True\n assert prompt.check_choice(\"jessica\") is True\n\nif __name__ == \"__main__\":\n test_case_sensitive_prompt()\n print(\"Tests passed!\")\n",
"filepath": "test_prompt_case.py"
} | {"status": "ok", "filepath": "test_prompt_case.py", "size": 1607}full{"status": "ok", "filepath": "test_prompt_case.py", "size": 1607} |
| 16 | run_command | {
"command": "python test_prompt_case.py"
} | {"status": "ok", "stdout": "Tests passed!\n", "stderr": "", "exit_code": 0}full{"status": "ok", "stdout": "Tests passed!\n", "stderr": "", "exit_code": 0} |
| 17 | submit_patch | {} | {"status": "ok", "patch_size": 4763, "files_changed": 2}full{"status": "ok", "patch_size": 4763, "files_changed": 2} |
diff --git a/rich/prompt.py b/rich/prompt.py
index 064c959b..28078879 100644
--- a/rich/prompt.py
+++ b/rich/prompt.py
@@ -59,6 +59,7 @@ class PromptBase(Generic[PromptType]):
choices: Optional[List[str]] = None,
show_default: bool = True,
show_choices: bool = True,
+ case_sensitive: bool = True,
) -> None:
self.console = console or get_console()
self.prompt = (
@@ -71,6 +72,7 @@ class PromptBase(Generic[PromptType]):
self.choices = choices
self.show_default = show_default
self.show_choices = show_choices
+ self.case_sensitive = case_sensitive
@classmethod
@overload
@@ -83,6 +85,7 @@ class PromptBase(Generic[PromptType]):
choices: Optional[List[str]] = None,
show_default: bool = True,
show_choices: bool = True,
+ case_sensitive: bool = True,
default: DefaultType,
stream: Optional[TextIO] = None,
) -> Union[DefaultType, PromptType]:
@@ -99,6 +102,7 @@ class PromptBase(Generic[PromptType]):
choices: Optional[List[str]] = None,
show_default: bool = True,
show_choices: bool = True,
+ case_sensitive: bool = True,
stream: Optional[TextIO] = None,
) -> PromptType:
...
@@ -113,6 +117,7 @@ class PromptBase(Generic[PromptType]):
choices: Optional[List[str]] = None,
show_default: bool = True,
show_choices: bool = True,
+ case_sensitive: bool = True,
default: Any = ...,
stream: Optional[TextIO] = None,
) -> Any:
@@ -128,6 +133,7 @@ class PromptBase(Generic[PromptType]):
choices (List[str], optional): A list of valid choices. Defaults to None.
show_default (bool, optional): Show default in prompt. Defaults to True.
show_choices (bool, optional): Show choices in prompt. Defaults to True.
+ case_sensitive (bool, optional): Whether choices are case-sensitive. Defaults to True.
stream (TextIO, optional): Optional text file open for reading to get input. Defaults to None.
"""
_prompt = cls(
@@ -137,6 +143,7 @@ class PromptBase(Generic[PromptType]):
choices=choices,
show_default=show_default,
show_choices=show_choices,
+ case_sensitive=case_sensitive,
)
return _prompt(default=default, stream=stream)
@@ -212,7 +219,9 @@ class PromptBase(Generic[PromptType]):
bool: True if choice was valid, otherwise False.
"""
assert self.choices is not None
- return value.strip() in self.choices
+ if self.case_sensitive:
+ return value.strip() in self.choices
+ return value.strip().lower() in [choice.lower() for choice in self.choices]
def process_response(self, value: str) -> PromptType:
"""Process response from user, convert to prompt type.
diff --git a/test_prompt_case.py b/test_prompt_case.py
new file mode 100644
index 00000000..3c03c0ab
--- /dev/null
+++ b/test_prompt_case.py
@@ -0,0 +1,39 @@
+from rich.prompt import Prompt
+
+def test_case_sensitive_prompt():
+ # This is a bit tricky to test because Prompt.ask reads from stdin.
+ # We can mock the input by passing a stream.
+ import io
+
+ # Case sensitive (default)
+ stream = io.StringIO("paul\n")
+ # Prompt.ask will call __call__ which calls get_input which uses console.input
+ # console.input uses the stream if provided.
+ # However, Prompt.ask doesn't pass the stream to the Prompt instance's __call__
+ # in a way that it's used for the first input if we are not careful.
+ # Let's check Prompt.ask implementation:
+ # return _prompt(default=default, stream=stream)
+ # And __call__:
+ # value = self.get_input(self.console, prompt, self.password, stream=stream)
+
+ # Test case sensitive - should fail for "paul" if choices are ["Paul"]
+ stream = io.StringIO("paul\nPaul\n")
+ # We expect it to loop until "Paul" is entered.
+ # But we can't easily test the loop without a real console or mocking.
+ # Let's test check_choice directly.
+
+ prompt = Prompt("Name", choices=["Paul", "Jessica"])
+ prompt.case_sensitive = True
+ assert prompt.check_choice("Paul") is True
+ assert prompt.check_choice("paul") is False
+
+ prompt.case_sensitive = False
+ assert prompt.check_choice("Paul") is True
+ assert prompt.check_choice("paul") is True
+ assert prompt.check_choice("PAUL") is True
+ assert prompt.check_choice("Jessica") is True
+ assert prompt.check_choice("jessica") is True
+
+if __name__ == "__main__":
+ test_case_sensitive_prompt()
+ print("Tests passed!")
.F
=================================== FAILURES ===================================
_______________________ test_prompt_str_case_insensitive _______________________
def test_prompt_str_case_insensitive():
INPUT = "egg\nFoO"
console = Console(file=io.StringIO())
name = Prompt.ask(
"what is your name",
console=console,
choices=["foo", "bar"],
default="baz",
case_sensitive=False,
stream=io.StringIO(INPUT),
)
> assert name == "foo"
E AssertionError: assert 'FoO' == 'foo'
E
E - foo
E + FoO
tests/test_prompt.py:35: AssertionError
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
1 failed, 1 passed in 0.17s