Skip to content

fix: unwanted coercion in to_pydantic_model#949

Merged
JoanFM merged 7 commits intomainfrom
fix-pydantic-version
Dec 17, 2022
Merged

fix: unwanted coercion in to_pydantic_model#949
JoanFM merged 7 commits intomainfrom
fix-pydantic-version

Conversation

@JohannesMessner
Copy link
Copy Markdown
Member

@JohannesMessner JohannesMessner commented Dec 15, 2022

Goals:

This raises the required pydantic version to fix unwanted type coercion in doc.to_pydantic_model(), and by extension, in doc.to_dict().

Before:

from jina import Document

d = Document()
d.tags['title'] = 'Infinity'

print(d.to_pydantic_model())
id='f3fbf26990ef007fe577994b634140db' parent_id=None granularity=None adjacency=None blob=None tensor=None mime_type=None text=None weight=None uri=None tags={'title': 'inf'} offset=None location=None embedding=None modality=None evaluations=None scores=None chunks=None matches=None

Note tags={'title': 'inf'}, it coerced "Infinity" to inf, not what we want.
After:

from jina import Document

d = Document()
d.tags['title'] = 'Infinity'

print(d.to_pydantic_model())
id='f3fbf26990ef007fe577994b634140db' parent_id=None granularity=None adjacency=None blob=None tensor=None mime_type=None text=None weight=None uri=None tags={'title': 'Infinity'} offset=None location=None embedding=None modality=None evaluations=None scores=None chunks=None matches=None

Note tags={'title': 'Infinity'}, no unwanted coercion.

@JohannesMessner JohannesMessner marked this pull request as ready for review December 15, 2022 10:34
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 15, 2022 •
edited
Loading

Codecov Report

Base: 85.14% // Head: 85.21% // Increases project coverage by +0.06% 🎉

Coverage data is based on head (0e5e677) compared to base (6bbcde8).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #949      +/-   ##
==========================================
+ Coverage   85.14%   85.21%   +0.06%     
==========================================
  Files         155      155              
  Lines        8018     8048      +30     
==========================================
+ Hits         6827     6858      +31     
+ Misses       1191     1190       -1
Flag Coverage Δ
docarray 85.21% <ø> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
docarray/array/mixins/traverse.py 96.58% <0.00%> (-0.03%) ⬇️
docarray/document/strawberry_type.py 100.00% <0.00%> (ø)
docarray/array/storage/memory/backend.py 100.00% <0.00%> (ø)
docarray/array/mixins/io/binary.py 99.35% <0.00%> (+<0.01%) ⬆️
docarray/base.py 98.76% <0.00%> (+0.01%) ⬆️
docarray/array/storage/redis/backend.py 97.52% <0.00%> (+0.02%) ⬆️
docarray/array/storage/milvus/backend.py 98.24% <0.00%> (+0.02%) ⬆️
docarray/array/storage/elastic/backend.py 97.08% <0.00%> (+0.02%) ⬆️
docarray/array/storage/opensearch/backend.py 95.89% <0.00%> (+0.02%) ⬆️
docarray/array/storage/annlite/backend.py 97.46% <0.00%> (+0.03%) ⬆️
... and 14 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

JoanFM
JoanFM requested changes Dec 15, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test showing the behavior is correct?

@JohannesMessner
test: add test
0e5e677 
Signed-off-by: Johannes Messner <[email protected]>
@JohannesMessner JohannesMessner linked an issue Dec 16, 2022 that may be closed by this pull request
Bug: string Infinity transformed to inf float when transforming to Pydantic model, which makes starlette to crash #948
Closed
@JoanFM JoanFM merged commit 1443376 into main Dec 17, 2022
@JoanFM JoanFM deleted the fix-pydantic-version branch December 17, 2022 11:39
@alexcg1 alexcg1 mentioned this pull request Jan 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JoanFM JoanFM JoanFM approved these changes

Assignees

No one assigned

Labels

area/setup area/testing size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug: string Infinity transformed to inf float when transforming to Pydantic model, which makes starlette to crash

3 participants

@JohannesMessner @codecov-commenter @JoanFM