Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Use nest-asyncio when configured with env var #451

Merged
merged 4 commits into from
Sep 21, 2023

Conversation

KShivendu
Copy link
Contributor

Summary of change

Use nest-asyncio when configured with env var

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py
  • Make sure that syncio / asyncio functions are consistent.
  • If access token structure has changed
    • Modified test in tests/sessions/test_access_token_version.py to account for any new claims that are optional or omitted by the core

CHANGELOG.md Show resolved Hide resolved
try:
asyncio.get_event_loop()
except RuntimeError as ex:
import nest_asyncio as _ # type: ignore
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this import here?

supertokens_python/async_to_sync_wrapper.py Show resolved Hide resolved
except Exception:
return False


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sure that there is at least one thing in cicd where we run the python sdk (for example in e2e test with flask), where nest_asyncio is not a dependency and then we make sure it all works

Comment on lines 807 to 827
def test_nest_asyncio_import():
from supertokens_python.async_to_sync_wrapper import nest_asyncio_enabled, sync
from os import getenv

circleci = getenv("CIRCLECI", "false") == "true"

if not circleci:
return

# Has to be circleci
if nest_asyncio_enabled():
# nest-asyncio should be installed
sync(asyncio.sleep(0.1))
else:
# nest-asyncio shouldn't be installed and sync() should throw error
try:
sync(asyncio.sleep(0.1))
assert False, "Shouldn't come here"
except ModuleNotFoundError:
# should be missing
assert True
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@rishabhpoddar rishabhpoddar merged commit 2a5df36 into 0.16 Sep 21, 2023
@rishabhpoddar rishabhpoddar deleted the nest-asyncio-config branch September 21, 2023 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants