File: request_and_response_asgi.rst

package info (click to toggle)
python-falcon 3.1.1-5
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 5,204 kB
  • sloc: python: 28,455; makefile: 184; sh: 139; javascript: 66
file content (51 lines) | stat: -rw-r--r-- 913 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. _request_asgi:

ASGI Request & Response
=======================

* `Request`_
* `Response`_

Instances of the :class:`falcon.asgi.Request` and
:class:`falcon.asgi.Response` classes are passed into responders as
the second and third arguments, respectively:

.. code:: python

    import falcon.asgi


    class Resource:

        async def on_get(self, req, resp):
            resp.media = {'message': 'Hello world!'}
            resp.status = 200


    # -- snip --


    app = falcon.asgi.App()
    app.add_route('/', Resource())

Request
-------

.. autoclass:: falcon.asgi.Request
    :members:
    :inherited-members:
    :exclude-members: media, context_type

.. autoclass:: falcon.asgi.BoundedStream
    :members:

Response
--------

.. autoclass:: falcon.asgi.Response
    :members:
    :inherited-members:
    :exclude-members: context_type, add_link

.. autoclass:: falcon.asgi.SSEvent
    :members: