GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix nonexistent `iter_content()` reference in `stream()` docstring by cognis-digital · Pull Request #1096 · encode/httpcore

Conversation

@cognis-digital

@cognis-digital cognis-digital commented Jul 25, 2026

Copy link
Copy Markdown

The docstring for the public httpcore.stream() function tells users how to
read a streamed response body:

If you want to access the response body you should either use
content = response.read(), or for chunk in response.iter_content().

But Response has no iter_content() method — the streaming iterator is
iter_stream() (and aiter_stream() for async). Running the documented
for chunk in response.iter_content() raises AttributeError.

The rest of the project already uses the correct name (docs/quickstart.md
documents for chunk in response.iter_stream():, and the tests use
response.iter_stream()). This one docstring drifted because doctests are
not run in CI.

This corrects the docstring to iter_stream() and adds a small regression
test pinning the documented streaming method names, so the documented API
can't silently drift to a nonexistent method again.

No library behaviour changes — docs-only correctness plus a guard test.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Cognis Digital
Fix nonexistent iter_content() reference in httpcore.stream() docstring
0890100
The docstring for httpcore.stream() tells users to read a streamed body
with "for chunk in response.iter_content()", but Response has no
iter_content() method -- the streaming method is iter_stream(). Running
the documented snippet raises AttributeError. Correct it to iter_stream()
and add a regression test pinning the documented streaming method names,
since doctests are not run in CI.
@coderabbitai coderabbitai Bot mentioned this pull request Jul 31, 2026
feat(execution): add public platform batch izumi0uu/Agent-Reach#3
Merged
fallenmi
fallenmi approved these changes Aug 26, 2026
View reviewed changes

@fallenmi fallenmi left a comment

Copy link
Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Reviewed with Codex.

I checked this on exact head 08901009255b95b7500f2a19f6695f9983e581ae. The exact base/current master (10a658221deb38a4c5b16db55ab554b0bf731707) directs users to Response.iter_content(), which is not implemented, while Response.iter_stream() is the actual synchronous streaming API. On the head, the docstring and public API now agree.

Validation:

  • repeated base/head doc-to-API oracle 100x (base mismatch, head match)
  • pytest -q tests/test_models.py::test_response_streaming_api_names -> 1 passed
  • focused Ruff format/check and mypy -> clean
  • git diff --check -> clean
  • live matrix: 7/7 successful

No blocking issues found.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

This branch has not been deployed

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

Reviewers

1 more reviewer
@fallenmi fallenmi fallenmi approved these changes
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@cognis-digital @fallenmi
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.