Skip to content

Add TypedDict type hints for AirflowPlugin list fields#69761

Draft
sivavarma-x wants to merge 1 commit into
apache:mainfrom
sivavarma-x:wip/issue#62222
Draft

Add TypedDict type hints for AirflowPlugin list fields#69761
sivavarma-x wants to merge 1 commit into
apache:mainfrom
sivavarma-x:wip/issue#62222

Conversation

@sivavarma-x

Copy link
Copy Markdown

Most AirflowPlugin list fields (external_views, react_apps, menu_links, appbuilder_views, fastapi_apps, ...) are currently typed as list[Any], giving plugin authors no static signal about the shape of the entries they're expected to supply.
This PR introduces TypedDicts in the shared plugins_manager that capture those contracts and swaps the
list[Any] annotations on AirflowPlugin over to them.

Rolling in one field per commit so each contract can be reviewed on its own.
First up: ExternalViewDict for external_views. Follow-ups for the remaining fields will land in subsequent commits on this PR.

Opening as draft while the rest lands.


Was generative AI tooling used to co-author this PR?
  • Yes

Generated-by: gpt-5.5 following the guidelines

@boring-cyborg

boring-cyborg Bot commented Jul 11, 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.

More thorough type hinting for AirflowPlugin attributes

1 participant