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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
import aiohttp
import marshmallow as ma
from aiohttp.web import json_response
from webargs import fields, validate
from webargs.aiohttpparser import parser, use_args, use_kwargs
from webargs.core import json
hello_args = {"name": fields.Str(load_default="World", validate=validate.Length(min=3))}
hello_multiple = {"name": fields.List(fields.Str())}
class HelloSchema(ma.Schema):
name = fields.Str(load_default="World", validate=validate.Length(min=3))
hello_many_schema = HelloSchema(many=True)
# variant which ignores unknown fields
hello_exclude_schema = HelloSchema(unknown=ma.EXCLUDE)
##### Handlers #####
async def echo(request):
parsed = await parser.parse(hello_args, request, location="query")
return json_response(parsed)
async def echo_form(request):
parsed = await parser.parse(hello_args, request, location="form")
return json_response(parsed)
async def echo_json(request):
try:
parsed = await parser.parse(hello_args, request, location="json")
except json.JSONDecodeError as exc:
raise aiohttp.web.HTTPBadRequest(
text=json.dumps(["Invalid JSON."]),
content_type="application/json",
) from exc
return json_response(parsed)
async def echo_json_or_form(request):
try:
parsed = await parser.parse(hello_args, request, location="json_or_form")
except json.JSONDecodeError as exc:
raise aiohttp.web.HTTPBadRequest(
text=json.dumps(["Invalid JSON."]),
content_type="application/json",
) from exc
return json_response(parsed)
@use_args(hello_args, location="query")
async def echo_use_args(request, args):
return json_response(args)
@use_kwargs(hello_args, location="query")
async def echo_use_kwargs(request, name):
return json_response({"name": name})
@use_args(
{"value": fields.Int()}, validate=lambda args: args["value"] > 42, location="form"
)
async def echo_use_args_validated(request, args):
return json_response(args)
async def echo_ignoring_extra_data(request):
return json_response(
await parser.parse(hello_exclude_schema, request, unknown=None)
)
async def echo_multi(request):
parsed = await parser.parse(hello_multiple, request, location="query")
return json_response(parsed)
async def echo_multi_form(request):
parsed = await parser.parse(hello_multiple, request, location="form")
return json_response(parsed)
async def echo_multi_json(request):
parsed = await parser.parse(hello_multiple, request)
return json_response(parsed)
async def echo_many_schema(request):
parsed = await parser.parse(hello_many_schema, request)
return json_response(parsed)
@use_args({"value": fields.Int()}, location="query")
async def echo_use_args_with_path_param(request, args):
return json_response(args)
@use_kwargs({"value": fields.Int()}, location="query")
async def echo_use_kwargs_with_path_param(request, value):
return json_response({"value": value})
@use_args({"page": fields.Int(), "q": fields.Int()}, location="query")
@use_args({"name": fields.Str()})
async def echo_use_args_multiple(request, query_parsed, json_parsed):
return json_response({"query_parsed": query_parsed, "json_parsed": json_parsed})
async def always_error(request):
def always_fail(value):
raise ma.ValidationError("something went wrong")
args = {"text": fields.Str(validate=always_fail)}
parsed = await parser.parse(args, request)
return json_response(parsed)
async def echo_headers(request):
parsed = await parser.parse(hello_args, request, location="headers")
return json_response(parsed)
async def echo_cookie(request):
parsed = await parser.parse(hello_args, request, location="cookies")
return json_response(parsed)
async def echo_nested(request):
args = {"name": fields.Nested({"first": fields.Str(), "last": fields.Str()})}
parsed = await parser.parse(args, request)
return json_response(parsed)
async def echo_multiple_args(request):
args = {"first": fields.Str(), "last": fields.Str()}
parsed = await parser.parse(args, request)
return json_response(parsed)
async def echo_nested_many(request):
args = {
"users": fields.Nested({"id": fields.Int(), "name": fields.Str()}, many=True)
}
parsed = await parser.parse(args, request)
return json_response(parsed)
async def echo_nested_many_data_key(request):
args = {
"x_field": fields.Nested({"id": fields.Int()}, many=True, data_key="X-Field")
}
parsed = await parser.parse(args, request)
return json_response(parsed)
async def echo_match_info(request):
parsed = await parser.parse(
{"mymatch": fields.Int()}, request, location="match_info"
)
return json_response(parsed)
class EchoHandler:
@use_args(hello_args, location="query")
async def get(self, request, args):
return json_response(args)
class EchoHandlerView(aiohttp.web.View):
@use_args(hello_args, location="query")
async def get(self, args):
return json_response(args)
@use_args(HelloSchema, as_kwargs=True, location="query")
async def echo_use_schema_as_kwargs(request, name):
return json_response({"name": name})
##### App factory #####
def add_route(app, methods, route, handler):
for method in methods:
app.router.add_route(method, route, handler)
def create_app():
app = aiohttp.web.Application()
add_route(app, ["GET"], "/echo", echo)
add_route(app, ["POST"], "/echo_form", echo_form)
add_route(app, ["POST"], "/echo_json", echo_json)
add_route(app, ["POST"], "/echo_json_or_form", echo_json_or_form)
add_route(app, ["GET"], "/echo_use_args", echo_use_args)
add_route(app, ["GET"], "/echo_use_kwargs", echo_use_kwargs)
add_route(app, ["POST"], "/echo_use_args_validated", echo_use_args_validated)
add_route(app, ["POST"], "/echo_ignoring_extra_data", echo_ignoring_extra_data)
add_route(app, ["GET"], "/echo_multi", echo_multi)
add_route(app, ["POST"], "/echo_multi_form", echo_multi_form)
add_route(app, ["POST"], "/echo_multi_json", echo_multi_json)
add_route(app, ["GET", "POST"], "/echo_many_schema", echo_many_schema)
add_route(
app,
["GET", "POST"],
"/echo_use_args_with_path_param/{name}",
echo_use_args_with_path_param,
)
add_route(
app,
["GET", "POST"],
"/echo_use_kwargs_with_path_param/{name}",
echo_use_kwargs_with_path_param,
)
add_route(app, ["POST"], "/echo_use_args_multiple", echo_use_args_multiple)
add_route(app, ["GET", "POST"], "/error", always_error)
add_route(app, ["GET"], "/echo_headers", echo_headers)
add_route(app, ["GET"], "/echo_cookie", echo_cookie)
add_route(app, ["POST"], "/echo_nested", echo_nested)
add_route(app, ["POST"], "/echo_multiple_args", echo_multiple_args)
add_route(app, ["POST"], "/echo_nested_many", echo_nested_many)
add_route(app, ["POST"], "/echo_nested_many_data_key", echo_nested_many_data_key)
add_route(app, ["GET"], "/echo_match_info/{mymatch}", echo_match_info)
add_route(app, ["GET"], "/echo_method", EchoHandler().get)
add_route(app, ["GET"], "/echo_method_view", EchoHandlerView)
add_route(app, ["GET"], "/echo_use_schema_as_kwargs", echo_use_schema_as_kwargs)
return app
|
