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

Deprecate body_bytes to merge into body #1739

Merged
merged 2 commits into from
Jun 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 9 additions & 6 deletions sanic/response.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,12 @@ def __init__(
self.headers = Header(headers or {})
self._cookies = None

if body_bytes:
warnings.warn(
"Parameter `body_bytes` is deprecated, use `body` instead",
DeprecationWarning,
)

def output(self, version="1.1", keep_alive=False, keep_alive_timeout=None):
body = b""
if has_message_body(self.status):
Expand All @@ -173,7 +179,7 @@ def empty(status=204, headers=None):
:param status Response code.
:param headers Custom Headers.
"""
return HTTPResponse(body_bytes=b"", status=status, headers=headers)
return HTTPResponse(body=b"", status=status, headers=headers)


def json(
Expand Down Expand Up @@ -243,10 +249,7 @@ def raw(
:param content_type: the content type (string) of the response.
"""
return HTTPResponse(
body_bytes=body,
status=status,
headers=headers,
content_type=content_type,
body=body, status=status, headers=headers, content_type=content_type,
)


Expand Down Expand Up @@ -306,10 +309,10 @@ async def file(

mime_type = mime_type or guess_type(filename)[0] or "text/plain"
return HTTPResponse(
body=out_stream,
status=status,
headers=headers,
content_type=mime_type,
body_bytes=out_stream,
)


Expand Down
15 changes: 15 additions & 0 deletions tests/test_response.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import asyncio
import inspect
import os
import warnings

from collections import namedtuple
from mimetypes import guess_type
Expand Down Expand Up @@ -607,3 +608,17 @@ def handler(request):
request, response = app.test_client.get("/test")
assert response.content_type is None
assert response.body == b""


def test_response_body_bytes_deprecated(app):
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")

HTTPResponse(body_bytes=b'bytes')

assert len(w) == 1
assert issubclass(w[0].category, DeprecationWarning)
assert (
"Parameter `body_bytes` is deprecated, use `body` instead"
in str(w[0].message)
)