docs: add async-specific note to expire/expire_all proxied docstrings - #13453
Open
harshitayadavv wants to merge 1 commit into
Open
docs: add async-specific note to expire/expire_all proxied docstrings#13453harshitayadavv wants to merge 1 commit into
harshitayadavv wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Follow-up to #13443, adds a .. tip:: note to AsyncSession.expire_all() and AsyncSession.expire()'s generated docstrings, describing the lazy-loading-under-async behavior per @zzzeek's guidance, without naming MissingGreenlet directly.
This required a small addition to tools/generate_proxy_methods.py since the async proxy docstrings are generated from the sync originals, and there wasn't previously a way to inject method-specific extra notes during that generation step. Added an ASYNC_METHOD_NOTES dict keyed by method name, only applied when generating for asyncio modules (scoped_session's sync-to-sync proxying is unaffected).
Ran python tools/generate_proxy_methods.py --module sqlalchemy.ext.asyncio.session locally to confirm the generated diff is clean and minimal.
Checklist
This pull request is: