Skip to content
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.

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

mark dag_run and ti as automatically injected #42103

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ZeeD
Copy link

@ZeeD ZeeD commented Sep 9, 2024

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.

Copy link

boring-cyborg bot commented Sep 9, 2024

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

@potiuk
Copy link
Member

potiuk commented Sep 9, 2024

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

@potiuk potiuk requested a review from uranusjr September 9, 2024 13:42
Copy link

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 github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Oct 26, 2024
@ZeeD
Copy link
Author

ZeeD commented Oct 26, 2024

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

@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Oct 29, 2024
Copy link

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 github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 13, 2024
@ZeeD
Copy link
Author

ZeeD commented Dec 13, 2024

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

@potiuk
Copy link
Member

potiuk commented Dec 13, 2024

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

@potiuk
Copy link
Member

potiuk commented Dec 13, 2024

I rebased the PR BTW

@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 14, 2024
@ashb
Copy link
Member

ashb commented Dec 14, 2024

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)?

@ZeeD
Copy link
Author

ZeeD commented Dec 15, 2024

@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

Copy link

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 github-actions bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Feb 10, 2025
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

This looks good to me, only question is if we want to add all the context variables (since they all are auto injected).

@github-actions github-actions bot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Feb 11, 2025
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.

4 participants