resolved RESOLVED PASS · 5 tool calls · 40 s · Textualize/rich
Update progress.py Don't output extraneous blank line when progress display is disabled <!-- Please note that Rich isn't accepting any new features at this point. If a feature can be implemented without modifying the core library, then they should be released as a third-party module. I can accept updates to the core library that make it easier to extend (think hooks). Bugfixes are always welcome of course. Sometimes it is not clear what is a feature and what is a bug fix. If there is any doubt, please open a discussion first. --> <!-- *Are you contributing typo fixes?* If your PR solely consists of typos, at least one must be in the docs to warrant an addition to CONTRIBUTORS.md --> ## Type of changes - [x] Bug fix - [ ] New feature - [ ] Documentation / docstrings - [ ] Tests - [ ] Other ## AI? - [ ] AI was used to generate this PR AI generated PRs may be accepted, but only if @willmcgugan has responded on an issue or discussion. ## 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 (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 When creating a `Progress` with `disabled=True`, it still outputs a blank line on non interactive consoles. This PR adds an `if not self.disable` to the `stop` function, symmetrically to the `start` function. **Important:** Link to an issue or discussion regarding these changes. https://github.com/Textualize/rich/issues/110
| # | Tool | Arguments | Result |
|---|---|---|---|
| 1 | run_command | {
"command": "grep -rn \"class Progress\" rich/progress.py"
} | {"status": "ok", "stdout": "rich/progress.py:507:class ProgressColumn(ABC):\nrich/progress.py:926:class ProgressSample(NamedTuple):\nrich/progress.py:1061:classfull{"status": "ok", "stdout": "rich/progress.py:507:class ProgressColumn(ABC):\nrich/progress.py:926:class ProgressSample(NamedTuple):\nrich/progress.py:1061:class Progress(JupyterMixin):\n", "stderr": "", "exit_code": 0} |
| 2 | run_command | {
"command": "sed -n '1061,1250p' rich/progress.py"
} | {"status": "ok", "stdout": "class Progress(JupyterMixin):\n \"\"\"Renders an auto-updating progress bar(s).\n\n Args:\n console (Console, optional): Optional Cofull{"status": "ok", "stdout": "class Progress(JupyterMixin):\n \"\"\"Renders an auto-updating progress bar(s).\n\n Args:\n console (Console, optional): Optional Console instance. Defaults to an internal Console instance writing to stdout.\n auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()`.\n refresh_per_second (float, optional): Number of times per second to refresh the progress information. Defaults to 10.\n speed_estimate_period: (float, optional): Period (in seconds) used to calculate the speed estimate. Defaults to 30.\n transient: (bool, optional): Clear the progress on exit. Defaults to False.\n redirect_stdout: (bool, optional): Enable redirection of stdout, so ``print`` may be used. Defaults to True.\n redirect_stderr: (bool, optional): Enable redirection of stderr. Defaults to True.\n get_time: (Callable, optional): A callable that gets the current time, or None to use Console.get_time. Defaults to None.\n disable (bool, optional): Disable progress display. Defaults to False\n expand (bool, optional): Expand tasks table to fit width. Defaults to False.\n \"\"\"\n\n def __init__(\n self,\n *columns: Union[str, ProgressColumn],\n console: Optional[Console] = None,\n auto_refresh: bool = True,\n refresh_per_second: float = 10,\n speed_estimate_period: float = 30.0,\n transient: bool = False,\n redirect_stdout: bool = True,\n redirect_stderr: bool = True,\n get_time: Optional[GetTimeCallable] = None,\n disable: bool = False,\n expand: bool = False,\n ) -> None:\n assert refresh_per_second > 0, \"refresh_per_second must be > 0\"\n self._lock = RLock()\n self.columns = columns or self.get_default_columns()\n self.speed_estimate_period = speed_estimate_period\n\n self.disable = disable\n self.expand = expand\n |
| 3 | run_command | {
"command": "python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"rich/progress.py\"); s = p.read_text()\nold = \"\"\" def stop(self) -> None:\n \\\"\\\"\\\"Stop the progress display.\\\"\\\"\\\"\n self.live.stop()\n if not self.console.is_interactive and not self.console.is_jupyter:\n self.console.print()\"\"\"\nnew = \"\"\" def stop(self) -> None:\n \\\"\\\"\\\"Stop the progress display.\\\"\\\"\\\"\n if not self.disable:\n self.live.stop()\n if not self.console.is_interactive and not self.console.is_jupyter:\n self.console.print()\"\"\"\nassert s.count(old) == 1, (\"old text found this many times:\", s.count(old))\nt = s.replace(old, new); compile(t, str(p), \"exec\"); p.write_text(t)\nPY\n"
} | {"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}full{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0} |
| 4 | run_command | {
"command": "git diff rich/progress.py"
} | {"status": "ok", "stdout": "diff --git a/rich/progress.py b/rich/progress.py\nindex 421e1411..f55b981e 100644\n--- a/rich/progress.py\n+++ b/rich/progress.py\n@full{"status": "ok", "stdout": "diff --git a/rich/progress.py b/rich/progress.py\nindex 421e1411..f55b981e 100644\n--- a/rich/progress.py\n+++ b/rich/progress.py\n@@ -1172,9 +1172,10 @@ class Progress(JupyterMixin):\n \n def stop(self) -> None:\n \"\"\"Stop the progress display.\"\"\"\n- self.live.stop()\n- if not self.console.is_interactive and not self.console.is_jupyter:\n- self.console.print()\n+ if not self.disable:\n+ self.live.stop()\n+ if not self.console.is_interactive and not self.console.is_jupyter:\n+ self.console.print()\n \n def __enter__(self) -> Self:\n self.start()\n", "stderr": "", "exit_code": 0} |
| 5 | run_command | {
"command": "python3 - <<'PY'\nfrom rich.console import Console\nfrom rich.progress import Progress\nimport io\n\ndef test_disabled_progress_no_blank_line():\n # Use a non-interactive console (simulated by writing to a file-like object)\n console = Console(file=io.StringIO(), force_terminal=False)\n \n with Progress(console=console, disable=True) as progress:\n # progress.add_task(...)\n pass\n \n output = console.file.getvalue()\n # If it's disabled, it should not print anything, including the blank line\n assert output == \"\", f\"Expected empty output for disabled progress, got {repr(output)}\"\n\ndef test_enabled_progress_prints_blank_line_on_non_interactive():\n # Non-interactive console, enabled progress\n console = Console(file=io.StringIO(), force_terminal=False)\n \n with Progress(console=console, disable=False) as progress:\n pass\n \n output = console.file.getvalue()\n # It should print a blank line in this case\n assert output == \"\\n\", f\"Expected blank line for enabled progress on non-interactive console, got {repr(output)}\"\n\nif __name__ == \"__main__\":\n try:\n test_disabled_progress_no_blank_line()\n test_enabled_progress_prints_blank_line_on_non_interactive()\n print(\"Tests passed!\")\n except AssertionError as e:\n print(f\"Test failed: {e}\")\n exit(1)\nPY\n"
} | {"status": "ok", "stdout": "Tests passed!\n", "stderr": "", "exit_code": 0}full{"status": "ok", "stdout": "Tests passed!\n", "stderr": "", "exit_code": 0} |
| 6 | submit_patch | {} | {"status": "ok", "patch_size": 627, "files_changed": 1}full{"status": "ok", "patch_size": 627, "files_changed": 1} |
diff --git a/rich/progress.py b/rich/progress.py
index 421e1411..f55b981e 100644
--- a/rich/progress.py
+++ b/rich/progress.py
@@ -1172,9 +1172,10 @@ class Progress(JupyterMixin):
def stop(self) -> None:
"""Stop the progress display."""
- self.live.stop()
- if not self.console.is_interactive and not self.console.is_jupyter:
- self.console.print()
+ if not self.disable:
+ self.live.stop()
+ if not self.console.is_interactive and not self.console.is_jupyter:
+ self.console.print()
def __enter__(self) -> Self:
self.start()
....................................... [100%] 39 passed in 0.47s