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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# Copyright 2020 by Kurt Griffiths
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Constants, etc. defined by the ASGI specification."""
from __future__ import annotations
from typing import Any, Dict, Mapping
class EventType:
"""Standard ASGI event type strings."""
HTTP_REQUEST = 'http.request'
HTTP_RESPONSE_START = 'http.response.start'
HTTP_RESPONSE_BODY = 'http.response.body'
HTTP_DISCONNECT = 'http.disconnect'
LIFESPAN_STARTUP = 'lifespan.startup'
LIFESPAN_STARTUP_COMPLETE = 'lifespan.startup.complete'
LIFESPAN_STARTUP_FAILED = 'lifespan.startup.failed'
LIFESPAN_SHUTDOWN = 'lifespan.shutdown'
LIFESPAN_SHUTDOWN_COMPLETE = 'lifespan.shutdown.complete'
LIFESPAN_SHUTDOWN_FAILED = 'lifespan.shutdown.failed'
WS_CONNECT = 'websocket.connect'
WS_ACCEPT = 'websocket.accept'
WS_RECEIVE = 'websocket.receive'
WS_SEND = 'websocket.send'
WS_DISCONNECT = 'websocket.disconnect'
WS_CLOSE = 'websocket.close'
class ScopeType:
"""Standard ASGI event type strings."""
HTTP = 'http'
WS = 'websocket'
LIFESPAN = 'lifespan'
class WSCloseCode:
"""WebSocket close codes used by the Falcon ASGI framework.
See also: https://tools.ietf.org/html/rfc6455#section-7.4
"""
NORMAL = 1000
SERVER_ERROR = 1011
FORBIDDEN = 3403
PATH_NOT_FOUND = 3404
HANDLER_NOT_FOUND = 3405
# TODO: use a typed dict for event dicts
AsgiEvent = Mapping[str, Any]
# TODO: use a typed dict for send msg dicts
AsgiSendMsg = Dict[str, Any]
|
