gh-90533: Implement BytesIO.peek() by marcelm · Pull Request #30808 · python/cpython

marcelm · 2022-01-22T22:08:24Z

bedevere-bot · 2022-08-05T22:44:49Z

Most changes to Python require a NEWS entry.

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

marcelm · 2022-11-09T13:16:15Z

@AlexWaygood You’ve been the only human to interact with this PR so far, do you possibly have any advice on how to move this forward?

AlexWaygood · 2022-11-09T13:36:44Z

Hi @marcelm — sorry for the delay in anybody looking at this. I haven't studied your PR in detail (or thought about whether the proposal is a good idea), but it looks well put together at first glance.

I'll try to take a look soon. I won't be able to review the C code, but I can comment on whether the proposal seems like a good idea, and I can review the Python implementation and the tests.

Note that if this proposal is accepted, it will also need:

Updates to the docs for BytesIO (Doc/library/io.rst)
An entry in "What's new in Python 3.12" (Doc/whatsnew/3.12.rst)

You can also add yourself to Misc/ACKS as part of this PR, and give yourself credit in the NEWS entry, if you like. (Neither is compulsory.)

marcelm · 2022-11-09T21:29:39Z

Thank you! I pushed a documentation update and will add an entry to the What’s new document in case the PR is reviewed favorably.

AlexWaygood · 2022-11-28T12:25:57Z

I'll defer to @benjaminp's judgement on this one -- I'm really not the right reviewer for this, unfortunately :(

Please ping me again if you still haven't had a review in a few weeks.

marcelm · 2022-11-28T12:43:35Z

Thank you! I appreciate that you took the time.

awalgarg · 2023-07-08T09:38:15Z

Please ping me again if you still haven't had a review in a few weeks.

@AlexWaygood Hi! Been 8 months, no review so far :) How can we take this forward? I'm not the original author of the PR but I also have a use-case for this API and would like to see this change land, happy to help progress this.

marcelm · 2023-07-08T13:14:48Z

Thanks for your interest! I have updated the PR to fix the merge conflict and to reflect that it now needs to target 3.13.

awalgarg · 2023-07-08T13:23:04Z

@marcelm That was quick, thank you so much!

AA-Turner · 2023-09-21T03:52:35Z

cc: @erlend-aasland @vstinner @benjaminp for the io C code.

A

vstinner · 2023-09-21T11:45:16Z

+ .. versionadded:: 3.13
+
+ Return bytes from the current position onwards but without advancing the
+ position. The number of bytes returned may be less or more than requested.


Wait. Why can it more than requested?
Apparently size=0 means "read all". Please document it.

This was just copied from the documentation for BufferedReader.peek(), but I agree that it could be written better. Changed now.
Wait. Why can it more than requested?
BufferedReader.peek() ignores the size argument and just returns whatever it has in its internal buffer.

I would prefer that BytesIO.peek() documents its behavior, rather than BufferedReader.peek() behavior.

Absolutely, it’s already changed.
(BTW, is there a policy on who clicks the "Resolve conversation" button?)

vstinner · 2023-09-21T11:47:32Z

+ pos = self.tell()
+ if size == 0:
+ size = -1
+ b = self.read(size)


Would it be possible to implement it without touching the position? This code is not thread safe. I don't know if it's supposed to be thread-safe. Maybe add a private read method which has an argument to decide to move the position or not.
Same remark for C code.

Good point; I implemented this now so that the position is not changed. I factored out a peek_bytes function in the C version that does not advance the position.
It seems though that neither the C nor the Python version of BytesIO are supposed to be thread safe. (They don’t use locks as e.g. BufferedReader does.) So I would suggest making them so would be a task for a different PR.

python-cla-bot · 2026-06-04T12:51:00Z

All commit authors signed the Contributor License Agreement.

vstinner · 2026-06-04T12:53:45Z

Commits 533
Files changed 1299

Oh oh. Something went wrong with this PR :-( I suggest to abandon this PR and create a new one.

marcelm · 2026-06-04T12:54:08Z

Sorry, I merged main manually; it seems this triggered a lot of stuff I did not intend to.

marcelm · 2026-06-04T12:59:30Z

I will open a new PR.

vstinner · 2026-06-04T13:05:40Z

The new PR: #150917.

serhiy-storchaka · 2026-06-04T13:37:26Z

@marcelm, probably you forgot to pull changes from upstream to your main branch or to your feature branch.

the-knights-who-say-ni added the CLA not signed label Jan 22, 2022

This comment was marked as outdated.
Sign in to view

bedevere-bot added the awaiting review label Jan 22, 2022

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Feb 1, 2022

marcelm force-pushed the fix-issue-46375 branch from 3111318 to 675718dCompare April 11, 2022 20:06

marcelm changed the title ~~bpo-46375: Implement BytesIO.peek()~~gh-90533: Implement BytesIO.peek()Apr 11, 2022

This comment was marked as outdated.
Sign in to view

AlexWaygood added the topic-IO label Apr 14, 2022

ezio-melotti removed the CLA signed label Jul 13, 2022

marcelm force-pushed the fix-issue-46375 branch from 675718d to d4e849fCompare August 5, 2022 22:44

marcelm force-pushed the fix-issue-46375 branch from ef5eb69 to b82fa85Compare August 5, 2022 23:28

marcelm force-pushed the fix-issue-46375 branch 2 times, most recently from 6998be1 to be39ff2Compare November 6, 2022 15:11

AlexWaygood added the type-feature A feature request or enhancement label Nov 9, 2022

AlexWaygood self-requested a review November 9, 2022 13:37

kumaraditya303 requested a review from benjaminp November 27, 2022 07:18

AlexWaygood removed their request for review November 28, 2022 12:26

marcelm force-pushed the fix-issue-46375 branch from 5cb3143 to 79d5032Compare September 19, 2023 08:04

vstinner reviewed Sep 21, 2023
View reviewed changes

Do not cap at DEFAULT_BUFFER_SIZE
32fd791

marcelm mentioned this pull request Jun 4, 2026
gh-90533: Implement BytesIO.peek() #150917
Merged

Uh oh!

Uh oh!

Conversation

marcelm commented Jan 22, 2022• edited by AlexWaygood Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

bedevere-bot commented Aug 5, 2022

Uh oh!

marcelm commented Nov 9, 2022

Uh oh!

AlexWaygood commented Nov 9, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcelm commented Nov 9, 2022

Uh oh!

AlexWaygood commented Nov 28, 2022

Uh oh!

marcelm commented Nov 28, 2022

Uh oh!

awalgarg commented Jul 8, 2023

Uh oh!

marcelm commented Jul 8, 2023

Uh oh!

awalgarg commented Jul 8, 2023

Uh oh!

AA-Turner commented Sep 21, 2023

Uh oh!

vstinnerSep 21, 2023

Choose a reason for hiding this comment

Uh oh!

marcelmSep 22, 2023

Choose a reason for hiding this comment

Uh oh!

vstinnerSep 28, 2023

Choose a reason for hiding this comment

Uh oh!

marcelmSep 28, 2023

Choose a reason for hiding this comment

Uh oh!

vstinnerSep 21, 2023

Choose a reason for hiding this comment

Uh oh!

marcelmSep 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

python-cla-botBot commented Jun 4, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vstinner commented Jun 4, 2026

Uh oh!

marcelm commented Jun 4, 2026

Uh oh!

marcelm commented Jun 4, 2026

Uh oh!

vstinner commented Jun 4, 2026

Uh oh!

serhiy-storchaka commented Jun 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

marcelm commented Jan 22, 2022•
edited by AlexWaygood
Loading

AlexWaygood commented Nov 9, 2022•
edited
Loading

python-cla-botBot commented Jun 4, 2026•
edited
Loading