← pod_r3_v1g

rich_3882

resolved RESOLVED PASS · 8 tool calls · 55 s · Textualize/rich

Task input

Fix raw markup printed on prompt errors sometimes

## Type of changes

- [x] Bug fix
- [ ] 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.
- [ ] I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate (see note about typos above).
- [x] I've added tests for new code.
- [x] I accept that @willmcgugan may be pedantic in the code review.

## Description

PromptBase.on_validate_error() should explicitly ask for markup in case the console passed to it has markup disabled globally.

Fixes #3881.

Tool calls (9)

#ToolArgumentsResult
1run_command
{
 "command": "grep -rn \"PromptBase.on_validate_error\" ."
}
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
full
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
2run_command
{
 "command": "grep -rn \"on_validate_error\" ."
}
{"status": "ok", "stdout": "./rich/prompt.py:258: def on_validate_error(self, value: str, error: InvalidResponse) -> None:\n./rich/prompt.py:298: self.on_valida
full
{"status": "ok", "stdout": "./rich/prompt.py:258:    def on_validate_error(self, value: str, error: InvalidResponse) -> None:\n./rich/prompt.py:298:                self.on_validate_error(value, error)\n", "stderr": "", "exit_code": 0}
3run_command
{
 "command": "sed -n '250,270p' rich/prompt.py"
}
{"status": "ok", "stdout": " # return the original choice, not the lower case version\n return_value = self.response_type(\n self.choices[\n [choice.lower() for
full
{"status": "ok", "stdout": "                # return the original choice, not the lower case version\n                return_value = self.response_type(\n                    self.choices[\n                        [choice.lower() for choice in self.choices].index(value.lower())\n                    ]\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): Exception instance the initiated the error.\n        \"\"\"\n        self.console.print(error)\n\n    def pre_prompt(self) -> None:\n        \"\"\"Hook to display something before the prompt.\"\"\"\n\n    @overload\n", "stderr": "", "exit_code": 0}
4run_command
{
 "command": "python3 - <<'PY'\nfrom rich.console import Console\nfrom rich.prompt import Prompt, InvalidResponse\n\nclass MyPrompt(Prompt):\n    def validate(self, value: str) -> str:\n        if value != \"yes\":\n            raise InvalidResponse(\"[red]Invalid response![/red]\")\n        return value\n\nconsole = Console(markup=False)\nprompt = MyPrompt(console=console)\n\n# We need to simulate the prompt loop. \n# Since Prompt.ask() blocks, we can't easily call it here.\n# But we can call on_validate_error directly to see what happens.\n# Or we can mock the input.\n\nimport unittest.mock as mock\nwith mock.patch('builtins.input', return_value=\"no\"):\n    try:\n        prompt.ask(\"Test prompt\")\n    except Exception:\n        pass\n\n# Let's see what happens when we call on_validate_error manually\n# to verify the current behavior.\n# We can capture the output of the console.\nfrom io import StringIO\nconsole.file = StringIO()\nprompt.on_validate_error(\"no\", InvalidResponse(\"[red]Error[/red]\"))\nprint(f\"Output: {console.file.getvalue()}\")\nPY\n"
}
{"status": "ok", "stdout": "Test prompt: Output: [red]Error[/red]\n\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "Test prompt: Output: [red]Error[/red]\n\n", "stderr": "", "exit_code": 0}
5run_command
{
 "command": "cd /workspace && python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"rich/prompt.py\")\ns = p.read_text()\nold = \"\"\"    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): Exception instance the initiated the error.\n        \\\"\\\"\\\"\n        self.console.print(error)\"\"\"\nnew = \"\"\"    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): Exception instance the initiated the error.\n        \\\"\\\"\\\"\n        self.console.print(error, markup=True)\"\"\"\nassert s.count(old) == 1, (\"old text found this many times:\", s.count(old))\nt = s.replace(old, new)\np.write_text(t)\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
6run_command
{
 "command": "python3 - <<'PY'\nfrom rich.console import Console\nfrom rich.prompt import Prompt, InvalidResponse\nfrom io import StringIO\n\nclass MyPrompt(Prompt):\n    def validate(self, value: str) -> str:\n        if value != \"yes\":\n            raise InvalidResponse(\"[red]Invalid response![/red]\")\n        return value\n\nconsole = Console(markup=False)\nconsole.file = StringIO()\nprompt = MyPrompt(console=console)\n\n# Test on_validate_error\nprompt.on_validate_error(\"no\", InvalidResponse(\"[red]Error[/red]\"))\nprint(f\"Output: {console.file.getvalue()}\")\nPY\n"
}
{"status": "ok", "stdout": "Output: Error\n\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "Output: Error\n\n", "stderr": "", "exit_code": 0}
7run_command
{
 "command": "git diff"
}
{"status": "ok", "stdout": "diff --git a/rich/prompt.py b/rich/prompt.py\nindex c7cf25ba..ae94d9bb 100644\n--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -262,7
full
{"status": "ok", "stdout": "diff --git a/rich/prompt.py b/rich/prompt.py\nindex c7cf25ba..ae94d9bb 100644\n--- a/rich/prompt.py\n+++ b/rich/prompt.py\n@@ -262,7 +262,7 @@ class PromptBase(Generic[PromptType]):\n             value (str): String entered by user.\n             error (InvalidResponse): Exception instance the initiated the error.\n         \"\"\"\n-        self.console.print(error)\n+        self.console.print(error, markup=True)\n \n     def pre_prompt(self) -> None:\n         \"\"\"Hook to display something before the prompt.\"\"\"\n", "stderr": "", "exit_code": 0}
8run_command
{
 "command": "python3 -m py_compile rich/prompt.py"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
9submit_patch
{}
{"status": "ok", "patch_size": 503, "files_changed": 1}
full
{"status": "ok", "patch_size": 503, "files_changed": 1}

Patch

diff --git a/rich/prompt.py b/rich/prompt.py
index c7cf25ba..ae94d9bb 100644
--- a/rich/prompt.py
+++ b/rich/prompt.py
@@ -262,7 +262,7 @@ class PromptBase(Generic[PromptType]):
             value (str): String entered by user.
             error (InvalidResponse): Exception instance the initiated the error.
         """
-        self.console.print(error)
+        self.console.print(error, markup=True)
 
     def pre_prompt(self) -> None:
         """Hook to display something before the prompt."""

Test output

show
........                                                                 [100%]
8 passed in 0.10s