]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101536: [docs] Improve attributes of `urllib.error.HTTPError` (#101612)
authorNikita Sobolev <mail@sobolevn.me>
Sat, 18 Feb 2023 15:46:33 +0000 (18:46 +0300)
committerGitHub <noreply@github.com>
Sat, 18 Feb 2023 15:46:33 +0000 (12:46 -0300)
* gh-101536: [docs] Improve attributes of `urllib.error.HTTPError`

* Address review

Doc/library/urllib.error.rst

index f7d47ed76aca18fbbbbac3e064647c39972b4d5a..3adbdd26132273bcbe71987ed9857067ebf395b9 100644 (file)
@@ -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`