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

Jump to bottom

bpo-21910: Clarified codecs writelines method #31245

Merged
merged 5 commits into from Mar 3, 2022
Merged

bpo-21910: Clarified codecs writelines method #31245

merged 5 commits into from Mar 3, 2022

Conversation

slateny
Copy link
Contributor

@slateny slateny commented Feb 10, 2022 •
edited by bedevere-bot

See issue. writelines uses .join() instead of some streaming implementation so for infinite / very large generators the method will freeze. Updated documentation so it reflects this behavior

https://bugs.python.org/issue21910

@the-knights-who-say-ni
Copy link

the-knights-who-say-ni commented Feb 10, 2022

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@slateny

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Feb 10, 2022
JelleZijlstra
JelleZijlstra reviewed Feb 13, 2022
View changes
Doc/library/codecs.rst Outdated Show resolved Hide resolved
JelleZijlstra
JelleZijlstra reviewed Feb 17, 2022
View changes
Doc/library/codecs.rst Outdated Show resolved Hide resolved
@slateny
Copy link
Contributor Author

slateny commented Feb 25, 2022

@JelleZijlstra Could you take another peek and let me know if it looks good to you?

@JelleZijlstra JelleZijlstra self-requested a review Feb 25, 2022
JelleZijlstra
JelleZijlstra reviewed Feb 25, 2022
View changes
Doc/library/codecs.rst Outdated Show resolved Hide resolved
@JelleZijlstra JelleZijlstra self-assigned this Feb 25, 2022
@slateny @JelleZijlstra
Update Doc/library/codecs.rst
c6dd629 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@JelleZijlstra
Copy link
Member

JelleZijlstra commented Mar 2, 2022

@gvanrossum planning to merge this docs change.

@JelleZijlstra JelleZijlstra merged commit a8c87a2 into python:main Mar 3, 2022
12 checks passed
@miss-islington
Copy link
Contributor

miss-islington commented Mar 3, 2022

Thanks @slateny for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 3, 2022
@slateny @miss-islington
bpo-21910: Clarify docs for codecs writelines method (pythonGH-31245)
cf91dac 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a2)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Mar 3, 2022

GH-31647 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 3, 2022
@slateny @miss-islington
bpo-21910: Clarify docs for codecs writelines method (pythonGH-31245)
827b286 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a2)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Mar 3, 2022

GH-31648 is a backport of this pull request to the 3.9 branch.

miss-islington added a commit that referenced this pull request Mar 3, 2022
@miss-islington @slateny
bpo-21910: Clarify docs for codecs writelines method (GH-31245)
60b561c 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a2)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Mar 3, 2022
@miss-islington @slateny
bpo-21910: Clarify docs for codecs writelines method (GH-31245)
cf8aff6 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a2)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
@slateny slateny deleted the s/codecs branch Mar 3, 2022
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington @slateny @hello-adam
bpo-21910: Clarify docs for codecs writelines method (pythonGH-31245)
301d078 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a8c87a2)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akulakov akulakov

@JelleZijlstra JelleZijlstra

Assignees

@JelleZijlstra JelleZijlstra

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@slateny @the-knights-who-say-ni @JelleZijlstra @miss-islington @bedevere-bot @akulakov @AlexWaygood