Skip to content

CLI: Exclude example dags when a bundle is passed #50401

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.

Sign up for GitHub

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 1 commit into from
May 9, 2025
Merged

CLI: Exclude example dags when a bundle is passed #50401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airflow-core/src/airflow/utils/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ def get_dag(bundle_names: list | None, dag_id: str, from_db: bool = False) -> DA
manager = DagBundlesManager()
for bundle_name in bundle_names:
bundle = manager.get_bundle(bundle_name)
dagbag = DagBag(dag_folder=bundle.path, bundle_path=bundle.path)
dagbag = DagBag(dag_folder=bundle.path, bundle_path=bundle.path, include_examples=False)
dag = dagbag.dags.get(dag_id)
if dag:
break
Expand Down
14 changes: 14 additions & 0 deletions airflow-core/tests/unit/cli/commands/test_dag_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,20 @@ def test_dag_test_with_mark_success(self, mock__execute_task):
assert len(mock__execute_task.call_args_list) == 1
assert mock__execute_task.call_args_list[0].kwargs["ti"].task_id == "dummy_operator"

@conf_vars({("core", "load_examples"): "false"})
def test_get_dag_excludes_examples_with_bundle(self, configure_testing_dag_bundle):
"""Test that example DAGs are excluded when bundle names are passed."""
from airflow.utils.cli import get_dag

with configure_testing_dag_bundle(TEST_DAGS_FOLDER / "test_sensor.py"):
# example DAG should not be found since include_examples=False
with pytest.raises(AirflowException, match="could not be found"):
get_dag(bundle_names=["testing"], dag_id="example_simplest_dag")

# However, "test_sensor.py" should exist
dag = get_dag(bundle_names=["testing"], dag_id="test_sensor")
assert dag.dag_id == "test_sensor"


class TestCliDagsReserialize:
parser = cli_parser.get_parser()
Expand Down