Skip to content
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.

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

feat!: rename FromFile and File to FromRawBody and RawBody #117

Merged
merged 6 commits into from
Dec 21, 2022
Merged

Conversation

adriangb
Copy link
Owner

@adriangb adriangb commented Dec 21, 2022

This is a breaking change that renames a couple symbols to disambiguate their usage.

@adriangb
Copy link
Owner Author

@danielkza let me know what you think 😃

@codecov-commenter
Copy link

codecov-commenter commented Dec 21, 2022

Codecov Report

Merging #117 (690d717) into main (126b217) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #117   +/-   ##
=======================================
  Coverage   98.34%   98.35%           
=======================================
  Files         123      128    +5     
  Lines        4224     4247   +23     
  Branches      509      509           
=======================================
+ Hits         4154     4177   +23     
  Misses         35       35           
  Partials       35       35           
Impacted Files Coverage Δ
tests/test_routing/test_operation.py 87.80% <ø> (ø)
tests/test_docs/tutorial/body/test_tutorial_006.py 100.00% <100.00%> (ø)
tests/test_request_bodies/test_file.py 100.00% <100.00%> (ø)
xpresso/bodies.py 100.00% <100.00%> (ø)
xpresso/dependencies/__init__.py 100.00% <0.00%> (ø)
tests/__init__.py 100.00% <0.00%> (ø)
xpresso/exceptions.py 100.00% <0.00%> (ø)
xpresso/typing.py 100.00% <0.00%> (ø)

from xpresso.typing import Annotated


class WebhookBody(BaseModel):

Choose a reason for hiding this comment

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

not used?

Copy link
Owner Author

Choose a reason for hiding this comment

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

good catch

@danielkza
Copy link

@adriangb any way to keep an alias from the previous name? just to surprise people a little less :)

@adriangb
Copy link
Owner Author

Yeah I can do that. Since this is a <1 library that is largely experimental I've generally taken the approach of favoring breaking changes over more code / shims, but this one should be easy enough.

@adriangb adriangb merged commit ab1ed0e into main Dec 21, 2022
@adriangb adriangb deleted the raw-body branch December 21, 2022 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants