forked from spinframework/spin-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
409 lines (388 loc) · 19.5 KB
/
Copy pathindex.html
File metadata and controls
409 lines (388 loc) · 19.5 KB
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>spin_sdk.http API documentation</title>
<meta name="description" content="Module with helpers for wasi http">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>spin_sdk.http</code></h1>
</header>
<section id="section-intro">
<p>Module with helpers for wasi http</p>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="spin_sdk.http.copy"><code class="name flex">
<span>async def <span class="ident">copy</span></span>(<span>bytes: bytes, tx: componentize_py_async_support.streams.ByteStreamWriter)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def copy(bytes:bytes, tx:ByteStreamWriter):
with tx:
if bytes is not None:
await tx.write_all(bytes)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.send"><code class="name flex">
<span>async def <span class="ident">send</span></span>(<span>request: <a title="spin_sdk.http.Request" href="#spin_sdk.http.Request">Request</a>) ‑> <a title="spin_sdk.http.Response" href="#spin_sdk.http.Response">Response</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def send(request: Request) -> Response:
"""Send an HTTP request and return a response or raise an error"""
match request.method:
case "GET":
method: Method = Method_Get()
case "HEAD":
method = Method_Head()
case "POST":
method = Method_Post()
case "PUT":
method = Method_Put()
case "DELETE":
method = Method_Delete()
case "CONNECT":
method = Method_Connect()
case "OPTIONS":
method = Method_Options()
case "TRACE":
method = Method_Trace()
case "PATCH":
method = Method_Patch()
case _:
method = Method_Other(request.method)
url_parsed = parse.urlparse(request.uri)
match url_parsed.scheme:
case "http":
scheme: Scheme = Scheme_Http()
case "https":
scheme = Scheme_Https()
case "":
scheme = Scheme_Http()
case _:
scheme = Scheme_Other(url_parsed.scheme)
headers_dict = request.headers
# Add a `content-length` header if the caller didn't include one, but did
# specify a body:
if headers_dict.get('content-length') is None:
content_length = len(request.body) if request.body is not None else 0
# Make a copy rather than mutate in place, since the caller might not
# expect us to mutate it:
headers_dict = headers_dict.copy()
headers_dict['content-length'] = str(content_length)
headers = list(map(
lambda pair: (pair[0], bytes(pair[1], "utf-8")),
headers_dict.items()
))
tx, rx = wit.byte_stream()
componentize_py_async_support.spawn(copy(request.body, tx))
outgoing_request = WasiRequest.new(Fields.from_list(headers), rx, _trailers_future(), None)[0]
outgoing_request.set_method(method)
outgoing_request.set_scheme(scheme)
if url_parsed.netloc == '':
if scheme == "http":
authority = ":80"
else:
authority = ":443"
else:
authority = url_parsed.netloc
outgoing_request.set_authority(authority)
path_and_query = url_parsed.path
if url_parsed.query:
path_and_query += '?' + url_parsed.query
outgoing_request.set_path_with_query(path_and_query)
incoming_response = await client.send(outgoing_request)
status = incoming_response.get_status_code()
headers = incoming_response.get_headers().copy_all()
rx, trailers = WasiResponse.consume_body(incoming_response, _unit_future())
body = bytearray()
with rx:
while not rx.writer_dropped:
body += await rx.read(16 * 1024)
return Response(
status,
dict(map(
lambda pair: (pair[0], str(pair[1], "utf-8")),
headers
)),
bytes(body)
)</code></pre>
</details>
<div class="desc"><p>Send an HTTP request and return a response or raise an error</p></div>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="spin_sdk.http.Handler"><code class="flex name class">
<span>class <span class="ident">Handler</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Handler(Base):
"""Simplified handler for incoming HTTP requests using blocking, buffered I/O."""
async def handle_request(self, request: Request) -> Response:
"""Handle an incoming HTTP request and return a response or raise an error"""
raise NotImplementedError
async def handle(self, request: WasiRequest) -> WasiResponse:
method = request.get_method()
if isinstance(method, Method_Get):
method_str = "GET"
elif isinstance(method, Method_Head):
method_str = "HEAD"
elif isinstance(method, Method_Post):
method_str = "POST"
elif isinstance(method, Method_Put):
method_str = "PUT"
elif isinstance(method, Method_Delete):
method_str = "DELETE"
elif isinstance(method, Method_Connect):
method_str = "CONNECT"
elif isinstance(method, Method_Options):
method_str = "OPTIONS"
elif isinstance(method, Method_Trace):
method_str = "TRACE"
elif isinstance(method, Method_Patch):
method_str = "PATCH"
elif isinstance(method, Method_Other):
method_str = method.value
else:
raise AssertionError
headers = request.get_headers().copy_all()
request_uri = request.get_path_with_query()
rx, trailers = WasiRequest.consume_body(request, _unit_future())
body = bytearray()
with rx:
while not rx.writer_dropped:
body += await rx.read(16 * 1024)
if request_uri is None:
uri = "/"
else:
uri = request_uri
try:
simple_response = await self.handle_request(Request(
method_str,
uri,
dict(map(lambda pair: (pair[0], str(pair[1], "utf-8")), headers)),
bytes(body)
))
except:
traceback.print_exc()
response = WasiResponse.new(Fields(), None, _trailers_future())[0]
response.set_status_code(500)
return response
if simple_response.headers.get('content-length') is None:
content_length = len(simple_response.body) if simple_response.body is not None else 0
simple_response.headers['content-length'] = str(content_length)
tx, rx = wit.byte_stream()
componentize_py_async_support.spawn(copy(simple_response.body, tx))
response = WasiResponse.new(Fields.from_list(list(map(
lambda pair: (pair[0], bytes(pair[1], "utf-8")),
simple_response.headers.items()
))), rx, _trailers_future())[0]
response.set_status_code(simple_response.status)
return response</code></pre>
</details>
<div class="desc"><p>Simplified handler for incoming HTTP requests using blocking, buffered I/O.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="spin_sdk.wit.exports.WasiHttpHandler030Rc20260315" href="../wit/exports/index.html#spin_sdk.wit.exports.WasiHttpHandler030Rc20260315">WasiHttpHandler030Rc20260315</a></li>
<li>typing.Protocol</li>
<li>typing.Generic</li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="spin_sdk.http.Handler.handle_request"><code class="name flex">
<span>async def <span class="ident">handle_request</span></span>(<span>self,<br>request: <a title="spin_sdk.http.Request" href="#spin_sdk.http.Request">Request</a>) ‑> <a title="spin_sdk.http.Response" href="#spin_sdk.http.Response">Response</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def handle_request(self, request: Request) -> Response:
"""Handle an incoming HTTP request and return a response or raise an error"""
raise NotImplementedError</code></pre>
</details>
<div class="desc"><p>Handle an incoming HTTP request and return a response or raise an error</p></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="spin_sdk.wit.exports.WasiHttpHandler030Rc20260315" href="../wit/exports/index.html#spin_sdk.wit.exports.WasiHttpHandler030Rc20260315">WasiHttpHandler030Rc20260315</a></b></code>:
<ul class="hlist">
<li><code><a title="spin_sdk.wit.exports.WasiHttpHandler030Rc20260315.handle" href="../wit/exports/index.html#spin_sdk.wit.exports.WasiHttpHandler030Rc20260315.handle">handle</a></code></li>
</ul>
</li>
</ul>
</dd>
<dt id="spin_sdk.http.Request"><code class="flex name class">
<span>class <span class="ident">Request</span></span>
<span>(</span><span>method: str, uri: str, headers: MutableMapping[str, str], body: bytes | None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@dataclass
class Request:
"""An HTTP request"""
method: str
uri: str
headers: MutableMapping[str, str]
body: Optional[bytes]</code></pre>
</details>
<div class="desc"><p>An HTTP request</p></div>
<h3>Instance variables</h3>
<dl>
<dt id="spin_sdk.http.Request.body"><code class="name">var <span class="ident">body</span> : bytes | None</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.Request.headers"><code class="name">var <span class="ident">headers</span> : MutableMapping[str, str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.Request.method"><code class="name">var <span class="ident">method</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.Request.uri"><code class="name">var <span class="ident">uri</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="spin_sdk.http.Response"><code class="flex name class">
<span>class <span class="ident">Response</span></span>
<span>(</span><span>status: int, headers: MutableMapping[str, str], body: bytes | None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@dataclass
class Response:
"""An HTTP response"""
status: int
headers: MutableMapping[str, str]
body: Optional[bytes]</code></pre>
</details>
<div class="desc"><p>An HTTP response</p></div>
<h3>Instance variables</h3>
<dl>
<dt id="spin_sdk.http.Response.body"><code class="name">var <span class="ident">body</span> : bytes | None</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.Response.headers"><code class="name">var <span class="ident">headers</span> : MutableMapping[str, str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="spin_sdk.http.Response.status"><code class="name">var <span class="ident">status</span> : int</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="spin_sdk" href="../index.html">spin_sdk</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="spin_sdk.http.copy" href="#spin_sdk.http.copy">copy</a></code></li>
<li><code><a title="spin_sdk.http.send" href="#spin_sdk.http.send">send</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="spin_sdk.http.Handler" href="#spin_sdk.http.Handler">Handler</a></code></h4>
<ul class="">
<li><code><a title="spin_sdk.http.Handler.handle_request" href="#spin_sdk.http.Handler.handle_request">handle_request</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="spin_sdk.http.Request" href="#spin_sdk.http.Request">Request</a></code></h4>
<ul class="">
<li><code><a title="spin_sdk.http.Request.body" href="#spin_sdk.http.Request.body">body</a></code></li>
<li><code><a title="spin_sdk.http.Request.headers" href="#spin_sdk.http.Request.headers">headers</a></code></li>
<li><code><a title="spin_sdk.http.Request.method" href="#spin_sdk.http.Request.method">method</a></code></li>
<li><code><a title="spin_sdk.http.Request.uri" href="#spin_sdk.http.Request.uri">uri</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="spin_sdk.http.Response" href="#spin_sdk.http.Response">Response</a></code></h4>
<ul class="">
<li><code><a title="spin_sdk.http.Response.body" href="#spin_sdk.http.Response.body">body</a></code></li>
<li><code><a title="spin_sdk.http.Response.headers" href="#spin_sdk.http.Response.headers">headers</a></code></li>
<li><code><a title="spin_sdk.http.Response.status" href="#spin_sdk.http.Response.status">status</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>