Merge pull request #697 from 38elements/stream

Add Request.stream

tests/test_blueprints.py

@@ -21,6 +21,7 @@ def test_bp():
 
     app.blueprint(bp)
     request, response = app.test_client.get('/')
+    assert app.is_request_stream is False
 
     assert response.text == 'Hello'
 
@@ -268,38 +269,48 @@ def test_bp_shorthand():
 
     @blueprint.get('/get')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.put('/put')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.post('/post')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.head('/head')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.options('/options')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.patch('/patch')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.delete('/delete')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @blueprint.websocket('/ws')
     async def handler(request, ws):
+        assert request.stream is None
         ev.set()
 
     app.blueprint(blueprint)
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.get('/get')
     assert response.text == 'OK'
 

tests/test_request_stream.py

@@ -0,0 +1,435 @@
+import asyncio
+from sanic import Sanic
+from sanic.blueprints import Blueprint
+from sanic.views import CompositionView
+from sanic.views import HTTPMethodView
+from sanic.views import stream as stream_decorator
+from sanic.response import stream, text
+
+data = "abc" * 100000
+
+
+def test_request_stream_method_view():
+    '''for self.is_request_stream = True'''
+
+    app = Sanic('test_request_stream_method_view')
+
+    class SimpleView(HTTPMethodView):
+
+        def get(self, request):
+            assert request.stream is None
+            return text('OK')
+
+        @stream_decorator
+        async def post(self, request):
+            assert isinstance(request.stream, asyncio.Queue)
+            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')
+
+    assert app.is_request_stream is True
+
+    request, response = app.test_client.get('/method_view')
+    assert response.status == 200
+    assert response.text == 'OK'
+
+    request, response = app.test_client.post('/method_view', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+
+def test_request_stream_app():
+    '''for self.is_request_stream = True and decorators'''
+
+    app = Sanic('test_request_stream_app')
+
+    @app.get('/get')
+    async def get(request):
+        assert request.stream is None
+        return text('GET')
+
+    @app.head('/head')
+    async def head(request):
+        assert request.stream is None
+        return text('HEAD')
+
+    @app.delete('/delete')
+    async def delete(request):
+        assert request.stream is None
+        return text('DELETE')
+
+    @app.options('/options')
+    async def options(request):
+        assert request.stream is None
+        return text('OPTIONS')
+
+    @app.post('/_post/<id>')
+    async def _post(request, id):
+        assert request.stream is None
+        return text('_POST')
+
+    @app.post('/post/<id>', stream=True)
+    async def post(request, id):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    @app.put('/_put')
+    async def _put(request):
+        assert request.stream is None
+        return text('_PUT')
+
+    @app.put('/put', stream=True)
+    async def put(request):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    @app.patch('/_patch')
+    async def _patch(request):
+        assert request.stream is None
+        return text('_PATCH')
+
+    @app.patch('/patch', stream=True)
+    async def patch(request):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    assert app.is_request_stream is True
+
+    request, response = app.test_client.get('/get')
+    assert response.status == 200
+    assert response.text == 'GET'
+
+    request, response = app.test_client.head('/head')
+    assert response.status == 200
+    assert response.text == ''
+
+    request, response = app.test_client.delete('/delete')
+    assert response.status == 200
+    assert response.text == 'DELETE'
+
+    request, response = app.test_client.options('/options')
+    assert response.status == 200
+    assert response.text == 'OPTIONS'
+
+    request, response = app.test_client.post('/_post/1', data=data)
+    assert response.status == 200
+    assert response.text == '_POST'
+
+    request, response = app.test_client.post('/post/1', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+    request, response = app.test_client.put('/_put', data=data)
+    assert response.status == 200
+    assert response.text == '_PUT'
+
+    request, response = app.test_client.put('/put', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+    request, response = app.test_client.patch('/_patch', data=data)
+    assert response.status == 200
+    assert response.text == '_PATCH'
+
+    request, response = app.test_client.patch('/patch', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+
+def test_request_stream_blueprint():
+    '''for self.is_request_stream = True'''
+
+    app = Sanic('test_request_stream_blueprint')
+    bp = Blueprint('test_blueprint_request_stream_blueprint')
+
+    @app.get('/get')
+    async def get(request):
+        assert request.stream is None
+        return text('GET')
+
+    @bp.head('/head')
+    async def head(request):
+        assert request.stream is None
+        return text('HEAD')
+
+    @bp.delete('/delete')
+    async def delete(request):
+        assert request.stream is None
+        return text('DELETE')
+
+    @bp.options('/options')
+    async def options(request):
+        assert request.stream is None
+        return text('OPTIONS')
+
+    @bp.post('/_post/<id>')
+    async def _post(request, id):
+        assert request.stream is None
+        return text('_POST')
+
+    @bp.post('/post/<id>', stream=True)
+    async def post(request, id):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    @bp.put('/_put')
+    async def _put(request):
+        assert request.stream is None
+        return text('_PUT')
+
+    @bp.put('/put', stream=True)
+    async def put(request):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    @bp.patch('/_patch')
+    async def _patch(request):
+        assert request.stream is None
+        return text('_PATCH')
+
+    @bp.patch('/patch', stream=True)
+    async def patch(request):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    app.blueprint(bp)
+
+    assert app.is_request_stream is True
+
+    request, response = app.test_client.get('/get')
+    assert response.status == 200
+    assert response.text == 'GET'
+
+    request, response = app.test_client.head('/head')
+    assert response.status == 200
+    assert response.text == ''
+
+    request, response = app.test_client.delete('/delete')
+    assert response.status == 200
+    assert response.text == 'DELETE'
+
+    request, response = app.test_client.options('/options')
+    assert response.status == 200
+    assert response.text == 'OPTIONS'
+
+    request, response = app.test_client.post('/_post/1', data=data)
+    assert response.status == 200
+    assert response.text == '_POST'
+
+    request, response = app.test_client.post('/post/1', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+    request, response = app.test_client.put('/_put', data=data)
+    assert response.status == 200
+    assert response.text == '_PUT'
+
+    request, response = app.test_client.put('/put', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+    request, response = app.test_client.patch('/_patch', data=data)
+    assert response.status == 200
+    assert response.text == '_PATCH'
+
+    request, response = app.test_client.patch('/patch', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+
+def test_request_stream_composition_view():
+    '''for self.is_request_stream = True'''
+
+    app = Sanic('test_request_stream__composition_view')
+
+    def get_handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    async def post_handler(request):
+        assert isinstance(request.stream, asyncio.Queue)
+        result = ''
+        while True:
+            body = await request.stream.get()
+            if body is None:
+                break
+            result += body.decode('utf-8')
+        return text(result)
+
+    view = CompositionView()
+    view.add(['GET'], get_handler)
+    view.add(['POST'], post_handler, stream=True)
+    app.add_route(view, '/composition_view')
+
+    assert app.is_request_stream is True
+
+    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
+
+
+def test_request_stream():
+    '''test for complex application'''
+
+    bp = Blueprint('test_blueprint_request_stream')
+    app = Sanic('test_request_stream')
+
+    class SimpleView(HTTPMethodView):
+
+        def get(self, request):
+            assert request.stream is None
+            return text('OK')
+
+        @stream_decorator
+        async def post(self, request):
+            assert isinstance(request.stream, asyncio.Queue)
+            result = ''
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                result += body.decode('utf-8')
+            return text(result)
+
+    @app.post('/stream', stream=True)
+    async def handler(request):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                response.write(body.decode('utf-8'))
+        return stream(streaming)
+
+    @app.get('/get')
+    async def get(request):
+        assert request.stream is None
+        return text('OK')
+
+    @bp.post('/bp_stream', stream=True)
+    async def bp_stream(request):
+        assert isinstance(request.stream, asyncio.Queue)
+        result = ''
+        while True:
+            body = await request.stream.get()
+            if body is None:
+                break
+            result += body.decode('utf-8')
+        return text(result)
+
+    @bp.get('/bp_get')
+    async def bp_get(request):
+        assert request.stream is None
+        return text('OK')
+
+    def get_handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    async def post_handler(request):
+        assert isinstance(request.stream, asyncio.Queue)
+        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')
+
+    assert app.is_request_stream is True
+
+    request, response = app.test_client.get('/method_view')
+    assert response.status == 200
+    assert response.text == 'OK'
+
+    request, response = app.test_client.post('/method_view', data=data)
+    assert response.status == 200
+    assert response.text == data
+
+    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.get('/bp_get')
+    assert response.status == 200
+    assert response.text == 'OK'
+
+    request, response = app.test_client.post('/bp_stream', data=data)
+    assert response.status == 200
+    assert response.text == data

tests/test_routes.py

@@ -28,12 +28,16 @@ def test_route_strict_slash():
 
     @app.get('/get', strict_slashes=True)
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
     @app.post('/post/', strict_slashes=True)
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.get('/get')
     assert response.text == 'OK'
 
@@ -77,21 +81,43 @@ def test_shorthand_routes_put():
 
     @app.put('/put')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.put('/put')
     assert response.text == 'OK'
 
     request, response = app.test_client.get('/put')
     assert response.status == 405
 
+def test_shorthand_routes_delete():
+    app = Sanic('test_shorhand_routes_delete')
+
+    @app.delete('/delete')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+
+    request, response = app.test_client.delete('/delete')
+    assert response.text == 'OK'
+
+    request, response = app.test_client.get('/delete')
+    assert response.status == 405
+
 def test_shorthand_routes_patch():
     app = Sanic('test_shorhand_routes_patch')
 
     @app.patch('/patch')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.patch('/patch')
     assert response.text == 'OK'
 
@@ -103,8 +129,11 @@ def test_shorthand_routes_head():
 
     @app.head('/head')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.head('/head')
     assert response.status == 200
 
@@ -116,8 +145,11 @@ def test_shorthand_routes_options():
 
     @app.options('/options')
     def handler(request):
+        assert request.stream is None
         return text('OK')
 
+    assert app.is_request_stream is False
+
     request, response = app.test_client.options('/options')
     assert response.status == 200
 

tests/test_views.py

@@ -16,6 +16,7 @@ def test_methods(method):
     class DummyView(HTTPMethodView):
 
         async def get(self, request):
+            assert request.stream is None
             return text('', headers={'method': 'GET'})
 
         def post(self, request):
@@ -37,6 +38,7 @@ def test_methods(method):
             return text('', headers={'method': 'DELETE'})
 
     app.add_route(DummyView.as_view(), '/')
+    assert app.is_request_stream is False
 
     request, response = getattr(app.test_client, method.lower())('/')
     assert response.headers['method'] == method
@@ -79,6 +81,7 @@ def test_with_bp():
     class DummyView(HTTPMethodView):
 
         def get(self, request):
+            assert request.stream is None
             return text('I am get method')
 
     bp.add_route(DummyView.as_view(), '/')
@@ -86,6 +89,7 @@ def test_with_bp():
     app.blueprint(bp)
     request, response = app.test_client.get('/')
 
+    assert app.is_request_stream is False
     assert response.text == 'I am get method'
 
 
@@ -227,10 +231,15 @@ def test_composition_view_runs_methods_as_expected(method):
     app = Sanic('test_composition_view')
 
     view = CompositionView()
-    view.add(['GET', 'POST', 'PUT'], lambda x: text('first method'))
+
+    def first(request):
+        assert request.stream is None
+        return text('first method')
+    view.add(['GET', 'POST', 'PUT'], first)
     view.add(['DELETE', 'PATCH'], lambda x: text('second method'))
 
     app.add_route(view, '/')
+    assert app.is_request_stream is False
 
     if method in ['GET', 'POST', 'PUT']:
         request, response = getattr(app.test_client, method.lower())('/')