← pod_r4_v1g

rich_3052

failed WRONG_FIX wrong_fix · 10 tool calls · 94 s · Textualize/rich

Task input

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 calls (11)

#ToolArgumentsResult
1run_command
{
 "command": "grep -rn \"Prompt.ask\" rich/prompt.py"
}
{"status": "ok", "stdout": "rich/prompt.py:122: >>> filename = Prompt.ask(\"Enter a filename\")\nrich/prompt.py:290: >>> name = Prompt.ask(\"Enter your name\")\
full
{"status": "ok", "stdout": "rich/prompt.py:122:            >>> filename = Prompt.ask(\"Enter a filename\")\nrich/prompt.py:290:        >>> name = Prompt.ask(\"Enter your name\")\nrich/prompt.py:302:        >>> burrito_count = IntPrompt.ask(\"How many burritos do you want to order\")\nrich/prompt.py:314:        >>> temperature = FloatPrompt.ask(\"Enter desired temperature\")\nrich/prompt.py:354:            result = IntPrompt.ask(\nrich/prompt.py:363:            password = Prompt.ask(\nrich/prompt.py:372:        fruit = Prompt.ask(\"Enter a fruit\", choices=[\"apple\", \"orange\", \"pear\"])\n", "stderr": "", "exit_code": 0}
2run_command
{
 "command": "sed -n '1,300p' rich/prompt.py"
}
{"status": "ok", "stdout": "from typing import Any, Generic, List, Optional, TextIO, TypeVar, Union, overload\n\nfrom . import get_console\nfrom .console import
full
{"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
3run_command
{
 "command": "sed -n '300,450p' rich/prompt.py"
}
{"status": "ok", "stdout": "\n Example:\n >>> burrito_count = IntPrompt.ask(\"How many burritos do you want to order\")\n\n \"\"\"\n\n response_type = int\n val
full
{"status": "ok", "stdout": "\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]\", default=5\n            )\n            if result >= 1 and result <= 10:\n                break\n            print(\":pile_of_poo: [prompt.invalid]Number must be between 1 and 10\")\n        print(f\"number={result}\")\n\n        while True:\n            password = Prompt.ask(\n                \"Please
4run_command
{
 "command": "sed -n '150,280p' rich/prompt.py"
}
{"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
5run_command
{
 "command": "python3 - <<'PY'\nfrom rich.prompt import Prompt\nfrom unittest.mock import MagicMock\n\ndef test_case_sensitive_choices():\n    # Mock console to avoid actual input\n    console = MagicMock()\n    console.input.return_value = \"paul\"\n    \n    # Case sensitive (default) - should fail for \"paul\" if choices are [\"Paul\"]\n    prompt = Prompt(\"Name\", choices=[\"Paul\"], console=console)\n    try:\n        # We simulate the loop by calling process_response directly\n        # since __call__ would loop forever on InvalidResponse\n        from rich.prompt import InvalidResponse\n        prompt.process_response(\"paul\")\n        print(\"Failed: Case sensitive should have raised InvalidResponse\")\n    except InvalidResponse:\n        print(\"Passed: Case sensitive raised InvalidResponse\")\n\n    # Case insensitive - should pass for \"paul\" if choices are [\"Paul\"]\n    # Note: case_sensitive is not yet implemented, so this will fail\n    try:\n        prompt_insensitive = Prompt(\"Name\", choices=[\"Paul\"], console=console, case_sensitive=False)\n        prompt_insensitive.process_response(\"paul\")\n        print(\"Passed: Case insensitive accepted 'paul'\")\n    except TypeError:\n        print(\"Failed: Prompt does not accept case_sensitive argument\")\n    except Exception as e:\n        print(f\"Failed: Unexpected exception {type(e).__name__}: {e}\")\n\ntest_case_sensitive_choices()\nPY\n"
}
{"status": "ok", "stdout": "Passed: Case sensitive raised InvalidResponse\nFailed: Prompt does not accept case_sensitive argument\n", "stderr": "", "exit_code":
full
{"status": "ok", "stdout": "Passed: Case sensitive raised InvalidResponse\nFailed: Prompt does not accept case_sensitive argument\n", "stderr": "", "exit_code": 0}
6run_command
{
 "command": "python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"rich/prompt.py\"); s = p.read_text()\n\n# Update PromptBase.__init__\nold_init = \"\"\"    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:\"\"\"\nnew_init = \"\"\"    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\n# Update PromptBase.__init__ body\nold_init_body = \"\"\"        self.show_default = show_default\n        self.show_choices = show_choices\"\"\"\nnew_init_body = \"\"\"        self.show_default = show_default\n        self.show_choices = show_choices\n        self.case_sensitive = case_sensitive\"\"\"\n\n# Update PromptBase.ask overloads\n# Overload 1\nold_overload1 = \"\"\"    @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]:\"\"\"\nnew_overload1 = \"\"\"    @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\n# Overload 2\nold_overload2 = \"\"\"    @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:\"\"\"\nnew_overload2 = \"\"\"    @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\n# Update PromptBase.ask implementation\nold_ask_sig = \"\"\"    @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:\"\"\"\nnew_ask_sig = \"\"\"    @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\nold_ask_body = \"\"\"        _prompt = cls(\n            prompt,\n            console=console,\n            password=password,\n            choices=choices,\n            show_default=sho
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
7run_command
{
 "command": "python3 - <<'PY'\nfrom rich.prompt import Prompt\nfrom unittest.mock import MagicMock\nfrom rich.prompt import InvalidResponse\n\ndef test_case_sensitive_choices():\n    # Mock console to avoid actual input\n    console = MagicMock()\n    console.input.return_value = \"paul\"\n    \n    # Case sensitive (default) - should fail for \"paul\" if choices are [\"Paul\"]\n    prompt = Prompt(\"Name\", choices=[\"Paul\"], console=console)\n    try:\n        prompt.process_response(\"paul\")\n        print(\"Failed: Case sensitive should have raised InvalidResponse\")\n    except InvalidResponse:\n        print(\"Passed: Case sensitive raised InvalidResponse\")\n\n    # Case insensitive - should pass for \"paul\" if choices are [\"Paul\"]\n    try:\n        prompt_insensitive = Prompt(\"Name\", choices=[\"Paul\"], console=console, case_sensitive=False)\n        prompt_insensitive.process_response(\"paul\")\n        print(\"Passed: Case insensitive accepted 'paul'\")\n    except Exception as e:\n        print(f\"Failed: Unexpected exception {type(e).__name__}: {e}\")\n\n    # Case insensitive - should also pass for \"PAUL\"\n    try:\n        prompt_insensitive = Prompt(\"Name\", choices=[\"Paul\"], console=console, case_sensitive=False)\n        prompt_insensitive.process_response(\"PAUL\")\n        print(\"Passed: Case insensitive accepted 'PAUL'\")\n    except Exception as e:\n        print(f\"Failed: Unexpected exception {type(e).__name__}: {e}\")\n\n    # Case sensitive - should pass for \"Paul\"\n    try:\n        prompt = Prompt(\"Name\", choices=[\"Paul\"], console=console)\n        prompt.process_response(\"Paul\")\n        print(\"Passed: Case sensitive accepted 'Paul'\")\n    except Exception as e:\n        print(f\"Failed: Unexpected exception {type(e).__name__}: {e}\")\n\ntest_case_sensitive_choices()\nPY\n"
}
{"status": "ok", "stdout": "Passed: Case sensitive raised InvalidResponse\nPassed: Case insensitive accepted 'paul'\nPassed: Case insensitive accepted 'PAUL'\nP
full
{"status": "ok", "stdout": "Passed: Case sensitive raised InvalidResponse\nPassed: Case insensitive accepted 'paul'\nPassed: Case insensitive accepted 'PAUL'\nPassed: Case sensitive accepted 'Paul'\n", "stderr": "", "exit_code": 0}
8run_command
{
 "command": "python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"rich/prompt.py\"); s = p.read_text()\n\n# Update PromptBase.ask docstring to include case_sensitive\nold_doc = \"\"\"            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.\"\"\"\nnew_doc = \"\"\"            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\ns = s.replace(old_doc, new_doc)\np.write_text(s)\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
9run_command
{
 "command": "git diff rich/prompt.py"
}
{"status": "ok", "stdout": "diff --git a/rich/prompt.py b/rich/prompt.py\nindex 064c959b..a1c54003 100644\n--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -59,6
full
{"status": "ok", "stdout": "diff --git a/rich/prompt.py b/rich/prompt.py\nindex 064c959b..a1c54003 100644\n--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -59,6 +59,7 @@ class PromptBase(Generic[PromptType]):\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 @@ class PromptBase(Generic[PromptType]):\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@@ -83,6 +85,7 @@ class PromptBase(Generic[PromptType]):\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@@ -99,6 +102,7 @@ class PromptBase(Generic[PromptType]):\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@@ -113,6 +117,7 @@ class PromptBase(Generic[PromptType]):\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@@ -128,6 +133,7 @@ class PromptBase(Generic[PromptType]):\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+     
10run_command
{
 "command": "submit_patch"
}
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: submit_patch: command not found\n", "details": {"stdout": "", "stderr": "/bin/bas
full
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: submit_patch: command not found\n", "details": {"stdout": "", "stderr": "/bin/bash: submit_patch: command not found\n", "exit_code": 127}}
11submit_patch
{}
{"status": "ok", "patch_size": 2843, "files_changed": 1}
full
{"status": "ok", "patch_size": 2843, "files_changed": 1}

Patch

diff --git a/rich/prompt.py b/rich/prompt.py
index 064c959b..a1c54003 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,6 +219,8 @@ class PromptBase(Generic[PromptType]):
             bool: True if choice was valid, otherwise False.
         """
         assert self.choices is not None
+        if not self.case_sensitive:
+            return value.strip().lower() in [c.lower() for c in self.choices]
         return value.strip() in self.choices
 
     def process_response(self, value: str) -> PromptType:

Test output

show
.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.11s