-
Notifications
You must be signed in to change notification settings - Fork 17.1k
Add tasks clear command to airflowctl #66852
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
Open
kyupark
wants to merge
3
commits into
apache:main
Choose a base branch
from
kyupark:add-tasks-clear-66176
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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,65 @@ | ||
| # 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 datetime | ||
| import sys | ||
|
|
||
| import rich | ||
|
|
||
| from airflowctl.api.client import NEW_API_CLIENT, ClientKind, ServerResponseError, provide_api_client | ||
| from airflowctl.api.datamodels.generated import ClearTaskInstancesBody | ||
| from airflowctl.ctl.console_formatting import AirflowConsole | ||
|
|
||
|
|
||
| @provide_api_client(kind=ClientKind.CLI) | ||
| def clear(args, api_client=NEW_API_CLIENT) -> None: | ||
| """Clear task instances for a Dag.""" | ||
| start_date = _parse_date(args.start_date) if args.start_date else None | ||
| end_date = _parse_date(args.end_date) if args.end_date else None | ||
|
|
||
| body = ClearTaskInstancesBody( | ||
| dry_run=False, | ||
| task_ids=[args.task_id], | ||
| start_date=start_date, | ||
| end_date=end_date, | ||
| ) | ||
|
|
||
| try: | ||
| response = api_client.task_instances.clear(dag_id=args.dag_id, clear_task_instances_body=body) | ||
| except ServerResponseError as e: | ||
| rich.print(f"[red]Error clearing task instances: {e}[/red]") | ||
| sys.exit(1) | ||
|
|
||
| response_list = [ti.model_dump() for ti in (response.task_instances or [])] | ||
| rich.print( | ||
| f"[green]Cleared {len(response_list)} task instance(s) " | ||
| f"for dag {args.dag_id}, task {args.task_id}[/green]" | ||
| ) | ||
| AirflowConsole().print_as(data=response_list, output=args.output) | ||
|
|
||
|
|
||
| def _parse_date(value: str) -> datetime.datetime | None: | ||
| """Parse a date string into a datetime object.""" | ||
| if not value: | ||
| return None | ||
| try: | ||
| return datetime.datetime.fromisoformat(value) | ||
| except ValueError: | ||
| rich.print(f"[red]Invalid date format: {value}. Use ISO format (e.g. 2026-01-01T00:00:00).[/red]") | ||
| sys.exit(1) | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be in operations.py since we can call with single endpoint and we don't need to maintain this much LoC