-
Notifications
You must be signed in to change notification settings - Fork 17.4k
Added get_async_hook in common.compat provider #69208
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
Merged
dabla
merged 4 commits into
apache:main
from
dabla:feature/add_get_async_hook_common_compat
Jul 6, 2026
+116
−0
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8c39b46
refactor: Added get_async_hook in common.compat provider
dabla 8edf056
refactor: Fixed docstring and logging statements
1615118
refactor: Refactored TestGetAsyncHook
e792f07
Update providers/common/compat/src/airflow/providers/common/compat/ho…
dabla File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
46 changes: 46 additions & 0 deletions
46
providers/common/compat/src/airflow/providers/common/compat/hook/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
|
|
||
| from airflow.providers.common.compat.sdk import BaseHook | ||
|
|
||
| log = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| async def get_async_hook(conn_id: str, hook_params: dict | None = None) -> BaseHook: | ||
| """ | ||
| Get an asynchronous Airflow connection that is backwards compatible. | ||
|
dabla marked this conversation as resolved.
Outdated
|
||
|
|
||
| :param conn_id: The provided connection ID. | ||
| :param hook_params: Additional hook params. | ||
| :returns: BaseHook | ||
| """ | ||
| from asgiref.sync import sync_to_async | ||
|
|
||
| if hasattr(BaseHook, "aget_hook"): | ||
| log.debug("Get hook using `BaseHook.aget_hook()`.") | ||
| return await BaseHook.aget_hook(conn_id=conn_id, hook_params=hook_params) | ||
| log.debug("Get hook using `BaseHook.get_hook()`.") | ||
| return await sync_to_async(BaseHook.get_hook)(conn_id=conn_id, hook_params=hook_params) | ||
|
|
||
|
|
||
| __all__ = [ | ||
| "get_async_hook", | ||
| ] | ||
16 changes: 16 additions & 0 deletions
16
providers/common/compat/tests/unit/common/compat/hook/__init__.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. |
54 changes: 54 additions & 0 deletions
54
providers/common/compat/tests/unit/common/compat/hook/test_hook.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| from __future__ import annotations | ||
|
|
||
| from unittest import mock | ||
|
|
||
| import pytest | ||
|
|
||
| from airflow.providers.common.compat.hook import get_async_hook | ||
| from airflow.providers.common.compat.sdk import BaseHook | ||
|
|
||
| _MOCK_HOOK = mock.MagicMock(spec=BaseHook) | ||
|
|
||
|
|
||
| class MockAgetBaseHook: | ||
| def __init__(self, *args, **kwargs): | ||
| self.aget_hook = mock.AsyncMock(return_value=_MOCK_HOOK) | ||
|
|
||
|
|
||
| class MockBaseHook: | ||
| def __init__(self, *args, **kwargs): | ||
| self.get_hook = mock.MagicMock(return_value=_MOCK_HOOK) | ||
|
|
||
|
|
||
| class TestGetAsyncHook: | ||
| @pytest.mark.parametrize("hook_params", [None, {"key": "value"}]) | ||
| @mock.patch("airflow.providers.common.compat.hook.BaseHook", new_callable=MockAgetBaseHook) | ||
| @pytest.mark.asyncio | ||
| async def test_get_async_hook_uses_aget_hook_when_available(self, mock_hook_class, hook_params): | ||
| result = await get_async_hook("test_conn", hook_params=hook_params) | ||
| assert result is _MOCK_HOOK | ||
| mock_hook_class.aget_hook.assert_called_once_with(conn_id="test_conn", hook_params=hook_params) | ||
|
|
||
| @pytest.mark.parametrize("hook_params", [None, {"key": "value"}]) | ||
| @mock.patch("airflow.providers.common.compat.hook.BaseHook", new_callable=MockBaseHook) | ||
| @pytest.mark.asyncio | ||
| async def test_get_async_hook_falls_back_to_get_hook(self, mock_hook_class, hook_params): | ||
| result = await get_async_hook("test_conn", hook_params=hook_params) | ||
| assert result is _MOCK_HOOK | ||
| mock_hook_class.get_hook.assert_called_once_with(conn_id="test_conn", hook_params=hook_params) |
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.
Uh oh!
There was an error while loading. Please reload this page.