refactor(Response): rename Response.body to Response.text #1764

ashutoshvarma · 2020-08-23T10:11:20Z

Summary of Changes

This PR renames the Response.body to Response.text in both interfaces. Also Response.body is made deprecated alias for new Response.text

All the references are changed in both docs and docstrings
getters and setters for Response.body has been decorated with deprecated(is_property=True). I was not sure about deprecation message, so I just wrote what came to my mind first.
tests for Response.body are not removed from test_response_media_asgi.py and test_response_media.py instead same test has been added for Response.text

Related Issues

Fix #1578

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

rename Response.body with Response.text. Response.body is now deprecated alias for Response.text fix falconry#1578

codecov · 2020-08-23T10:12:45Z

Codecov Report

Merging #1764 (c0bc7e9) into master (1c5c1b2) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #1764   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           54        54           
  Lines         5127      5132    +5     
  Branches       816       816           
=========================================
+ Hits          5127      5132    +5

Impacted Files	Coverage Δ
falcon/asgi/app.py	`100.00% <100.00%> (ø)`
falcon/asgi/response.py	`100.00% <100.00%> (ø)`
falcon/http_status.py	`100.00% <100.00%> (ø)`
falcon/testing/resource.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c5c1b2...c0bc7e9. Read the comment docs.

CaselIT

Looks good. There may still be some body mention lingering about though

While le issue did not mention HttpStatus, I think that it should also rename body -> text

docs/user/faq.rst

falcon/app.py

kgriffs

Thanks for working on this!

falcon/app.py

falcon/asgi/response.py

vytas7

We ought to also keep a couple of tests referencing the deprecated to property in order to make sure it continues to work as expected.

Furthermore, as you have correctly indicated in the PR checklist, Towcrier fragment(s) are still missing for the change.

vytas7 · 2020-09-20T19:00:40Z

@ashutoshvarma just checking if you might have a chance to continue working on this (by addressing @kgriffs and @CaselIT comments) within the next couple of weeks?

ashutoshvarma · 2020-09-20T19:18:07Z

Sorry it took me so long to respond, I had been busy with stuff.
Yeah I will try to work on changes suggested by @CaselIT and @kgriffs by this week.

vytas7 · 2020-09-20T20:40:18Z

No worries @ashutoshvarma, and thanks for the update.

vytas7 · 2020-11-24T10:17:03Z

Hi @ashutoshvarma !
Sorry for persistence, but just checking again... the same question 😈

CaselIT · 2020-11-24T20:42:53Z

Otherwise if you are ok with it, we could take this to the finish line :)

ashutoshvarma · 2020-11-25T23:05:59Z

Terribly sorry for not fulfilling my commitment.
You can go ahead with it, I don't think I will be able to complete this.

vytas7 · 2020-11-26T06:47:16Z

Heh, no worries @ashutoshvarma !
As a volunteer devoting free time to help an open source project, you have no commitments to us!

@CaselIT would you like to take this over the finish line?

vytas7 · 2020-11-29T11:09:42Z

Is someone still working on this? I'm new to contributing so I thought this would be interesting to tackle if it isn't still taken.

(As I understand this was a limited Black Weekend offer that has now expired 😈 .)

@maknop Yes, you are very welcome to take over if you still wish to!

CaselIT · 2020-11-30T08:17:27Z

Heh, no worries @ashutoshvarma !
As a volunteer devoting free time to help an open source project, you have no commitments to us!

@CaselIT would you like to take this over the finish line?

I may be able to work a bit on it this week

# Conflicts: # falcon/asgi/app.py

CaselIT · 2020-12-12T14:36:14Z

A bit late, but I've managed to come around and finish this

vytas7

This is looking good 👍

I could, however, grep a couple of items that could be revised too:

docs/_newsfragments/1679.breakingchange.rst
docs/user/recipes/output-csv.rst

tests/test_alias.py

# Conflicts: # falcon/app.py # falcon/app_helpers.py # tests/test_httperror.py # tests/test_middleware.py

kgriffs

Looks good!

ashutoshvarma added 2 commits August 23, 2020 13:35

refactor(Response): deprecate Response.body

b7b5227

rename Response.body with Response.text. Response.body is now deprecated alias for Response.text fix falconry#1578

docs(Response): change all reference to body with text

18bb979

CaselIT reviewed Aug 24, 2020

View reviewed changes

docs/user/faq.rst Outdated Show resolved Hide resolved

falcon/app.py Outdated Show resolved Hide resolved

Merge branch 'master' into master

87d6fc6

kgriffs requested changes Aug 27, 2020

View reviewed changes

falcon/app.py Outdated Show resolved Hide resolved

falcon/asgi/response.py Show resolved Hide resolved

vytas7 requested changes Sep 20, 2020

View reviewed changes

Merge branch 'master' into master

4b289de

vytas7 added 2 commits November 21, 2020 10:11

Merge branch 'master' into master

4f0ef1f

Merge branch 'master' into master

c4c2642

vytas7 added the needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks! label Nov 26, 2020

kgriffs added the pr:prioritized label Dec 1, 2020

CaselIT added 4 commits December 12, 2020 14:52

Merge branch 'master-upstream' into 1764-raname-body

aa67d90

# Conflicts: # falcon/asgi/app.py

chore: rename also HTTPStatus body attribute to text

19bc95d

docs: improve documentation, add changelog

ef99c34

test: filter warnings

f06435d

CaselIT requested review from kgriffs and vytas7 December 12, 2020 14:35

chore: make mypy happy

21e3584

CaselIT removed the needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks! label Dec 12, 2020

CaselIT previously approved these changes Dec 15, 2020

View reviewed changes

vytas7 requested changes Dec 16, 2020

View reviewed changes

tests/test_alias.py Show resolved Hide resolved

vytas7 changed the title ~~rename Response.body to Response.text for both the WSGI and ASGI interfaces~~ refactor(Response): rename Response.body to Response.text Dec 16, 2020

CaselIT added 2 commits December 16, 2020 22:43

docs: update some further body reference to text

b45fb64

Merge branch 'master-upstream' into 1764-raname-body

b7ec8e3

# Conflicts: # falcon/app.py # falcon/app_helpers.py # tests/test_httperror.py # tests/test_middleware.py

CaselIT dismissed their stale review via b7ec8e3 December 16, 2020 21:49

CaselIT requested a review from vytas7 December 16, 2020 21:50

CaselIT approved these changes Dec 16, 2020

View reviewed changes

Merge branch 'master' into master

c0bc7e9

kgriffs approved these changes Dec 17, 2020

View reviewed changes

vytas7 approved these changes Dec 17, 2020

View reviewed changes

vytas7 merged commit ce29af7 into falconry:master Dec 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(Response): rename Response.body to Response.text #1764

refactor(Response): rename Response.body to Response.text #1764

ashutoshvarma commented Aug 23, 2020 •

edited by CaselIT

Loading

codecov bot commented Aug 23, 2020 •

edited

Loading

CaselIT left a comment

kgriffs left a comment

vytas7 left a comment

vytas7 commented Sep 20, 2020

ashutoshvarma commented Sep 20, 2020

vytas7 commented Sep 20, 2020

vytas7 commented Nov 24, 2020

CaselIT commented Nov 24, 2020

ashutoshvarma commented Nov 25, 2020

vytas7 commented Nov 26, 2020

vytas7 commented Nov 29, 2020

CaselIT commented Nov 30, 2020

CaselIT commented Dec 12, 2020

vytas7 left a comment •

edited

Loading

kgriffs left a comment

refactor(Response): rename Response.body to Response.text #1764

refactor(Response): rename Response.body to Response.text #1764

Conversation

ashutoshvarma commented Aug 23, 2020 • edited by CaselIT Loading

Summary of Changes

Related Issues

Pull Request Checklist

codecov bot commented Aug 23, 2020 • edited Loading

Codecov Report

CaselIT left a comment

Choose a reason for hiding this comment

kgriffs left a comment

Choose a reason for hiding this comment

vytas7 left a comment

Choose a reason for hiding this comment

vytas7 commented Sep 20, 2020

ashutoshvarma commented Sep 20, 2020

vytas7 commented Sep 20, 2020

vytas7 commented Nov 24, 2020

CaselIT commented Nov 24, 2020

ashutoshvarma commented Nov 25, 2020

vytas7 commented Nov 26, 2020

vytas7 commented Nov 29, 2020

CaselIT commented Nov 30, 2020

CaselIT commented Dec 12, 2020

vytas7 left a comment • edited Loading

Choose a reason for hiding this comment

kgriffs left a comment

Choose a reason for hiding this comment

ashutoshvarma commented Aug 23, 2020 •

edited by CaselIT

Loading

codecov bot commented Aug 23, 2020 •

edited

Loading

vytas7 left a comment •

edited

Loading