failed WRONG_FIX wrong_fix · 11 tool calls · 170 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", "exit_code": 0} |
| 2 | read_file | {
"filepath": "rich/prompt.py",
"start_line": 286
} | {"status": "ok", "filepath": "rich/prompt.py", "content": "class Prompt(PromptBase[str]):\n \"\"\"A prompt that returns a str.\n\n Example:\n >>> name = Prompt.full{"status": "ok", "filepath": "rich/prompt.py", "content": "class Prompt(PromptBase[str]):\n \"\"\"A prompt that returns a str.\n\n Example:\n >>> name = Prompt.ask(\"Enter your name\")\n\n\n \"\"\"\n\n response_type = str\n\n\nclass IntPrompt(PromptBase[int]):\n \"\"\"A prompt that returns an integer.\n\n Example:\n >>> burrito_count = IntPrompt.ask(\"How many burritos do you want to order\")\n\n \"\"\"\n\n response_type = int\n validate_error_message = \"[prompt.invalid]Please enter a valid integer number\"\n\n\nclass FloatPrompt(PromptBase[int]):\n \"\"\"A prompt that returns a float.\n\n Example:\n >>> temperature = FloatPrompt.ask(\"Enter desired temperature\")\n\n \"\"\"\n\n response_type = float\n validate_error_message = \"[prompt.invalid]Please enter a number\"\n\n\nclass Confirm(PromptBase[bool]):\n \"\"\"A yes / no confirmation prompt.\n\n Example:\n >>> if Confirm.ask(\"Continue\"):\n run_job()\n\n \"\"\"\n\n response_type = bool\n validate_error_message = \"[prompt.invalid]Please enter Y or N\"\n choices: List[str] = [\"y\", \"n\"]\n\n def render_default(self, default: DefaultType) -> Text:\n \"\"\"Render the default as (y) or (n) rather than True/False.\"\"\"\n yes, no = self.choices\n return Text(f\"({yes})\" if default else f\"({no})\", style=\"prompt.default\")\n\n def process_response(self, value: str) -> bool:\n \"\"\"Convert choices to a bool.\"\"\"\n value = value.strip().lower()\n if value not in self.choices:\n raise InvalidResponse(self.validate_error_message)\n return value == self.choices[0]\n\n\nif __name__ == \"__main__\": # pragma: no cover\n\n from rich import print\n\n if Confirm.ask(\"Run [i]prompt[/i] tests?\", default=True):\n while True:\n result = IntPrompt.ask(\n \":rocket: Enter a number between [b]1[/b] and [b]10[/b]\", def |
| 3 | read_file | {
"filepath": "rich/prompt.py",
"start_line": 30
} | {"status": "ok", "filepath": "rich/prompt.py", "content": "class PromptBase(Generic[PromptType]):\n \"\"\"Ask the user for input until a valid response is receifull{"status": "ok", "filepath": "rich/prompt.py", "content": "class 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: Optional[List[str]] = None,\n 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\n\n @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 |
| 4 | read_file | {
"filepath": "rich/prompt.py",
"start_line": 180
} | {"status": "ok", "filepath": "rich/prompt.py", "content": "\n prompt.append(self.prompt_suffix)\n\n return prompt\n\n @classmethod\n def get_input(\n cls,\n confull{"status": "ok", "filepath": "rich/prompt.py", "content": "\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) -> PromptType:\n \"\"\"Process response from user, convert to prompt type.\n\n Args:\n value (str): String typed by user.\n\n Raises:\n InvalidResponse: If ``value`` is invalid.\n\n Returns:\n PromptType: The value to be returned from ask method.\n \"\"\"\n value = value.strip()\n try:\n return_value: PromptType = self.response_type(value)\n except ValueError:\n raise InvalidResponse(self.validate_error_message)\n\n if self.choices is not None and not self.check_choice(value):\n raise InvalidResponse(self.illegal_choice_message)\n\n return return_value\n\n def on_validate_error(self, value: str, error: InvalidResponse) -> None:\n \"\"\"Called to handle validation error.\n\n Args:\n value (str): String entered by user.\n error (InvalidResponse): |
| 5 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " 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.",
"old_string": " 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."
} | {"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -38,6 +38,7 @@\n cfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -38,6 +38,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 \"\"\"\n \n response_type: type = str\n", "is_truncated": false} |
| 6 | edit_file | {
"filepath": "rich/prompt.py",
"new_string": " def __init__(\n self,\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 ) -> 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": " def __init__(\n self,\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 ) -> 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@@ -60,6 +60,7 @@\n cfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -60,6 +60,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@@ -72,6 +73,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} |
| 7 | 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@@ -86,6 +86,7 @@\n cfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -86,6 +86,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} |
| 8 | 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@@ -103,6 +103,7 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -103,6 +103,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} |
| 9 | 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@@ -118,6 +118,7 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -118,6 +118,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@@ -133,6 +134,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@@ -142,6 +144,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} |
| 10 | 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@@ -220,7 +220,9 @@\nfull{"status": "ok", "filepath": "rich/prompt.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -220,7 +220,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} |
| 11 | run_command | {
"command": "python3 -c \"from rich.prompt import Prompt; p = Prompt('test', choices=['Paul', 'Jessica']); print(p.check_choice('paul') if not p.case_sensitive else p.check_choice('paul')); p.case_sensitive = False; print(p.check_choice('paul'))\""
} | {"status": "ok", "stdout": "False\nTrue\n", "exit_code": 0}full{"status": "ok", "stdout": "False\nTrue\n", "exit_code": 0} |
| 12 | submit_patch | [] | {"status": "ok", "patch_size": 3401, "files_changed": 1}full{"status": "ok", "patch_size": 3401, "files_changed": 1} |
diff --git a/rich/prompt.py b/rich/prompt.py
index 064c959b..ef524e1b 100644
--- a/rich/prompt.py
+++ b/rich/prompt.py
@@ -38,6 +38,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.
"""
response_type: type = str
@@ -59,6 +60,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 +73,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 +86,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 +103,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 +118,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 +134,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 +144,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 +220,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.
.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