Skip to content

Commit

Permalink
Add stream for CompositionView
Browse files Browse the repository at this point in the history
  • Loading branch information
38elements committed May 7, 2017
1 parent ef2cc7e commit 931397c
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 3 deletions.
14 changes: 14 additions & 0 deletions docs/sanic/streaming.md
Expand Up @@ -37,6 +37,7 @@ Sanic allows you to get request data by stream, as below. When the request ends,

```
from sanic import Sanic
from sanic.views import CompositionView
from sanic.blueprints import Blueprint
from sanic.response import stream, text
Expand Down Expand Up @@ -71,7 +72,20 @@ async def bp_handler(request):
result += body.decode('utf-8').replace('1', 'A')
return text(result)
async def post_handler(request):
result = ''
while True:
body = await request.stream.get()
if body is None:
break
result += body.decode('utf-8')
return text(result)
app.blueprint(bp)
view = CompositionView()
view.add(['POST'], post_handler, stream=True)
app.add_route(view, '/composition_view')
if __name__ == '__main__':
Expand Down
14 changes: 14 additions & 0 deletions examples/request_stream/server.py
@@ -1,4 +1,5 @@
from sanic import Sanic
from sanic.views import CompositionView
from sanic.blueprints import Blueprint
from sanic.response import stream, text

Expand Down Expand Up @@ -33,7 +34,20 @@ async def bp_handler(request):
result += body.decode('utf-8').replace('1', 'A')
return text(result)


async def post_handler(request):
result = ''
while True:
body = await request.stream.get()
if body is None:
break
result += body.decode('utf-8')
return text(result)

app.blueprint(bp)
view = CompositionView()
view.add(['POST'], post_handler, stream=True)
app.add_route(view, '/composition_view')


if __name__ == '__main__':
Expand Down
2 changes: 1 addition & 1 deletion sanic/router.py
Expand Up @@ -352,4 +352,4 @@ def is_stream_handler(self, request):
:return: bool
"""
handler = self.get(request)[0]
return handler.is_stream
return hasattr(handler, 'is_stream') and handler.is_stream
3 changes: 2 additions & 1 deletion sanic/views.py
Expand Up @@ -83,7 +83,8 @@ class CompositionView:
def __init__(self):
self.handlers = {}

def add(self, methods, handler):
def add(self, methods, handler, stream=False):
handler.is_stream = stream
for method in methods:
if method not in HTTP_METHODS:
raise InvalidUsage(
Expand Down
46 changes: 45 additions & 1 deletion tests/test_request_stream.py
@@ -1,11 +1,19 @@
from sanic import Sanic
from sanic.blueprints import Blueprint
from sanic.views import CompositionView
from sanic.views import HTTPMethodView
from sanic.response import stream, text

bp = Blueprint('test_blueprint_request_stream')
app = Sanic('test_request_stream')


class SimpleView(HTTPMethodView):

def get(self, request):
return text('OK')


@app.stream('/stream')
async def handler(request):
async def streaming(response):
Expand All @@ -32,19 +40,55 @@ async def bp_handler(request):
result += body.decode('utf-8')
return text(result)


def get_handler(request):
return text('OK')


async def post_handler(request):
result = ''
while True:
body = await request.stream.get()
if body is None:
break
result += body.decode('utf-8')
return text(result)


app.add_route(SimpleView.as_view(), '/method_view')

view = CompositionView()
view.add(['GET'], get_handler)
view.add(['POST'], post_handler, stream=True)

app.blueprint(bp)

app.add_route(view, '/composition_view')


def test_request_stream():
data = "abc" * 100000
request, response = app.test_client.post('/stream', data=data)

request, response = app.test_client.get('/method_view')
assert response.status == 200
assert response.text == 'OK'

request, response = app.test_client.get('/composition_view')
assert response.status == 200
assert response.text == 'OK'

request, response = app.test_client.post('/composition_view', data=data)
assert response.status == 200
assert response.text == data

request, response = app.test_client.get('/get')
assert response.status == 200
assert response.text == 'OK'

request, response = app.test_client.post('/stream', data=data)
assert response.status == 200
assert response.text == data

request, response = app.test_client.post('/bp_stream', data=data)
assert response.status == 200
assert response.text == data

0 comments on commit 931397c

Please sign in to comment.