-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Comments
AddendumIf the generator exits "normally", the terminal works fine. It's only when doing things like error handling that it goes sideways. |
Successfully reproduced this problem using bash, but failed to reproduce using zsh in my case (also macos) |
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running a program like ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running a program like ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
4 tasks
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running a program like ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running a program like ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running the program to reproduce the issue (thanks to @0xDEC0DE for providing it in the issue mentioned above!) ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
stefreak
added a commit
to stefreak/click
that referenced
this issue
Sep 7, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running the program to reproduce the issue (thanks to @0xDEC0DE for providing it in the issue mentioned above!) ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
AndreasBackx
pushed a commit
to stefreak/click
that referenced
this issue
Nov 9, 2024
…cho in the generator This commit fixes pallets#2674 (echo_via_pager with generators leaves terminal in broken state). When running the program to reproduce the issue (thanks to @0xDEC0DE for providing it in the issue mentioned above!) ``` 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() ``` The "kaboom" message will now be visible immediately (the error will cause click to terminate the pager). ZSH and bash will not be in a broken state (tested using bash and zsh on macos). Further changes: - Error handling: terminate the pager and close the file descriptors in a finally block - KeyboardInterrupt: the pager code will not ignore KeyboardInterrupt anymore. This allows the user to search for future output of the generator when using less and then aborting the program using ctrl-c. - tests: improved the echo_via_pager tests by using a named tuple and separate assertions for pager output, stderr and stdout. Added additional test cases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Steps to reproduce
Run the following test case:
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):
The text was updated successfully, but these errors were encountered: