Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

echo_via_pager with generators leaves terminal in broken state #2674

Open
0xDEC0DE opened this issue Feb 12, 2024 · 1 comment
Open

echo_via_pager with generators leaves terminal in broken state #2674

0xDEC0DE opened this issue Feb 12, 2024 · 1 comment

Comments

@0xDEC0DE
Copy link
Contributor

0xDEC0DE commented Feb 12, 2024

Steps to reproduce

Run the following test case:

import click

def output_generator():
    counter = 0
    while True:
        yield "this is a line of output\n"
        if counter == 1024:
            click.echo("kaboom", err=True)
            click.get_current_context().exit(0)
        counter += 1

@click.command
def kaboom():
    click.echo_via_pager(output_generator)

if __name__ == "__main__":
    kaboom()

Attempt to use the terminal afterwards

Expected result

A working terminal.

Actual behavior

Newlines and output are obscured. Commands may be entered, but they are not displayed.

Workaround

Run the reset command after the command terminates.

Environment:

Reproducible on OS X and Ubuntu (x86_64):

$ sw_vers
ProductName:            macOS
ProductVersion:         14.3.1
BuildVersion:           23D60
  • Python version: 3.11.2
  • Click version: 8.1.7
# cat /etc/lsb-release
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=22.04
DISTRIB_CODENAME=jammy
DISTRIB_DESCRIPTION="Ubuntu 22.04.3 LTS"
  • Python version: 3.10.12
  • Click version: 8.1.7
@0xDEC0DE
Copy link
Contributor Author

Addendum

If the generator exits "normally", the terminal works fine. It's only when doing things like error handling that it goes sideways.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant