Skip to content

Restore DagBag include_examples as a deprecated no-op argument - #71323

Open
patil-rushikesh wants to merge 1 commit into
apache:mainfrom
patil-rushikesh:restore-dagbag-include-examples
Open

Restore DagBag include_examples as a deprecated no-op argument#71323
patil-rushikesh wants to merge 1 commit into
apache:mainfrom
patil-rushikesh:restore-dagbag-include-examples

Conversation

@patil-rushikesh

@patil-rushikesh patil-rushikesh commented Aug 8, 2026

Copy link
Copy Markdown

Airflow 3.3.0 removed the include_examples argument from DagBag outright (#66161): the deprecation warning and the removal landed in the same PR, so users got no deprecation cycle across releases, and the removal was not mentioned in the release notes. This broke the common Dag-validation pattern DagBag(dag_folder=..., include_examples=False) with a TypeError on a minor-version upgrade.

This restores include_examples on DagBag.__init__ and DagBag.collect_dags as an accepted, deprecated argument: passing it emits RemovedInAirflow4Warning and is otherwise ignored, since example Dags are now provided exclusively through the per-provider bundles gated by [core] load_examples. (Honoring include_examples=True again would reintroduce the duplicate bundle registration that #66161 fixed; the no-op exactly matches old semantics for the dominant False usage.) The still-unreleased 66161.significant.rst newsfragment now documents the deprecation.

A backport to v3-3-test would unbreak 3.3.x users in 3.3.2.

closes: #70283


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

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

Airflow 3.3.0 removed the argument outright with no deprecation cycle,
so Dag-validation scripts calling DagBag(include_examples=False) began
failing with TypeError on a minor-version upgrade, and the removal was
not mentioned in the release notes. Accept the argument again, warn
with RemovedInAirflow4Warning, and ignore it so existing callers keep
working until Airflow 4; document the behaviour change in the
newsfragment that covers the example-Dags-via-bundles switch.
@boring-cyborg

boring-cyborg Bot commented Aug 8, 2026

Copy link
Copy Markdown

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example Dag that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing include_examples from DagBag

1 participant