Skip to content

Fix DagRun.get_task_instances state type hint to accept a single state#67654

Open
bmaquet wants to merge 5 commits into
apache:mainfrom
bmaquet:fix-type-annotation
Open

Fix DagRun.get_task_instances state type hint to accept a single state#67654
bmaquet wants to merge 5 commits into
apache:mainfrom
bmaquet:fix-type-annotation

Conversation

@bmaquet
Copy link
Copy Markdown

@bmaquet bmaquet commented May 28, 2026

Summary

  • DagRun.get_task_instances and DagRun.fetch_task_instances already accept a single TaskInstanceState at runtime via the isinstance(state, str) branch (Airflow's state enums inherit from str), but the type hint only declares Iterable[TaskInstanceState | None] | None.
  • Widens the annotation to TaskInstanceState | Iterable[TaskInstanceState | None] | None to match existing runtime behavior. No behavior change.
  • Adds unit test in test_dagrun.py to validate get_task_instances accepts either an iterable or a single instance of TaskInstanceState

Test Plan

  • prek run mypy-airflow-core --files airflow-core/src/airflow/models/dagrun.py
  • uv run --project airflow-core pytest airflow-core/tests/unit/models/test_dagrun.py -xvs

closes: #67653

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)
    claude

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@bmaquet bmaquet requested review from XD-DENG and ashb as code owners May 28, 2026 16:25
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented May 28, 2026

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

Copy link
Copy Markdown
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

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

Looks reasonable as the logic was handling. As it is an interface/public API change would like to have another pair of eyes on this but see no harm in merging.

@bmaquet
Copy link
Copy Markdown
Author

bmaquet commented Jun 3, 2026

It seems another PR to fix this issue was created after mine (#67880) and was merged before this one. I believe we can close this one then.

@potiuk potiuk added the ready for maintainer review Set after triaging when all criteria pass. label Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready for maintainer review Set after triaging when all criteria pass.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DagRun.get_task_instances / fetch_task_instances accept a single TaskInstanceState at runtime, but the type hint only allows an Iterable

3 participants