Skip to content

Correct the retry_db_transaction docstring about provide_session #71311

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.

Sign up for GitHub

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

Open
1fanwang wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

Correct the retry_db_transaction docstring about provide_session #71311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion airflow-core/src/airflow/utils/retries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,19 @@ def retry_db_transaction(_func: Callable | None = None, *, retries: int = MAX_DB
"""
Retry functions in case of ``DBAPIError`` from DB.

It should not be used with ``@provide_session``.
The decorated function must take a ``session`` argument, and that session has to be
bound by the time the wrapper runs, because a failed attempt rolls it back before
retrying.

Stack it *inside* ``@provide_session`` so the session exists when the retry wrapper
runs::

@provide_session
@retry_db_transaction
def func(..., *, session: Session = NEW_SESSION): ...

The opposite order raises ``TypeError`` at call time, since no session has been
created yet.
"""

def retry_decorator(func: Callable) -> Callable:
Expand Down