Export AsyncSession from sqlmodel.ext.asyncio module #1749
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AsyncSession was defined in sqlmodel/ext/asyncio/session.py but not exported from the module's __init__.py, requiring users to use the longer import path. Before: from sqlmodel.ext.asyncio.session import AsyncSession After: from sqlmodel.ext.asyncio import AsyncSession This makes the async API more discoverable and consistent with how Session is exported from sqlmodel.orm.
Member
|
I think we should close this PR for now - it will be addressed when we add full async support, async docs and async tests. Sebastian might decide to make the import path even shorter. @veeceey, thanks for your interest and efforts! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added export for
AsyncSessionfrom thesqlmodel.ext.asynciomodule to make it more discoverable and easier to import.Problem
AsyncSessionwas defined insqlmodel/ext/asyncio/session.pybut not exported from the module's__init__.py. This required users to know the exact file path and use a longer import statement.Changes
Added
from .session import AsyncSession as AsyncSessiontosqlmodel/ext/asyncio/__init__.pyBenefits
Before this change:
After this change:
This makes the async API more consistent with how
Sessionis exported fromsqlmodel.orm.Test plan
from sqlmodel.ext.asyncio import AsyncSessionRelated
This follows Python best practices for package structure and makes SQLModel's async support easier to discover for users coming from the documentation.