Skip to content

docs: clarify params query canonicalization behavior #12202

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.

Sign up for GitHub

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

Open
mitre88 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify params query canonicalization behavior #12202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/client_quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,9 @@ that case you can specify multiple values for each key::
expect = 'http://httpbin.org/get?key=value2&key=value1'
assert str(r.url) == expect

You can also pass :class:`str` content as param, but beware -- content
is not encoded by library. Note that ``+`` is not encoded::
You can also pass :class:`str` content as param. The value is used as a
query string, but passing ``params`` does not disable URL
canonicalization. Note that ``+`` is not encoded::

async with session.get('http://httpbin.org/get',
params='key=value+1') as r:
Expand All @@ -149,7 +150,9 @@ is not encoded by library. Note that ``+`` is not encoded::

.. warning::

Passing *params* overrides ``encoded=True``, never use both options.
Passing *params* overrides ``encoded=True``. Never use both options
if you need to preserve exact query-string bytes.
Build the full URL (including query) instead.

Response Content and Status Code
================================
Expand Down
Loading