Skip to content

Fix DAG.cli() crashing on dags pause and unpause - #72109

Open
Eason09053360 wants to merge 2 commits into
apache:mainfrom
Eason09053360:fix-dag-cli-pause-unpause-typeerror
Open

Fix DAG.cli() crashing on dags pause and unpause#72109
Eason09053360 wants to merge 2 commits into
apache:mainfrom
Eason09053360:fix-dag-cli-pause-unpause-typeerror

Conversation

@Eason09053360

@Eason09053360 Eason09053360 commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

DAG.cli() dispatches every subcommand with the Dag object as a second
positional argument, because its parser drops --dag-id. The dags pause
and dags unpause handlers never accepted it, so running a Dag file as a
script raised TypeError: dag_pause() takes 1 positional argument but 2 were given instead of the command.

The regular airflow dags pause --dag-id foo path has always worked, which
is why this went unnoticed — the handlers are only reachable with two
arguments from a Dag file.

Only pause and unpause were affected. DAG_CLI_DICT resolves to exactly
six subcommands — dags list-runs/pause/unpause/test and tasks list/test
and the other four already accepted the Dag argument.

The filter at cli_config.py:2362 also lists backfill and run, but neither
name exists in DAGS_COMMANDS/TASKS_COMMANDS any more, so they match nothing.
Harmless today, and left alone here to keep this diff focused — but it is the
same fragility that hid this bug: two layers wired together by string matching,
with nothing enforcing that the names or the call signatures line up.


Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Opus 5)

Generated-by: Claude Code (Opus 5) following the guidelines

A Dag file run as a script goes through DAG.cli(), whose parser drops
--dag-id and instead dispatches every subcommand with the Dag object as
a second positional argument. The pause and unpause handlers never
accepted it, so Dag authors got a TypeError instead of the command.

The handlers are only reachable this way from a Dag file, which is why
the regular `airflow dags pause` path has always worked and no test
covered the difference.

@ColtenOuO ColtenOuO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

However, once the issue addressed in this PR is resolved, it seems to introduce another problem.

Comment thread airflow-core/src/airflow/cli/commands/dag_command.py
The Dag-scoped parser drops --dag-id but keeps --treat-dag-id-as-regex,
so the flag survives into a context where the user has no pattern left
to supply. The Dag's own id was then read back as a pattern, and dag_ids
may contain dots, so an unanchored match could pause unrelated Dags.

Normalising the flag next to the dag_id it guards covers both of its
readers, including the confirmation prompt, rather than guarding each
reader in turn and leaving the next one to be found later.

@ColtenOuO ColtenOuO left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Looks great!

Let's wait for maintainer take a more look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants