[CHA-2964] gzip request and response

[mogita]

Summary

• Adds Accept-Encoding: gzip to the SDK's default httpx.Client and httpx.AsyncClient (sync + async parity).
• httpx auto-decodes Content-Encoding: gzip responses — no additional decode code needed.
• Escape hatch (user-supplied http_client) is untouched.

Spec

• Linear: https://linear.app/stream/issue/CHA-2964/gzip-request-and-response
• Notion spec: Server-Side SDK Gzip Spec §6.2 (stream-py)

Test plan

• New tests/test_gzip.py: 5 tests covering sync + async request header + sync + async response decode + escape-hatch regression guard. All pass locally.
• Smoke: full unit-only suite passes locally (264 passed / 5 skipped).
• CI green

Summary by CodeRabbit

Release Notes

• New Features
  • The SDK now automatically supports gzip compression for HTTP requests to improve performance when the server supports it.
  • Compressed responses are transparently decompressed automatically.
  • Custom HTTP client configurations provided by users are properly respected.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2c65ea98-7d7f-4aeb-aade-226f4fe2f9e7

📥 Commits

Reviewing files that changed from the base of the PR and between 765076f and 64e97b7.

📒 Files selected for processing (2)

• getstream/base.py
• tests/test_gzip.py

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Walkthrough

The PR adds automatic gzip support to the Stream SDK's HTTP clients. BaseClient and AsyncBaseClient now merge Accept-Encoding: gzip into their default headers when creating internal httpx clients. New test coverage verifies header injection, response decompression for both sync and async paths, and that user-provided clients retain their explicit encoding headers.

Changes

Gzip content encoding support

Layer / File(s)	Summary
Accept-Encoding header injection getstream/base.py	BaseClient and AsyncBaseClient.__init__ merge Accept-Encoding: gzip into the headers dict passed to the internal httpx.Client and httpx.AsyncClient, covering both transport-backed and non-transport-backed construction branches.
Gzip handling test suite tests/test_gzip.py	Helper functions (_capture_transport, _gzip_response_transport) mock transports. Tests verify default sync/async clients send Accept-Encoding: gzip, decode gzip-compressed responses transparently, and a regression guard ensures user-provided clients with explicit Accept-Encoding: identity are not overwritten.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 Gzip springs forth with headers set,
Responses shrink, no test is fret,
User choice is still their own,
The escape hatch, safe and known. 🎉

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/cha-2964-gzip-request-and-response

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}