-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Move TaskGroup UI & API functions to server-side
#54857
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
Merged
Changes from all commits
Commits
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
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
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,14 @@ | ||
| Remove ``get_task_group_children_getter`` and ``task_group_to_dict`` from task-sdk | ||
|
|
||
| The ``get_task_group_children_getter`` and ``task_group_to_dict`` functions have been removed from the task-sdk (``airflow.sdk.definitions.taskgroup``) and moved to server-side API services. These functions are now internal to Airflow's API layer and should not be imported directly by users. | ||
|
|
||
| * Types of change | ||
|
|
||
| * [ ] Dag changes | ||
| * [ ] Config changes | ||
| * [ ] API changes | ||
| * [ ] CLI changes | ||
| * [ ] Behaviour changes | ||
| * [ ] Plugin changes | ||
| * [ ] Dependency changes | ||
| * [x] Code interface changes |
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
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
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
115 changes: 115 additions & 0 deletions
115
airflow-core/src/airflow/api_fastapi/core_api/services/ui/task_group.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,115 @@ | ||
| # | ||
| # 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. | ||
| """Task group utilities for UI API services.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from collections.abc import Callable | ||
| from functools import cache | ||
| from operator import methodcaller | ||
|
|
||
| from airflow.configuration import conf | ||
| from airflow.models.mappedoperator import MappedOperator | ||
| from airflow.sdk.definitions.taskgroup import MappedTaskGroup | ||
| from airflow.serialization.serialized_objects import SerializedBaseOperator | ||
|
|
||
|
|
||
| @cache | ||
| def get_task_group_children_getter() -> Callable: | ||
| """Get the Task Group Children Getter for the DAG.""" | ||
| sort_order = conf.get("api", "grid_view_sorting_order") | ||
| if sort_order == "topological": | ||
| return methodcaller("topological_sort") | ||
| return methodcaller("hierarchical_alphabetical_sort") | ||
|
|
||
|
|
||
| def task_group_to_dict(task_item_or_group, parent_group_is_mapped=False): | ||
| """Create a nested dict representation of this TaskGroup and its children used to construct the Graph.""" | ||
| if isinstance(task := task_item_or_group, (SerializedBaseOperator, MappedOperator)): | ||
| node_operator = { | ||
| "id": task.task_id, | ||
| "label": task.label, | ||
| "operator": task.operator_name, | ||
| "type": "task", | ||
| } | ||
| if task.is_setup: | ||
| node_operator["setup_teardown_type"] = "setup" | ||
| elif task.is_teardown: | ||
| node_operator["setup_teardown_type"] = "teardown" | ||
| if isinstance(task, MappedOperator) or parent_group_is_mapped: | ||
| node_operator["is_mapped"] = True | ||
| return node_operator | ||
|
|
||
| task_group = task_item_or_group | ||
| is_mapped = isinstance(task_group, MappedTaskGroup) | ||
| children = [ | ||
| task_group_to_dict(child, parent_group_is_mapped=parent_group_is_mapped or is_mapped) | ||
| for child in get_task_group_children_getter()(task_group) | ||
| ] | ||
|
|
||
| if task_group.upstream_group_ids or task_group.upstream_task_ids: | ||
| # This is the join node used to reduce the number of edges between two TaskGroup. | ||
| children.append({"id": task_group.upstream_join_id, "label": "", "type": "join"}) | ||
|
|
||
| if task_group.downstream_group_ids or task_group.downstream_task_ids: | ||
| # This is the join node used to reduce the number of edges between two TaskGroup. | ||
| children.append({"id": task_group.downstream_join_id, "label": "", "type": "join"}) | ||
|
|
||
| return { | ||
| "id": task_group.group_id, | ||
| "label": task_group.label, | ||
| "tooltip": task_group.tooltip, | ||
| "is_mapped": is_mapped, | ||
| "children": children, | ||
| "type": "task", | ||
| } | ||
|
|
||
|
|
||
| def task_group_to_dict_grid(task_item_or_group, parent_group_is_mapped=False): | ||
| """Create a nested dict representation of this TaskGroup and its children used to construct the Grid.""" | ||
| if isinstance(task := task_item_or_group, (MappedOperator, SerializedBaseOperator)): | ||
| is_mapped = None | ||
| if task.is_mapped or parent_group_is_mapped: | ||
| is_mapped = True | ||
| setup_teardown_type = None | ||
| if task.is_setup is True: | ||
| setup_teardown_type = "setup" | ||
| elif task.is_teardown is True: | ||
| setup_teardown_type = "teardown" | ||
| return { | ||
| "id": task.task_id, | ||
| "label": task.label, | ||
| "is_mapped": is_mapped, | ||
| "children": None, | ||
| "setup_teardown_type": setup_teardown_type, | ||
| } | ||
|
|
||
| task_group = task_item_or_group | ||
| task_group_sort = get_task_group_children_getter() | ||
| is_mapped_group = isinstance(task_group, MappedTaskGroup) | ||
| children = [ | ||
| task_group_to_dict_grid(x, parent_group_is_mapped=parent_group_is_mapped or is_mapped_group) | ||
| for x in task_group_sort(task_group) | ||
| ] | ||
|
|
||
| return { | ||
| "id": task_group.group_id, | ||
| "label": task_group.label, | ||
| "is_mapped": is_mapped_group or None, | ||
| "children": children or None, | ||
| } |
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
Oops, something went wrong.
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.