dabla opened a new pull request, #72329:
URL: https://github.com/apache/airflow/pull/72329
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
https://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the
documentation.
For user-facing UI changes, please attach before/after screenshots (or a
short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
Add async Variable methods (`aget`, `aset`, `adelete`, `akeys`) with tests
This PR adds async counterparts to all synchronous `Variable` methods and
fixes
a bug in the `akeys` implementation.
### What changed
#### `Variable` class (`task-sdk/src/airflow/sdk/definitions/variable.py`)
Four async class-methods are now fully functional:
| Async method | Sync equivalent | Notes |
|---|---|---|
| `Variable.aget` | `Variable.get` | Awaits `_async_get_variable`; falls
back to `default` on `VARIABLE_NOT_FOUND` |
| `Variable.aset` | `Variable.set` | Awaits `_async_set_variable`; checks
secrets backends for write conflicts |
| `Variable.adelete` | `Variable.delete` | Awaits `_async_delete_variable`;
invalidates the secret cache |
| `Variable.akeys` | `Variable.keys` | Awaits `_async_get_variable_keys`
eagerly (see bug fix below) |
#### Bug fix — `Variable.akeys`
The previous implementation tried to use `lazy_object_proxy.Proxy` with a
`lambda`
that contained `await`:
```python
# broken — await is not valid inside a plain lambda
return lazy_object_proxy.Proxy(lambda: await
_async_get_variable_keys(prefix=prefix))
```
`lazy_object_proxy.Proxy` is a synchronous construct; its factory is a
regular
callable and cannot be a coroutine. `Variable.akeys` is an `async def`, so
the
fix is to simply `await` the result directly:
```python
return await _async_get_variable_keys(prefix=prefix)
```
Unlike `Variable.keys` (which is lazy via the proxy), `Variable.akeys`
returns a
fully resolved `list[str]` eagerly — the docstring was updated accordingly.
#### Context helpers (`task-sdk/src/airflow/sdk/execution_time/context.py`)
The four underlying `_async_*` functions were already implemented:
- `_async_get_variable` — checks `SecretCache`, iterates backends via
`asyncio.to_thread`, falls through to the Execution API via `asend`.
- `_async_set_variable` — warns on backend write conflicts via
`asyncio.to_thread`, sends `PutVariable` via `asend`, invalidates cache.
- `_async_delete_variable` — sends `DeleteVariable` via `asend`, invalidates
cache.
- `_async_get_variable_keys` — paginates `GetVariableKeys` requests via
`asend`.
### Tests
#### `test_variables.py`
Added `TestAsyncVariables` and `TestAsyncVariableKeys` mirroring all existing
sync test cases:
- `test_avar_get` — simple and JSON-deserialized values
- `test_avar_set` — plain and JSON-serialized values; verifies `PutVariable`
payload
- `test_avar_delete` — verifies `DeleteVariable` is sent via `asend`
- `test_akeys` — prefix filtering (all / with prefix / empty)
- `test_akeys_paginates_when_results_exceed_page_size`
- `test_akeys_raises_on_error_response`
- `test_akeys_raises_on_unexpected_response_type`
#### `test_context.py`
Added `TestAsyncVariableContext` with direct unit tests for the four context
helpers
(previously untested):
- `_async_get_variable`: from API, from secrets backend, not-found raises
- `_async_set_variable`: simple value, JSON-serialized value
- `_async_delete_variable`: sends `DeleteVariable`
- `_async_get_variable_keys`: prefix filtering, pagination, error,
unexpected response
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ x ] Yes (please specify the tool below)
GitHub Copilot (Claude Sonnet 4.6)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
