1+ <!doctype html>
2+ < html lang ="en ">
3+ < head >
4+ < meta charset ="utf-8 ">
5+ < meta name ="viewport " content ="width=device-width, initial-scale=1, minimum-scale=1 " />
6+ < meta name ="generator " content ="pdoc 0.10.0 " />
7+ < title > supertokens_python.async_to_sync_wrapper API documentation</ title >
8+ < meta name ="description " content ="Documentation for supertokens_python - SuperTokens Python SDK " />
9+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css " integrity ="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs= " crossorigin >
10+ < link rel ="preload stylesheet " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css " integrity ="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg= " crossorigin >
11+ < link rel ="stylesheet preload " as ="style " href ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css " crossorigin >
12+ < style > : root {--highlight-color : # fe9 }.flex {display : flex !important }body {line-height : 1.5em }# content {padding : 20px }# sidebar {padding : 30px ;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 : 1em 0 .50em 0 }h3 {font-size : 1.4em ;margin : 25px 0 10px 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 .3s ease-in-out}a : hover {color : # e82 }.title code {font-weight : bold}h2 [id ^= "header-" ]{margin-top : 2em }.ident {color : # 900 }pre code {background : # f8f8f8 ;font-size : .8em ;line-height : 1.4em }code {background : # f2f2f1 ;padding : 1px 4px ;overflow-wrap : break-word}h1 code {background : transparent}pre {background : # f8f8f8 ;border : 0 ;border-top : 1px solid # ccc ;border-bottom : 1px solid # ccc ;margin : 1em 0 ;padding : 1ex }# 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-weight : bold;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 .5em ;margin-bottom : 1em }.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+ < 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 }.item .name {font-size : 1em }main {display : flex;flex-direction : row-reverse;justify-content : flex-end}.toc ul ul , # index ul {padding-left : 1.5em }.toc > ul > li {margin-top : .5em }}</ style >
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+ < script defer src ="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js " integrity ="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8= " crossorigin > </ script >
16+ < script > window . addEventListener ( 'DOMContentLoaded' , ( ) => hljs . initHighlighting ( ) ) </ script >
17+ </ head >
18+ < body >
19+ < main >
20+ < article id ="content ">
21+ < header >
22+ < h1 class ="title "> Module < code > supertokens_python.async_to_sync_wrapper</ code > </ h1 >
23+ </ header >
24+ < section id ="section-intro ">
25+ < details class ="source ">
26+ < summary >
27+ < span > Expand source code</ span >
28+ </ summary >
29+ < pre > < code class ="python "> # Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
30+ #
31+ # This software is licensed under the Apache License, Version 2.0 (the
32+ # "License") as published by the Apache Software Foundation.
33+ #
34+ # You may not use this file except in compliance with the License. You may
35+ # obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
36+ #
37+ # Unless required by applicable law or agreed to in writing, software
38+ # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
39+ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
40+ # License for the specific language governing permissions and limitations
41+ # under the License.
42+
43+ import asyncio
44+ from typing import Any, Coroutine, TypeVar
45+ from os import getenv
46+
47+ _T = TypeVar("_T")
48+
49+
50+ def nest_asyncio_enabled():
51+ return getenv("SUPERTOKENS_NEST_ASYNCIO", "") == "1"
52+
53+
54+ def create_or_get_event_loop() -> asyncio.AbstractEventLoop:
55+ try:
56+ return asyncio.get_event_loop()
57+ except Exception as ex:
58+ if "There is no current event loop in thread" in str(ex):
59+ loop = asyncio.new_event_loop()
60+
61+ if nest_asyncio_enabled():
62+ import nest_asyncio # type: ignore
63+
64+ nest_asyncio.apply(loop) # type: ignore
65+
66+ asyncio.set_event_loop(loop)
67+ return loop
68+ raise ex
69+
70+
71+ def sync(co: Coroutine[Any, Any, _T]) -> _T:
72+ loop = create_or_get_event_loop()
73+ return loop.run_until_complete(co)</ code > </ pre >
74+ </ details >
75+ </ section >
76+ < section >
77+ </ section >
78+ < section >
79+ </ section >
80+ < section >
81+ < h2 class ="section-title " id ="header-functions "> Functions</ h2 >
82+ < dl >
83+ < dt id ="supertokens_python.async_to_sync_wrapper.create_or_get_event_loop "> < code class ="name flex ">
84+ < span > def < span class ="ident "> create_or_get_event_loop</ span > </ span > (< span > ) ‑> asyncio.events.AbstractEventLoop</ span >
85+ </ code > </ dt >
86+ < dd >
87+ < div class ="desc "> </ div >
88+ < details class ="source ">
89+ < summary >
90+ < span > Expand source code</ span >
91+ </ summary >
92+ < pre > < code class ="python "> def create_or_get_event_loop() -> asyncio.AbstractEventLoop:
93+ try:
94+ return asyncio.get_event_loop()
95+ except Exception as ex:
96+ if "There is no current event loop in thread" in str(ex):
97+ loop = asyncio.new_event_loop()
98+
99+ if nest_asyncio_enabled():
100+ import nest_asyncio # type: ignore
101+
102+ nest_asyncio.apply(loop) # type: ignore
103+
104+ asyncio.set_event_loop(loop)
105+ return loop
106+ raise ex</ code > </ pre >
107+ </ details >
108+ </ dd >
109+ < dt id ="supertokens_python.async_to_sync_wrapper.nest_asyncio_enabled "> < code class ="name flex ">
110+ < span > def < span class ="ident "> nest_asyncio_enabled</ span > </ span > (< span > )</ span >
111+ </ code > </ dt >
112+ < dd >
113+ < div class ="desc "> </ div >
114+ < details class ="source ">
115+ < summary >
116+ < span > Expand source code</ span >
117+ </ summary >
118+ < pre > < code class ="python "> def nest_asyncio_enabled():
119+ return getenv("SUPERTOKENS_NEST_ASYNCIO", "") == "1"</ code > </ pre >
120+ </ details >
121+ </ dd >
122+ < dt id ="supertokens_python.async_to_sync_wrapper.sync "> < code class ="name flex ">
123+ < span > def < span class ="ident "> sync</ span > </ span > (< span > co: Coroutine[Any, Any, ~_T]) ‑> ~_T</ span >
124+ </ code > </ dt >
125+ < dd >
126+ < div class ="desc "> </ div >
127+ < details class ="source ">
128+ < summary >
129+ < span > Expand source code</ span >
130+ </ summary >
131+ < pre > < code class ="python "> def sync(co: Coroutine[Any, Any, _T]) -> _T:
132+ loop = create_or_get_event_loop()
133+ return loop.run_until_complete(co)</ code > </ pre >
134+ </ details >
135+ </ dd >
136+ </ dl >
137+ </ section >
138+ < section >
139+ </ section >
140+ </ article >
141+ < nav id ="sidebar ">
142+ < h2 > Index</ h2 >
143+ < div class ="toc ">
144+ < ul > </ ul >
145+ </ div >
146+ < ul id ="index ">
147+ < li > < h3 > Super-module</ h3 >
148+ < ul >
149+ < li > < code > < a title ="supertokens_python " href ="index.html "> supertokens_python</ a > </ code > </ li >
150+ </ ul >
151+ </ li >
152+ < li > < h3 > < a href ="#header-functions "> Functions</ a > </ h3 >
153+ < ul class ="">
154+ < li > < code > < a title ="supertokens_python.async_to_sync_wrapper.create_or_get_event_loop " href ="#supertokens_python.async_to_sync_wrapper.create_or_get_event_loop "> create_or_get_event_loop</ a > </ code > </ li >
155+ < li > < code > < a title ="supertokens_python.async_to_sync_wrapper.nest_asyncio_enabled " href ="#supertokens_python.async_to_sync_wrapper.nest_asyncio_enabled "> nest_asyncio_enabled</ a > </ code > </ li >
156+ < li > < code > < a title ="supertokens_python.async_to_sync_wrapper.sync " href ="#supertokens_python.async_to_sync_wrapper.sync "> sync</ a > </ code > </ li >
157+ </ ul >
158+ </ li >
159+ </ ul >
160+ </ nav >
161+ </ main >
162+ < footer id ="footer ">
163+ < p > Generated by < a href ="https://pdoc3.github.io/pdoc " title ="pdoc: Python API documentation generator "> < cite > pdoc</ cite > 0.10.0</ a > .</ p >
164+ </ footer >
165+ </ body >
166+ </ html >
0 commit comments