Skip to content

gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request() #102328

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

Merged
merged 9 commits into from
May 9, 2023
Merged

gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request() #102328

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
86275f8
Document "url" parameter to HTTPConnection.request() (#102327)
davidfstr Feb 28, 2023
912df17
Alter example URL to be: https://docs.python.org/3/
davidfstr Apr 30, 2023
9013cd3
Alter RFC section link to appear with more-natural formatting
davidfstr Apr 30, 2023
c0960c6
Distribute new documentation to relevant parameter paragraphs
davidfstr May 2, 2023
231bd9e
Adjust formatting
davidfstr May 2, 2023
5a6293d
Fix trailing whitespace
davidfstr May 2, 2023
e6dc07c
Clarify phrasing for when absolute paths are required
davidfstr May 4, 2023
dcf2480
Fix whitespace
davidfstr May 4, 2023
f6f6e48
Merge branch 'main' into f/http_url_clarify
merwok May 9, 2023
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
18 changes: 17 additions & 1 deletion Doc/library/http.client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ HTTPConnection Objects
encode_chunked=False)

This will send a request to the server using the HTTP request
method *method* and the selector *url*.
method *method* and the request URI *url*.

If *body* is specified, the specified data is sent after the headers are
finished. It may be a :class:`str`, a :term:`bytes-like object`, an
Expand Down Expand Up @@ -293,6 +293,22 @@ HTTPConnection Objects
Transfer-Encoding header will automatically be set instead of
Content-Length.

.. note::
When using most HTTP methods (like ``GET`` or ``POST``)
the provided ``url`` must be an absolute path and
a ``Host`` header must be provided to conform with
:rfc:`2616#section-5.1.2`.

For example, to perform a ``GET`` request to ``https://xkcd.com/353/``::

>>> import http.client
>>> host = "xkcd.com"
>>> conn = http.client.HTTPSConnection(host)
>>> conn.request("GET", "/353/", headers={"Host": host})
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200 OK

The *encode_chunked* argument is only relevant if Transfer-Encoding is
specified in *headers*. If *encode_chunked* is ``False``, the
HTTPConnection object assumes that all encoding is handled by the
Expand Down