search

adriangb / xpresso

A composable Python ASGI web framework
https://xpresso-api.dev/
MIT License
176 stars 4 forks source link

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

Closed adriangb closed 1 year ago

adriangb commented 1 year ago

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

adriangb commented 1 year ago

@danielkza let me know what you think 😃

codecov-commenter commented 1 year ago

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%> (ø)
danielkza commented 1 year ago

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

adriangb commented 1 year ago

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.