Skip to content

fix: make example payload a string and not bytes #1587

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
JoanFM merged 1 commit into from
May 30, 2023
Merged

fix: make example payload a string and not bytes #1587

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
4 changes: 3 additions & 1 deletion docarray/typing/tensor/abstract_tensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,9 @@ def __modify_schema__(cls, field_schema: Dict[str, Any]) -> None:
<= DISPLAY_TENSOR_OPENAPI_MAX_ITEMS
):
# custom example only for 'small' shapes, otherwise it is too big to display
example_payload = orjson_dumps(np.zeros(cls.__docarray_target_shape__))
example_payload = orjson_dumps(
np.zeros(cls.__docarray_target_shape__)
).decode()
field_schema.update(example=example_payload)
else:
shape_info = 'not specified'
Expand Down
15 changes: 9 additions & 6 deletions tests/units/document/test_to_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ def test_np_schema():
assert schema['properties']['embedding']['tensor/array shape'] == '[3, 4]'
assert schema['properties']['embedding']['type'] == 'array'
assert schema['properties']['embedding']['items']['type'] == 'number'
assert schema['properties']['embedding']['example'] == orjson_dumps(
np.zeros([3, 4])
assert (
schema['properties']['embedding']['example']
== orjson_dumps(np.zeros([3, 4])).decode()
)

assert (
Expand All @@ -38,8 +39,9 @@ def test_torch_schema():
assert schema['properties']['embedding']['tensor/array shape'] == '[3, 4]'
assert schema['properties']['embedding']['type'] == 'array'
assert schema['properties']['embedding']['items']['type'] == 'number'
assert schema['properties']['embedding']['example'] == orjson_dumps(
np.zeros([3, 4])
assert (
schema['properties']['embedding']['example']
== orjson_dumps(np.zeros([3, 4])).decode()
)

assert (
Expand All @@ -62,8 +64,9 @@ class TensorflowDoc(BaseDoc):
assert schema['properties']['embedding']['tensor/array shape'] == '[3, 4]'
assert schema['properties']['embedding']['type'] == 'array'
assert schema['properties']['embedding']['items']['type'] == 'number'
assert schema['properties']['embedding']['example'] == orjson_dumps(
np.zeros([3, 4])
assert (
schema['properties']['embedding']['example']
== orjson_dumps(np.zeros([3, 4])).decode()
)

assert (
Expand Down