Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Forward of the headers in the HTTPExceptions #227

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
foutoucour wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Forward of the headers in the HTTPExceptions #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d44a85
Add the forward of the headers in the HTTPExceptions
foutoucour Dec 10, 2025
f8d94e5
blacken
foutoucour Dec 16, 2025
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
28 changes: 17 additions & 11 deletions gidgethub/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
__version__ = "5.4.0.dev"

import http
from typing import Any, Optional
from typing import Any, Optional, Mapping


class GitHubException(Exception):
Expand All @@ -19,8 +19,14 @@ class ValidationFailure(GitHubException):
class HTTPException(GitHubException):
"""A general exception to represent HTTP responses."""

def __init__(self, status_code: http.HTTPStatus, *args: Any) -> None:
def __init__(
self,
status_code: http.HTTPStatus,
*args: Any,
headers: Mapping[str, str] = None,
) -> None:
self.status_code = status_code
self.headers = headers or {}
if args:
super().__init__(*args)
else:
Expand All @@ -43,23 +49,23 @@ class BadRequest(HTTPException):
class BadRequestUnknownError(BadRequest):
"""A bad request whose response body is not JSON."""

def __init__(self, response: str) -> None:
def __init__(self, response: str, **kwargs) -> None:
self.response = response
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY)
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY, **kwargs)


class RateLimitExceeded(BadRequest):
"""Request rejected due to the rate limit being exceeded."""

# Technically rate_limit is of type gidgethub.sansio.RateLimit, but a
# circular import comes about if you try to properly declare it.
def __init__(self, rate_limit: Any, *args: Any) -> None:
def __init__(self, rate_limit: Any, *args: Any, **kwargs) -> None:
self.rate_limit = rate_limit

if not args:
super().__init__(http.HTTPStatus.FORBIDDEN, "rate limit exceeded")
super().__init__(http.HTTPStatus.FORBIDDEN, "rate limit exceeded", **kwargs)
else:
super().__init__(http.HTTPStatus.FORBIDDEN, *args)
super().__init__(http.HTTPStatus.FORBIDDEN, *args, **kwargs)


class InvalidField(BadRequest):
Expand All @@ -69,10 +75,10 @@ class InvalidField(BadRequest):
invalid are stored in the errors attribute.
"""

def __init__(self, errors: Any, *args: Any) -> None:
def __init__(self, errors: Any, *args: Any, **kwargs) -> None:
"""Store the error details."""
self.errors = errors
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY, *args)
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY, *args, **kwargs)


class ValidationError(BadRequest):
Expand All @@ -82,10 +88,10 @@ class ValidationError(BadRequest):
are stored in the *errors* attribute.
"""

def __init__(self, errors: Any, *args: Any) -> None:
def __init__(self, errors: Any, *args: Any, **kwargs) -> None:
"""Store the error details."""
self.errors = errors
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY, *args)
super().__init__(http.HTTPStatus.UNPROCESSABLE_ENTITY, *args, **kwargs)


class GitHubBroken(HTTPException):
Expand Down
9 changes: 5 additions & 4 deletions gidgethub/sansio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ def from_http(
"expected a content-type of "
"'application/json' or "
"'application/x-www-form-urlencoded'",
headers=headers,
) from exc
return cls(
data,
Expand Down Expand Up @@ -339,13 +340,13 @@ def decipher_response(
if status_code == 403:
rate_limit = RateLimit.from_http(headers)
if rate_limit and not rate_limit.remaining:
raise RateLimitExceeded(rate_limit, message)
raise RateLimitExceeded(rate_limit, message, headers=headers)
elif status_code == 422:
try:
errors = data.get("errors", None)
except AttributeError:
# Not JSON so don't know why the request failed.
raise BadRequestUnknownError(data)
raise BadRequestUnknownError(data, headers=headers)
exc_type = InvalidField
if errors:
if isinstance(errors, str):
Expand All @@ -366,7 +367,7 @@ def decipher_response(
message = f"{message}: {error_context}"
else:
message = data["message"]
raise exc_type(errors, message)
raise exc_type(errors, message, headers=headers)
elif status_code >= 300:
exc_type = RedirectionException
else:
Expand All @@ -377,7 +378,7 @@ def decipher_response(
args = status_code_enum, message
else:
args = (status_code_enum,)
raise exc_type(*args)
raise exc_type(*args, headers=headers)


DOMAIN = "https://api.github.com"
Expand Down
11 changes: 11 additions & 0 deletions tests/test_sansio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,12 +286,14 @@ def test_5XX(self):
with pytest.raises(GitHubBroken) as exc_info:
sansio.decipher_response(status_code, {}, b"")
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert exc_info.value.headers == {}

def test_4XX_no_message(self):
status_code = 400
with pytest.raises(BadRequest) as exc_info:
sansio.decipher_response(status_code, {}, b"")
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert exc_info.value.headers == {}

def test_4XX_message(self):
status_code = 400
Expand All @@ -301,6 +303,7 @@ def test_4XX_message(self):
sansio.decipher_response(status_code, headers, message)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert str(exc_info.value) == "it went bad"
assert exc_info.value.headers == headers

def test_404(self):
status_code = 404
Expand All @@ -309,6 +312,7 @@ def test_404(self):
sansio.decipher_response(status_code, headers, body)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert str(exc_info.value) == "Not Found"
assert exc_info.value.headers == headers

def test_403_rate_limit_exceeded(self):
status_code = 403
Expand All @@ -322,6 +326,7 @@ def test_403_rate_limit_exceeded(self):
with pytest.raises(RateLimitExceeded) as exc_info:
sansio.decipher_response(status_code, headers, body)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert exc_info.value.headers == headers

def test_403_forbidden(self):
status_code = 403
Expand All @@ -334,6 +339,7 @@ def test_403_forbidden(self):
with pytest.raises(BadRequest) as exc_info:
sansio.decipher_response(status_code, headers, b"")
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert exc_info.value.headers == headers

def test_422(self):
status_code = 422
Expand All @@ -345,6 +351,7 @@ def test_422(self):
sansio.decipher_response(status_code, headers, body)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert str(exc_info.value) == "it went bad for 'title'"
assert exc_info.value.headers == headers

def test_422_custom_code(self):
status_code = 422
Expand All @@ -365,6 +372,7 @@ def test_422_custom_code(self):
str(exc_info.value)
== "it went bad: 'A pull request already exists for foo:1.'"
)
assert exc_info.value.headers == headers

def test_422_errors_as_string(self):
"""Test 422 response where 'errors' field is a string instead of list of objects."""
Expand All @@ -386,6 +394,7 @@ def test_422_errors_as_string(self):
str(exc_info.value)
== "Validation Failed: Validation failed: This SHA and context has reached the maximum number of statuses."
)
assert exc_info.value.headers == headers

def test_422_no_errors_object(self):
status_code = 422
Expand All @@ -401,6 +410,7 @@ def test_422_no_errors_object(self):
sansio.decipher_response(status_code, headers, body)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert str(exc_info.value) == "Reference does not exist"
assert exc_info.value.headers == headers

def test_422_html_response(self):
# https://github.com/brettcannon/gidgethub/issues/81
Expand All @@ -412,6 +422,7 @@ def test_422_html_response(self):
sansio.decipher_response(status_code, headers, encoded_body)
assert exc_info.value.status_code == http.HTTPStatus(status_code)
assert exc_info.value.response == body
assert exc_info.value.headers == headers

def test_3XX(self):
status_code = 301
Expand Down