prompt-toolkit / prompt-toolkit/python-prompt-toolkit

`patch_stdout` regression since 2.0.10

Open
#1,103 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug patch-stdout
Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

Python: 3.7
Versions: 3.0.0 to 3.0.4
Platform: Windows

Previously on 2.0.10, anything print'd to stdout used to show up in the application in a "log-style" thanks to patch_stdout, but now output is completely suppressed.

I modified the apt-get example to demonstrate this — it should show "Hello world!" every 100 iterations. It works on 2.0.10:

#!/usr/bin/env python
"""
Styled just like an apt-get installation.
"""
import time

from prompt_toolkit.patch_stdout import patch_stdout
from prompt_toolkit.shortcuts import ProgressBar
from prompt_toolkit.shortcuts.progress_bar import formatters
from prompt_toolkit.styles import Style

style = Style.from_dict(
    {
        "label": "bg:#ffff00 #000000",
        "percentage": "bg:#ffff00 #000000",
        "current": "#448844",
        "bar": "",
    }
)


def main():
    custom_formatters = [
        formatters.Label(),
        formatters.Text(": [", style="class:percentage"),
        formatters.Percentage(),
        formatters.Text("]", style="class:percentage"),
        formatters.Text(" "),
        formatters.Bar(sym_a="#", sym_b="#", sym_c="."),
        formatters.Text("  "),
    ]

    with ProgressBar(style=style, formatters=custom_formatters) as pb:
        for i in pb(range(1600), label="Installing"):
            if (i + 1) % 100 == 0:
                print("Hello world!")
            time.sleep(0.001)


if __name__ == "__main__":
    with patch_stdout():
        main()

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the modified apt-get example on Windows with Python 3.7 and prompt-toolkit 3.0.0–3.0.4, then compare its behavior with 2.0.10. Trace the output handling in patch_stdout while the ProgressBar is active. Done means printed “Hello world!” lines appear in the application every 100 iterations rather than being suppressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.