Rooba
/
starlette
mirror of https://github.com/encode/starlette.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update response() calls in docs for ASGI 3

This commit is contained in:
rafalp 2019-06-14 00:21:37 +02:00 committed by Rafał Pitoń
parent 645cc3089a
commit 765bdd2fa6
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.md
View File

@ -104,7 +104,7 @@ class App:
async def __call__(self, receive, send):
response = PlainTextResponse('Hello, world!')
await response(receive, send)
await response(self.scope, receive, send)
```
Run the `App` application in `example.py`:

4
docs/requests.md
View File

@ -20,7 +20,7 @@ class App:
request = Request(self.scope, receive)
content = '%s %s' % (request.method, request.url.path)
response = Response(content, media_type='text/plain')
await response(receive, send)
await response(self.scope, receive, send)
```
Requests present a mapping interface, so you can use them in the same
@ -105,7 +105,7 @@ class App:
async for chunk in request.stream():
body += chunk
response = Response(body, media_type='text/plain')
await response(receive, send)
await response(self.scope, receive, send)
```
If you access `.stream()` then the byte chunks are provided without storing

16
docs/responses.md
View File

@ -29,7 +29,7 @@ class App:
async def __call__(self, receive, send):
response = Response('Hello, world!', media_type='text/plain')
await response(receive, send)
await response(self.scope, receive, send)
```
#### Set Cookie
@ -68,7 +68,7 @@ class App:
async def __call__(self, receive, send):
response = HTMLResponse('<html><body><h1>Hello, world!</h1></body></html>')
await response(receive, send)
await response(self.scope, receive, send)
```
### PlainTextResponse
@ -86,7 +86,7 @@ class App:
async def __call__(self, receive, send):
response = PlainTextResponse('Hello, world!')
await response(receive, send)
await response(self.scope, receive, send)
```
### JSONResponse
@ -104,7 +104,7 @@ class App:
async def __call__(self, receive, send):
response = JSONResponse({'hello': 'world'})
await response(receive, send)
await response(self.scope, receive, send)
```
### UJSONResponse
@ -128,7 +128,7 @@ class App:
async def __call__(self, receive, send):
response = UJSONResponse({'hello': 'world'})
await response(receive, send)
await response(self.scope, receive, send)
```
### RedirectResponse
@ -149,7 +149,7 @@ class App:
response = RedirectResponse(url='/')
else:
response = PlainTextResponse('Hello, world!')
await response(receive, send)
await response(self.scope, receive, send)
```
### StreamingResponse
@ -177,7 +177,7 @@ class App:
async def __call__(self, receive, send):
generator = slow_numbers(1, 10)
response = StreamingResponse(generator, media_type='text/html')
await response(receive, send)
await response(self.scope, receive, send)
```
Have in mind that <a href="https://docs.python.org/3/glossary.html#term-file-like-object" target="_blank">file-like</a> objects (like those created by `open()`) are normal iterators. So, you can return them directly in a `StreamingResponse`.
@ -206,5 +206,5 @@ class App:
async def __call__(self, receive, send):
response = FileResponse('statics/favicon.ico')
await response(receive, send)
await response(self.scope, receive, send)
```

2
docs/testclient.md
View File

@ -14,7 +14,7 @@ class App:
async def __call__(self, receive, send):
response = HTMLResponse('<html><body>Hello, world!</body></html>')
await response(receive, send)
await response(self.scope, receive, send)
def test_app():