Skip to content

docs: Added Cookie section#580

Merged
0x676e67 merged 16 commits into
0x676e67:mainfrom
mrcsnv:main
Apr 28, 2026
Merged

docs: Added Cookie section#580
0x676e67 merged 16 commits into
0x676e67:mainfrom
mrcsnv:main

Conversation

@mrcsnv
Copy link
Copy Markdown
Contributor

@mrcsnv mrcsnv commented Apr 28, 2026

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Cookies guide explaining how to create and inspect cookies, read server-set cookies, and send cookies with requests (mapping or raw string).
    • Documents persistent cookie handling with a cookie jar: enabling client-managed storage or supplying an explicit jar, plus operations for adding, retrieving (name+URL exact match), listing, updating, removing, and clearing cookies. Includes protocol-specific header notes and links to examples and API reference.

mrcsnv and others added 15 commits April 14, 2026 15:07
Expanded the proxy usage documentation to include authentication, per-request proxies with custom headers, and clarified Unix socket proxy usage.
Updated the proxy usage example to reflect the new Client initialization with a list of proxies.
Fix formatting of bullet points in quickstart.md
More context added. And anchoring to API references for easy navigation between classes and models. To learn how to use it better
Updated examples for GET and POST requests, including form data and headers. Improved clarity and consistency in code snippets.
Updated response headers section to reference HeaderMap object and changed example to use .get() method.
This document explains how to handle HTTP cookies in wreq, including creating cookies, reading cookies from responses, sending cookies with requests, and managing a persistent cookie store.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a96469e4-6d25-4a0c-833e-8fcc8eeb6479

📥 Commits

Reviewing files that changed from the base of the PR and between 19874a1 and 345fa21.

📒 Files selected for processing (1)
  • docs/source/guide/cookie.md
✅ Files skipped from review due to trivial changes (1)
  • docs/source/guide/cookie.md

📝 Walkthrough

Walkthrough

A new "Cookies" guide page was added explaining Cookie object creation/inspection, reading server-set cookies via response.cookies, sending request-level cookies, and persistent cookie storage/management using Jar and Client, plus protocol-specific header formatting for HTTP/1.1 vs HTTP/2+.

Changes

Cohort / File(s) Summary
Cookie Guide Documentation
docs/source/guide/cookie.md
Added a comprehensive guide covering Cookie construction and inspection, reading response.cookies, request-level cookies (cookies param as mapping or raw string), persistent storage via Jar and Client(cookie_store=True) or cookie_provider, client.cookie_jar access, cookie management operations (add from Cookie or Set-Cookie, retrieve by name+URL with exact domain match, list, overwrite, remove, clear), and HTTP/1.1 vs HTTP/2+ header formatting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I nibble notes of crunchy text,

Cookies stored and cookies next,
From response jars to request delight,
I hop along through headers bright,
🍪 Hooray — the guide makes cookie-sense tonight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change—adding a Cookie section to documentation with clear, specific language.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/source/guide/cookie.md`:
- Around line 81-90: The example async snippet is not runnable as-is because it
omits imports and the call to run the coroutine; add top-level imports (import
asyncio and from wreq import Client) before the async def main() and invoke the
coroutine at the end with asyncio.run(main()), keeping the existing async def
main() and Client usage so the snippet becomes copy/paste executable.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 950dc15c-6513-43fe-a5c0-5120c69acb6f

📥 Commits

Reviewing files that changed from the base of the PR and between 3f918c0 and 19874a1.

📒 Files selected for processing (1)
  • docs/source/guide/cookie.md

Comment thread docs/source/guide/cookie.md
@0x676e67 0x676e67 merged commit c78b250 into 0x676e67:main Apr 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants