8000 gh-97725: Fix default file in `Task.print_stack` by megabug · Pull Request #97726 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-97725: Fix default file in Task.print_stack #97726

8000
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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

gh-97725: Fix default file in Task.print_stack #97726

wants to merge 2 commits into from

Conversation

megabug
Copy link
@megabug megabug commented Oct 2, 2022 •
edited by bedevere-bot
Loading

asyncio.Task.print_stack is described by documentation as having a default output file of sys.stderr. However, the default None is passed all the way to print statements, leading to an actual default of sys.stdout.

Fix by setting the file to sys.stderr when the default is used.

@megabug
Fix default file in Task.print_stack
3422473 
`Task.print_stack` is described by documentation as having a default output file of `sys.stderr`. However, instead the default `None` is passed all the way to `print` statements, leading to an actual default of `sys.stdout`.

Fix by setting the file to `sys.stderr` when the default is used.
@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@ghost
Copy link
ghost commented Oct 2, 2022 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

kumaraditya303
kumaraditya303 requested changes Oct 2, 2022
View reviewed changes
Copy link
Contributor
@kumaraditya303 kumaraditya303 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a regression test for this.

@kumaraditya303 kumaraditya303 added type-bug An unexpected behavior, bug, or error needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 2, 2022
@gvanrossum
Copy link
Member

But do we want to fix the code to match the docs? In cases like this, where the docs and the code have always disagreed (or for many releases), we tend to prefer to fix the docs to match the code, since "fixing" the code may actually break apps that were expecting the observed behavior.

Also, print_* kind of suggests that it does the same thing as print(). More indication to me that the docs were just wrong (it happens :-).

@arhadthedev arhadthedev mentioned this pull request Feb 7, 2023
Merged
@kumaraditya303
Copy link
Contributor

Superseded by #101652

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kumaraditya303 kumaraditya303 kumaraditya303 requested changes

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees
No one assigned
Labels
awaiting core review needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@megabug @bedevere-bot @gvanrossum @kumaraditya303
0