[Python-checkins] gh-101536: [docs] Improve attributes of `urllib.error.HTTPError` (#101612)
facundobatista
webhook-mailer at python.org
Sat Feb 18 10:46:40 EST 2023
https://github.com/python/cpython/commit/af446bbb76f64e67831444a0ceee6863a1527088
commit: af446bbb76f64e67831444a0ceee6863a1527088
branch: main
author: Nikita Sobolev <mail at sobolevn.me>
committer: facundobatista <facundo at taniquetil.com.ar>
date: 2023-02-18T12:46:33-03:00
summary:
gh-101536: [docs] Improve attributes of `urllib.error.HTTPError` (#101612)
* gh-101536: [docs] Improve attributes of `urllib.error.HTTPError`
* Address review
files:
M Doc/library/urllib.error.rst
diff --git a/Doc/library/urllib.error.rst b/Doc/library/urllib.error.rst
index f7d47ed76aca..3adbdd261322 100644
--- a/Doc/library/urllib.error.rst
+++ b/Doc/library/urllib.error.rst
@@ -31,7 +31,7 @@ The following exceptions are raised by :mod:`urllib.error` as appropriate:
of :exc:`IOError`.
-.. exception:: HTTPError
+.. exception:: HTTPError(url, code, msg, hdrs, fp)
Though being an exception (a subclass of :exc:`URLError`), an
:exc:`HTTPError` can also function as a non-exceptional file-like return
@@ -39,6 +39,11 @@ The following exceptions are raised by :mod:`urllib.error` as appropriate:
is useful when handling exotic HTTP errors, such as requests for
authentication.
+ .. attribute:: url
+
+ Contains the request URL.
+ An alias for *filename* attribute.
+
.. attribute:: code
An HTTP status code as defined in :rfc:`2616`. This numeric value corresponds
@@ -48,14 +53,20 @@ The following exceptions are raised by :mod:`urllib.error` as appropriate:
.. attribute:: reason
This is usually a string explaining the reason for this error.
+ An alias for *msg* attribute.
.. attribute:: headers
The HTTP response headers for the HTTP request that caused the
:exc:`HTTPError`.
+ An alias for *hdrs* attribute.
.. versionadded:: 3.4
+ .. attribute:: fp
+
+ A file-like object where the HTTP error body can be read from.
+
.. exception:: ContentTooShortError(msg, content)
This exception is raised when the :func:`~urllib.request.urlretrieve`
More information about the Python-checkins
mailing list