Skip to content

fix: preserve HTTP error subclasses when pickling #163

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
Shubham-Padkonde wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: preserve HTTP error subclasses when pickling #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion python_http_client/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def __init__(self, *args):

def __reduce__(self):
return (
HTTPError,
type(self),
(self.status_code, self.reason, self.body, self.headers)
)

Expand Down
16 changes: 16 additions & 0 deletions tests/test_unit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
ServiceUnavailableError,
UnauthorizedError,
UnsupportedMediaTypeError,
err_dict,
)

try:
Expand Down Expand Up @@ -209,6 +210,21 @@ def test_client_pickle_unpickle(self):
"original client and unpickled client must have the same state"
)

def test_pickle_error_preserves_exception_type(self):
error_types = list(err_dict.items()) + [(418, SG_HTTPError)]
for status_code, error_type in error_types:
for protocol in range(pickle.HIGHEST_PROTOCOL + 1):
error = error_type(
status_code, 'REASON', b'{"error": "failed"}',
{'Retry-After': '30'},
)
restored = pickle.loads(pickle.dumps(error, protocol))
self.assertIs(type(restored), error_type)
self.assertEqual(restored.status_code, error.status_code)
self.assertEqual(restored.reason, error.reason)
self.assertEqual(restored.body, error.body)
self.assertEqual(restored.headers, error.headers)

@mock.patch('python_http_client.client.urllib')
def test_pickle_error(self, mock_lib):
mock_opener = MockOpener()
Expand Down