Skip to content

Commit

Permalink
Add documentation section on client authentication (#6998)
Browse files Browse the repository at this point in the history
<!-- Thank you for your contribution! -->

## What do these changes do?

Adds a dedicated section on client authentication using the `auth`
argument for HTTP Basic Auth. Also explains how to configure other
authentication flows including periodic renewal of credentials.

## Are there changes in behavior for the user?

No. Just makes it easier for developers to access authentication
`aiohttp` features. Avoids users asking questions like this:
#6908

## Related issue number

Issue #6915 

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist
- [x] Documentation reflects the changes
- [x] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] Add a new news fragment into the `CHANGES` folder
  * name it `<issue_id>.<type>` for example (588.bugfix)
* if you don't have an `issue_id` change it to the pr id after creating
the pr
  * ensure type is one of the following:
    * `.feature`: Signifying a new feature.
    * `.bugfix`: Signifying a bug fix.
    * `.doc`: Signifying a documentation improvement.
    * `.removal`: Signifying a deprecation or removal of public API.
* `.misc`: A ticket has been closed, but it is not of interest to users.
* Make sure to use full sentences with correct case and punctuation, for
example: "Fix issue with non-ascii contents in doctest text files."

Co-authored-by: Sam Bull <aa6bs0@sambull.org>
  • Loading branch information
faph and Dreamsorcerer authored Oct 16, 2022
1 parent 50fec95 commit 981665a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGES/6998.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added documentation on client authentication and updating headers. -- by :user:`faph`
39 changes: 35 additions & 4 deletions docs/client_advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,50 @@ directly as shown above, but it is more convenient to use special keyword

await session.post(url, json={'example': 'text'})

For *text/plain* ::
For ``text/plain``::

await session.post(url, data='Привет, Мир!')

Authentication
--------------

Instead of setting the ``Authorization`` header directly,
:class:`ClientSession` and individual request methods provide an ``auth``
argument. An instance of :class:`BasicAuth` can be passed in like this::

auth = BasicAuth(login="...", password="...")
async with ClientSession(auth=auth) as session:
...

For other authentication flows, the ``Authorization`` header can be set
directly::

headers = {"Authorization": "Bearer eyJh...0M30"}
async with ClientSession(headers=headers) as session:
...

The authentication header for a session may be updated as and when required.
For example::

session.headers["Authorization"] = "Bearer eyJh...1OH0"

Note that a *copy* of the headers dictionary is set as an attribute when
creating a :class:`ClientSession` instance (as a :class:`multidict.CIMultiDict`
object). Updating the original dictionary does not have any effect.

In cases where the authentication header value expires periodically, an
:mod:`asyncio` task may be used to update the session's default headers in the
background.

.. note::

``Authorization`` header will be removed if you get redirected
to a different host or protocol, except the case when ``HTTP -> HTTPS``
The ``Authorization`` header will be removed if you get redirected
to a different host or protocol, except the case when HTTP → HTTPS
redirect is performed on the same host.

.. versionchanged:: 4.0

Started keeping the ``Authorization`` header during ``HTTP -> HTTPS``
Started keeping the ``Authorization`` header during HTTP → HTTPS
redirects when the host remains the same.

Custom Cookies
Expand Down

0 comments on commit 981665a

Please sign in to comment.