mirror of https://github.com/encode/starlette.git
85 lines
2.4 KiB
Markdown
85 lines
2.4 KiB
Markdown
|
|
||
|
|
Starlette includes a `Request` class that gives you a nicer interface onto
|
||
|
|
the incoming request, rather than accessing the ASGI scope and receive channel directly.
|
||
|
|
|
||
|
|
### Request
|
||
|
|
|
||
|
|
Signature: `Request(scope, receive=None)`
|
||
|
|
|
||
|
|
```python
|
||
|
|
class App:
|
||
|
|
def __init__(self, scope):
|
||
|
|
self.scope = scope
|
||
|
|
|
||
|
|
async def __call__(self, receive, send):
|
||
|
|
request = Request(self.scope, receive)
|
||
|
|
content = '%s %s' % (request.method, request.url.path)
|
||
|
|
response = Response(content, media_type='text/plain')
|
||
|
|
await response(receive, send)
|
||
|
|
```
|
||
|
|
|
||
|
|
Requests present a mapping interface, so you can use them in the same
|
||
|
|
way as a `scope`.
|
||
|
|
|
||
|
|
For instance: `request['path']` will return the ASGI path.
|
||
|
|
|
||
|
|
If you don't need to access the request body you can instantiate a request
|
||
|
|
without providing an argument to `receive`.
|
||
|
|
|
||
|
|
#### Method
|
||
|
|
|
||
|
|
The request method is accessed as `request.method`.
|
||
|
|
|
||
|
|
#### URL
|
||
|
|
|
||
|
|
The request URL is accessed as `request.url`.
|
||
|
|
|
||
|
|
The property is actually a subclass of `str`, and also exposes all the
|
||
|
|
components that can be parsed out of the URL.
|
||
|
|
|
||
|
|
For example: `request.url.path`, `request.url.port`, `request.url.scheme`.
|
||
|
|
|
||
|
|
#### Headers
|
||
|
|
|
||
|
|
Headers are exposed as an immutable, case-insensitive, multi-dict.
|
||
|
|
|
||
|
|
For example: `request.headers['content-type']`
|
||
|
|
|
||
|
|
#### Query Parameters
|
||
|
|
|
||
|
|
Headers are exposed as an immutable multi-dict.
|
||
|
|
|
||
|
|
For example: `request.query_params['abc']`
|
||
|
|
|
||
|
|
#### Body
|
||
|
|
|
||
|
|
There are a few different interfaces for returning the body of the request:
|
||
|
|
|
||
|
|
The request body as bytes: `await request.body()`
|
||
|
|
|
||
|
|
The request body, parsed as JSON: `await request.json()`
|
||
|
|
|
||
|
|
You can also access the request body as a stream, using the `async for` syntax:
|
||
|
|
|
||
|
|
```python
|
||
|
|
class App:
|
||
|
|
def __init__(self, scope):
|
||
|
|
self.scope = scope
|
||
|
|
|
||
|
|
async def __call__(self, receive, send):
|
||
|
|
request = Request(self.scope, receive)
|
||
|
|
body = b''
|
||
|
|
async for chunk in request.stream():
|
||
|
|
body += chunk
|
||
|
|
response = Response(body, media_type='text/plain')
|
||
|
|
await response(receive, send)
|
||
|
|
```
|
||
|
|
|
||
|
|
If you access `.stream()` then the byte chunks are provided without storing
|
||
|
|
the entire body to memory. Any subsequent calls to `.body()` and `.json()` will
|
||
|
|
raise an error.
|
||
|
|
|
||
|
|
|
||
|
|
<p align="center">— ⭐️ —</p>
|
||
|
|
<p align="center"><i>Starlette is <a href="https://github.com/tomchristie/starlette/blob/master/LICENSE.md">BSD licensed</a> code. Designed & built in Brighton, England.</i></p>
|