airflow icon indicating copy to clipboard operation
airflow copied to clipboard

mark dag_run and ti as automatically injected

Open ZeeD opened this issue 1 year ago • 10 comments

Allow the usage of the mypy plugins to typecheck the @task annotated tasks. With this change it will be possible to avoid mypy complains when definiing a task like in https://airflow.apache.org/docs/apache-airflow/stable/tutorial/taskflow.html#accessing-context-variables-in-decorated-tasks with ti as an automatically injected parameter.


^ Add meaningful description above Read the Pull Request Guidelines for more information. In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed. In case of a new dependency, check compliance with the ASF 3rd Party License Policy. In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

ZeeD avatar Sep 09 '24 13:09 ZeeD

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 (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst) Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits 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: [email protected] Slack: https://s.apache.org/airflow-slack

boring-cyborg[bot] avatar Sep 09 '24 13:09 boring-cyborg[bot]

cc: @uranusjr - as our MyPy / Typing expert - what do you think? That looks cool.

potiuk avatar Sep 09 '24 13:09 potiuk

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Oct 26 '24 00:10 github-actions[bot]

Ho @potiuk @uranusjr Do You think this PR would be helpful?

ZeeD avatar Oct 26 '24 05:10 ZeeD

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Dec 13 '24 00:12 github-actions[bot]

Yet again... @potiuk @uranusjr Do You think this PR would be helpful?

ZeeD avatar Dec 13 '24 03:12 ZeeD

@uranusjr -> WDYT? I think there were some plans for those MyPy checks but I know no details

potiuk avatar Dec 13 '24 11:12 potiuk

I rebased the PR BTW

potiuk avatar Dec 13 '24 11:12 potiuk

Does this mypy plug-in get used outside of the airflow repo?

Can you give an example of where this change helps mypy (I assume to not error in some cases)?

ashb avatar Dec 14 '24 08:12 ashb

@ashb I use a copy of this plugin in my project, to help me during the dag authoring.

In my case I relies on taskflow definition and I have a bunch of @task annotated functions, and I want to typecheck the task connections. A dummy example would be something like


@task
def retrieve_url(dag_run: DagRun) -> str:
    """something that uses dag_run.conf"""
    return dag_run.conf['url']

@task
def print_content(url: str) -> None:
    """something that uses url from xcom"""
    print(request.get(url))

@dag
def my_dag() -> DAG:
   url = retrieve_url() # dag_run is not passed
   print_content(url) # url is passed

my_dag()

without the plugin I would have had errors in the dag definition or rely on **context in the task witch is clumsy to use

ZeeD avatar Dec 15 '24 09:12 ZeeD

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Feb 10 '25 00:02 github-actions[bot]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Mar 28 '25 00:03 github-actions[bot]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar May 18 '25 00:05 github-actions[bot]