Skip to content

170 - Respect response_type when Deserializing response #180

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 4 commits into from
Apr 4, 2022
Merged

170 - Respect response_type when Deserializing response #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b299e02
Respect response_type if it's "str" but the response is json
da1910 Apr 4, 2022
12a100f
Merge branch 'main' into fix/170-respect-str-response-type
da1910 Apr 4, 2022
a608c73
Add type for data variable in deserialize method
da1910 Apr 4, 2022
431f2f6
Remove code that shouldn't ever be hit
da1910 Apr 4, 2022
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
15 changes: 6 additions & 9 deletions src/ansys/openapi/common/_api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,15 +319,12 @@ def deserialize(
if response_type == "file":
return self.__deserialize_file(response)

try:
data = response.json()
except ValueError:
content_type = response.headers.get(
"Content-Type", "application/octet-stream"
)
if content_type not in ["application/octet-stream"]:
data = response.text
else:
if response_type == "str":
data: SerializedType = response.text
else:
try:
data = response.json()
except ValueError:
data = response.content

return self.__deserialize(data, response_type)
Expand Down
13 changes: 11 additions & 2 deletions tests/test_api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,9 +378,9 @@ def test_json_parsed_as_json(self, mocker):
response = self.create_response(data)
deserialize_mock = mocker.patch.object(ApiClient, "_ApiClient__deserialize")
deserialize_mock.return_value = True
_ = self._client.deserialize(response, dict)
_ = self._client.deserialize(response, "dict")
deserialize_mock.assert_called()
deserialize_mock.assert_called_once_with(data, dict)
deserialize_mock.assert_called_once_with(data, "dict")

def test_text_parsed_as_text(self, mocker):
data = "This is some data this is definitely not json, it should be rendered as a string"
Expand All @@ -391,6 +391,15 @@ def test_text_parsed_as_text(self, mocker):
deserialize_mock.assert_called()
deserialize_mock.assert_called_once_with(data, "str")

def test_deserialize_json_as_string_returns_string(self, mocker):
data = json.dumps({"foo": "bar", "baz": [1, 2, 3]})
response = self.create_response(text=data, content_type="text/plain")
deserialize_mock = mocker.patch.object(ApiClient, "_ApiClient__deserialize")
deserialize_mock.return_value = True
_ = self._client.deserialize(response, "str")
deserialize_mock.assert_called()
deserialize_mock.assert_called_once_with(data, "str")

@pytest.mark.parametrize("provide_content_type", (True, False))
def test_application_data_is_not_parsed(self, mocker, provide_content_type):
# The false case tests the default handling of non-json data
Expand Down