3
3
< head >
4
4
< meta charset ="utf-8 ">
5
5
< meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 ">
6
- < meta name ="generator " content ="pdoc3 0.11.3 ">
6
+ < meta name ="generator " content ="pdoc3 0.11.5 ">
7
7
< title > slack_bolt.adapter.aiohttp API documentation</ title >
8
8
< meta name ="description " content ="">
9
9
< 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 >
10
10
< link rel ="stylesheet " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css " integrity ="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA== " crossorigin >
11
11
< link rel ="stylesheet " href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css " crossorigin >
12
- < 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}.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 >
12
+ < 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 >
13
13
< 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 >
14
14
< 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 >
15
15
< script defer src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js " integrity ="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ== " crossorigin > </ script >
16
16
< script > window . addEventListener ( 'DOMContentLoaded' , ( ) => {
17
17
hljs . configure ( { languages : [ 'bash' , 'css' , 'diff' , 'graphql' , 'ini' , 'javascript' , 'json' , 'plaintext' , 'python' , 'python-repl' , 'rust' , 'shell' , 'sql' , 'typescript' , 'xml' , 'yaml' ] } ) ;
18
18
hljs . highlightAll ( ) ;
19
+ /* Collapse source docstrings */
20
+ setTimeout ( ( ) => {
21
+ [ ...document . querySelectorAll ( '.hljs.language-python > .hljs-string' ) ]
22
+ . filter ( el => el . innerHTML . length > 200 && [ '"""' , "'''" ] . includes ( el . innerHTML . substring ( 0 , 3 ) ) )
23
+ . forEach ( el => {
24
+ let d = document . createElement ( 'details' ) ;
25
+ d . classList . add ( 'hljs-string' ) ;
26
+ d . innerHTML = '<summary>"""</summary>' + el . innerHTML . substring ( 3 ) ;
27
+ el . replaceWith ( d ) ;
28
+ } ) ;
29
+ } , 100 ) ;
19
30
} ) </ script >
20
31
</ head >
21
32
< body >
@@ -37,12 +48,53 @@ <h2 class="section-title" id="header-functions">Functions</h2>
37
48
< span > async def < span class ="ident "> to_aiohttp_response</ span > </ span > (< span > bolt_resp: < a title ="slack_bolt.response.response.BoltResponse " href ="../../response/response.html#slack_bolt.response.response.BoltResponse "> BoltResponse</ a > ) ‑> aiohttp.web_response.Response</ span >
38
49
</ code > </ dt >
39
50
< dd >
51
+ < details class ="source ">
52
+ < summary >
53
+ < span > Expand source code</ span >
54
+ </ summary >
55
+ < pre > < code class ="python "> async def to_aiohttp_response(bolt_resp: BoltResponse) -> web.Response:
56
+ content_type = bolt_resp.headers.pop(
57
+ "content-type",
58
+ ["application/json" if bolt_resp.body.startswith("{") else "text/plain"],
59
+ )[0]
60
+ content_type = re.sub(r";\s*charset=utf-8", "", content_type)
61
+ resp = web.Response(
62
+ status=bolt_resp.status,
63
+ body=bolt_resp.body,
64
+ headers=bolt_resp.first_headers_without_set_cookie(),
65
+ content_type=content_type,
66
+ )
67
+ for cookie in bolt_resp.cookies():
68
+ for name, c in cookie.items():
69
+ resp.set_cookie(
70
+ name=name,
71
+ value=c.value,
72
+ max_age=c.get("max-age"),
73
+ expires=c.get("expires"),
74
+ path=c.get("path"), # type: ignore[arg-type]
75
+ domain=c.get("domain"),
76
+ secure=True,
77
+ httponly=True,
78
+ )
79
+ return resp</ code > </ pre >
80
+ </ details >
40
81
< div class ="desc "> </ div >
41
82
</ dd >
42
83
< dt id ="slack_bolt.adapter.aiohttp.to_bolt_request "> < code class ="name flex ">
43
84
< span > async def < span class ="ident "> to_bolt_request</ span > </ span > (< span > request: aiohttp.web_request.Request) ‑> < a title ="slack_bolt.request.async_request.AsyncBoltRequest " href ="../../request/async_request.html#slack_bolt.request.async_request.AsyncBoltRequest "> AsyncBoltRequest</ a > </ span >
44
85
</ code > </ dt >
45
86
< dd >
87
+ < details class ="source ">
88
+ < summary >
89
+ < span > Expand source code</ span >
90
+ </ summary >
91
+ < pre > < code class ="python "> async def to_bolt_request(request: web.Request) -> AsyncBoltRequest:
92
+ return AsyncBoltRequest(
93
+ body=await request.text(),
94
+ query=request.query_string,
95
+ headers=request.headers, # type: ignore[arg-type]
96
+ )</ code > </ pre >
97
+ </ details >
46
98
< div class ="desc "> </ div >
47
99
</ dd >
48
100
</ dl >
@@ -70,7 +122,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
70
122
</ nav >
71
123
</ main >
72
124
< footer id ="footer ">
73
- < p > Generated by < a href ="https://pdoc3.github.io/pdoc " title ="pdoc: Python API documentation generator "> < cite > pdoc</ cite > 0.11.3 </ a > .</ p >
125
+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc " title ="pdoc: Python API documentation generator "> < cite > pdoc</ cite > 0.11.5 </ a > .</ p >
74
126
</ footer >
75
127
</ body >
76
128
</ html >
0 commit comments